Save This Page
Home » openjdk-7 » java » security » [javadoc | source]
java.security
abstract public static class: KeyStore.Builder [javadoc | source]
java.lang.Object
   java.security.KeyStore$Builder

Direct Known Subclasses:
    FileBuilder

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 {@linkplain #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.

Field Summary
static final  int MAX_CALLBACK_TRIES     
Constructor:
 protected Builder() 
Method from java.security.KeyStore$Builder Summary:
getKeyStore,   getProtectionParameter,   newInstance,   newInstance,   newInstance
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.security.KeyStore$Builder Detail:
 abstract public KeyStore getKeyStore() throws KeyStoreException
    Returns the KeyStore described by this object.
 abstract public ProtectionParameter getProtectionParameter(String alias) throws KeyStoreException
    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.
 public static Builder newInstance(KeyStore keyStore,
    ProtectionParameter protectionParameter) 
    Returns a new Builder that encapsulates the given KeyStore. The {@linkplain #getKeyStore} method of the returned object will return keyStore, the {@linkplain #getProtectionParameter getProtectionParameter()} method will return protectionParameters.

    This is useful if an existing KeyStore object needs to be used with Builder-based APIs.

 public static Builder newInstance(String type,
    Provider provider,
    ProtectionParameter protection) 
    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.

 public static Builder newInstance(String type,
    Provider provider,
    File file,
    ProtectionParameter protection) 
    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.