to top
Android APIs
public static abstract class

KeyStore.Builder

extends Object
java.lang.Object
   ↳ java.security.KeyStore.Builder

Class Overview

Builder is used to construct new instances of KeyStore.

Summary

Protected Constructors
KeyStore.Builder()
Constructs a new instance of Builder.
Public Methods
abstract KeyStore getKeyStore()
Returns the KeyStore created by this Builder.
abstract KeyStore.ProtectionParameter getProtectionParameter( String alias)
Returns the ProtectionParameter to be used when a Entry with the specified alias is requested.
static KeyStore.Builder newInstance( KeyStore keyStore, KeyStore.ProtectionParameter protectionParameter)
Returns a new Builder that holds the given KeyStore and the given ProtectionParameter.
static KeyStore.Builder newInstance( String type, Provider provider, KeyStore.ProtectionParameter protectionParameter)
Returns a new Builder that creates a new KeyStore based on the provided arguments.
static KeyStore.Builder newInstance( String type, Provider provider, File file, KeyStore.ProtectionParameter protectionParameter)
Returns a new Builder that creates a new KeyStore based on the provided arguments.
[Expand]
Inherited Methods
From class java.lang.Object

Protected Constructors

protected KeyStore.Builder ()

Added in API level 1

Constructs a new instance of Builder.

Public Methods

public abstract KeyStore getKeyStore ()

Added in API level 1

Returns the KeyStore created by this Builder.

Returns
  • the KeyStore created by this Builder.
Throws
KeyStoreException if an error occurred during construction.

public abstract KeyStore.ProtectionParameter getProtectionParameter (String alias)

Added in API level 1

Returns the ProtectionParameter to be used when a Entry with the specified alias is requested. Before this method is invoked, getKeyStore() must be called.

Parameters
alias the alias for the entry.
Returns
  • the ProtectionParameter to be used when a Entry with the specified alias is requested.
Throws
KeyStoreException if an error occurred during the lookup for the protection parameter.
IllegalStateException if getKeyStore() is not called prior the invocation of this method.
NullPointerException if alias is null.

public static KeyStore.Builder newInstance (KeyStore keyStore, KeyStore.ProtectionParameter protectionParameter)

Added in API level 1

Returns a new Builder that holds the given KeyStore and the given ProtectionParameter.

Parameters
keyStore the KeyStore to be held.
protectionParameter the ProtectionParameter to be held.
Returns
  • a new instance of Builder that holds the specified KeyStore and the specified ProtectionParameter.
Throws
NullPointerException if keyStore or protectionParameter is null.
IllegalArgumentException if the given KeyStore is not initialized.

public static KeyStore.Builder newInstance (String type, Provider provider, KeyStore.ProtectionParameter protectionParameter)

Added in API level 1

Returns a new Builder that creates a new KeyStore based on the provided arguments.

If provider is null, all installed providers are searched, otherwise the key store from the specified provider is used.

Parameters
type the type of the KeyStore to be constructed.
provider the provider of the KeyStore to be constructed, maybe null.
protectionParameter the ProtectionParameter used to protect the stored keys.
Returns
  • a new Builder that creates a new KeyStore based on the provided arguments.
Throws
NullPointerException if type or protectionParameter is null.
IllegalArgumentException protectionParameter not an instance of either PasswordProtection or CallbackHandlerProtection, file is not a file or does not exist at all.

public static KeyStore.Builder newInstance (String type, Provider provider, File file, KeyStore.ProtectionParameter protectionParameter)

Added in API level 1

Returns a new Builder that creates a new KeyStore based on the provided arguments.

If provider is null, all installed providers are searched, otherwise the key store from the specified provider is used.

Parameters
type the type of the KeyStore to be constructed.
provider the provider of the KeyStore to be constructed, maybe null.
file the File that contains the data for the KeyStore.
protectionParameter the ProtectionParameter used to protect the stored keys.
Returns
  • a new Builder that creates a new KeyStore based on the provided arguments.
Throws
NullPointerException if type, protectionParameter or file is null.
IllegalArgumentException protectionParameter not an instance of either PasswordProtection or CallbackHandlerProtection, file is not a file or does not exist at all.
No examples for this method.
Frequently called with: [Clear]
Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.