public abstract static class java.security
KeyStore.Builder


Show All Login
Java SE 6
  
Contained within: KeyStore
Details
A description of a to-be-instantiated KeyStore object.

An instance of this class encapsulates the information needed to instantiate and initialize a KeyStore object. That process is triggered when the #getKeyStore method is called.

This makes it possible to decouple configuration from KeyStore object creation and e.g. delay a password prompt until it is needed.
since1.5
See also java.security.KeyStore, javax.net.ssl.KeyStoreBuilderParameters


Constructors
protected KeyStore.Builder()
Construct a new Builder.

Methods
public static KeyStore.Builder newInstance(KeyStore keyStore, KeyStore.ProtectionParameter protectionParameter) Details
Returns a new Builder that encapsulates the given KeyStore. The #getKeyStore method of the returned object will return keyStore, the getProtectionParameter() method will return protectionParameters.

This is useful if an existing KeyStore object needs to be used with Builder-based APIs.
returna new Builder object
keyStorethe KeyStore to be encapsulated
protectionParameterthe ProtectionParameter used to protect the KeyStore entries
ThrowsNullPointerException: if keyStore or protectionParameters is null
ThrowsIllegalArgumentException: if the keyStore has not been initialized

public static KeyStore.Builder newInstance(String type, Provider provider, File file, KeyStore.ProtectionParameter protection) Details
Returns a new Builder object.

The first call to the #getKeyStore method on the returned builder will create a KeyStore of type type and call its load() method. The inputStream argument is constructed from file. If protection is a PasswordProtection, the password is obtained by calling the getPassword method. Otherwise, if protection is a CallbackHandlerProtection, the password is obtained by invoking the CallbackHandler.

Subsequent calls to #getKeyStore return the same object as the initial call. If the initial call to failed with a KeyStoreException, subsequent calls also throw a KeyStoreException.

The KeyStore is instantiated from provider if non-null. Otherwise, all installed providers are searched.

Calls to getProtectionParameter() will return a PasswordProtection object encapsulating the password that was used to invoke the load method.

Note that the #getKeyStore method is executed within the AccessControlContext of the code invoking this method.
returna new Builder object
typethe type of KeyStore to be constructed
providerthe provider from which the KeyStore is to be instantiated (or null)
filethe File that contains the KeyStore data
protectionthe ProtectionParameter securing the KeyStore data
ThrowsNullPointerException: if type, file or protection is null
ThrowsIllegalArgumentException: if protection is not an instance of either PasswordProtection or CallbackHandlerProtection; or if file does not exist or does not refer to a normal file

public static KeyStore.Builder newInstance(String type, Provider provider, KeyStore.ProtectionParameter protection) Details
Returns a new Builder object.

Each call to the #getKeyStore method on the returned builder will return a new KeyStore object of type type. Its load() method is invoked using a LoadStoreParameter that encapsulates protection.

The KeyStore is instantiated from provider if non-null. Otherwise, all installed providers are searched.

Calls to getProtectionParameter() will return protection.

Note that the #getKeyStore method is executed within the AccessControlContext of the code invoking this method.
returna new Builder object
typethe type of KeyStore to be constructed
providerthe provider from which the KeyStore is to be instantiated (or null)
protectionthe ProtectionParameter securing the Keystore
ThrowsNullPointerException: if type or protection is null


Properties
abstract public KeyStore getKeyStore() throws KeyStoreException Details
Returns the KeyStore described by this object.
ThrowsKeyStoreException: if an error occured during the operation, for example if the KeyStore could not be instantiated or loaded
abstract public KeyStore.ProtectionParameter getProtectionParameter(String alias) throws KeyStoreException Details
Returns the ProtectionParameters that should be used to obtain the Entry with the given alias. The getKeyStore method must be invoked before this method may be called.
returnthe ProtectionParameters that should be used to obtain the Entry with the given alias.
aliasthe alias of the KeyStore entry
ThrowsNullPointerException: if alias is null
ThrowsKeyStoreException: if an error occured during the operation
ThrowsIllegalStateException: if the getKeyStore method has not been invoked prior to calling this method