程序包 java.security

类 KeyStore.Builder

java.lang.Object

java.security.KeyStore.Builder

封闭类:

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 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.

从以下版本开始:

1.5

另请参阅:

KeyStore, KeyStoreBuilderParameters

构造器概要

构造器

限定符	构造器	说明
protected	Builder()	Construct a new Builder.

方法概要

限定符和类型	方法	说明
abstract KeyStore	getKeyStore()	Returns the KeyStore described by this object.
abstract KeyStore.ProtectionParameter	getProtectionParameter(String alias)	Returns the ProtectionParameters that should be used to obtain the KeyStore.Entry with the given alias.
static KeyStore.Builder	newInstance(String type, Provider provider, File file, KeyStore.ProtectionParameter protection)	Returns a new Builder object.
static KeyStore.Builder	newInstance(String type, Provider provider, KeyStore.ProtectionParameter protection)	Returns a new Builder object.
static KeyStore.Builder	newInstance(KeyStore keyStore, KeyStore.ProtectionParameter protectionParameter)	Returns a new Builder that encapsulates the given KeyStore.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

Builder

protected Builder()

Construct a new Builder.

方法详细资料

getKeyStore

public abstract KeyStore getKeyStore()
                              throws KeyStoreException

Returns the KeyStore described by this object.

返回:

the KeyStore described by this object

抛出:

KeyStoreException - if an error occurred 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 KeyStore.Entry with the given alias. The getKeyStore method must be invoked before this method may be called.

参数:

alias - the alias of the KeyStore entry

返回:

the ProtectionParameters that should be used to obtain the KeyStore.Entry with the given alias.

抛出:

NullPointerException - if alias is null

KeyStoreException - if an error occurred during the operation

IllegalStateException - if the getKeyStore method has not been invoked prior to calling this method

newInstance

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

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.

参数:

keyStore - the KeyStore to be encapsulated

protectionParameter - the ProtectionParameter used to protect the KeyStore entries

返回:

a new Builder object

抛出:

NullPointerException - if keyStore or protectionParameters is null

IllegalArgumentException - if the keyStore has not been initialized

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 getKeyStore() method on the returned builder will create a KeyStore of type type and call its KeyStore#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 KeyStore.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.

参数:

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

返回:

a new Builder object

抛出:

NullPointerException - if type, file or protection is null

IllegalArgumentException - 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

newInstance

public static KeyStore.Builder newInstance(String type,
                                           Provider provider,
                                           KeyStore.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 KeyStore#load(KeyStore.LoadStoreParameter) 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.

参数:

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

返回:

a new Builder object

抛出:

NullPointerException - if type or protection is null