This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.security
class KeyStore.Builder

java.lang.Object extended by java.security.KeyStore.Builder
Enclosing class:
KeyStore

public abstract static class KeyStore.Builder
extends Object

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.


Constructor Summary
protected

          Construct a new Builder.
 
Method Summary
abstract KeyStore

          Returns the KeyStore described by this object.
abstract KeyStore.ProtectionParameter

          Returns the ProtectionParameters that should be used to obtain the java.security.KeyStore.Entry with the given alias.
static KeyStore.Builder
newInstance(KeyStore keyStore, KeyStore.ProtectionParameter protectionParameter)

          Returns a new Builder that encapsulates the given KeyStore.
static KeyStore.Builder
newInstance(String type, Provider provider, File file, KeyStore.ProtectionParameter protection)

          Returns a new Builder object.
static KeyStore.Builder

          Returns a new Builder object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

KeyStore.Builder

protected KeyStore.Builder()
Construct a new Builder.

Method Detail

getKeyStore

public abstract KeyStore getKeyStore()
                              throws KeyStoreException
Returns the KeyStore described by this object.

Throws:
KeyStoreException - if an error occured during the operation, for example if the KeyStore could not be instantiated or loaded

getProtectionParameter

public abstract KeyStore.ProtectionParameter getProtectionParameter(String alias)
                                                             throws KeyStoreException
Returns the ProtectionParameters that should be used to obtain the {@link KeyStore.Entry Entry} with the given alias. The getKeyStore method must be invoked before this method may be called.

Parameters:
alias - the alias of the KeyStore entry
Returns:
the ProtectionParameters that should be used to obtain the {@link KeyStore.Entry Entry} with the given alias.
Throws:
KeyStoreException - if an error occured during the operation

newInstance

public static KeyStore.Builder newInstance(KeyStore 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.

Parameters:
keyStore - the KeyStore to be encapsulated
protectionParameter - the ProtectionParameter used to protect the KeyStore entries
Returns:
a new Builder object

newInstance

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

The first call to the {@link #getKeyStore} method on the returned builder will create a KeyStore of type type and call its {@link KeyStore#load 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 {@link #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 {@link #getProtectionParameter getProtectionParameter()} will return a {@link KeyStore.PasswordProtection PasswordProtection} object encapsulating the password that was used to invoke the load method.

Note that the {@link #getKeyStore} method is executed within the {@link AccessControlContext} of the code invoking this method.

Parameters:
type - the type of KeyStore to be constructed
provider - the provider from which the KeyStore is to be instantiated (or null)
file - the File that contains the KeyStore data
protection - the ProtectionParameter securing the KeyStore data
Returns:
a new Builder object

newInstance

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

Each call to the {@link #getKeyStore} method on the returned builder will return a new KeyStore object of type type. Its {@link KeyStore#load(KeyStore.LoadStoreParameter) 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 {@link #getProtectionParameter getProtectionParameter()} will return protection.

Note that the {@link #getKeyStore} method is executed within the {@link AccessControlContext} of the code invoking this method.

Parameters:
type - the type of KeyStore to be constructed
provider - the provider from which the KeyStore is to be instantiated (or null)
protection - the ProtectionParameter securing the Keystore
Returns:
a new Builder object


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.