public abstract static class KeyStore.Builder extends 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.
KeyStore
,
KeyStoreBuilderParameters
Modifier | Constructor and Description |
---|---|
protected |
Builder()
Construct a new Builder.
|
Modifier and Type | Method and Description |
---|---|
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
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 |
newInstance(String type,
Provider provider,
KeyStore.ProtectionParameter protection)
Returns a new Builder object.
|
public abstract KeyStore getKeyStore() throws KeyStoreException
KeyStoreException
- if an error occurred during the
operation, for example if the KeyStore could not be
instantiated or loadedKeyStore
described by this objectpublic abstract KeyStore.ProtectionParameter getProtectionParameter(String alias) throws KeyStoreException
Entry
with the given alias.
The getKeyStore
method must be invoked before this
method may be called.NullPointerException
- if alias is nullKeyStoreException
- if an error occurred during the
operationIllegalStateException
- if the getKeyStore method has
not been invoked prior to calling this methodalias
- the alias of the KeyStore entryEntry
with the given alias.public static KeyStore.Builder newInstance(KeyStore keyStore, KeyStore.ProtectionParameter protectionParameter)
keyStore
, the getProtectionParameter() method will
return protectionParameters
.
This is useful if an existing KeyStore object needs to be used with Builder-based APIs.
NullPointerException
- if keyStore or
protectionParameters is nullIllegalArgumentException
- if the keyStore has not been
initializedkeyStore
- the KeyStore to be encapsulatedprotectionParameter
- the ProtectionParameter used to
protect the KeyStore entriespublic static KeyStore.Builder newInstance(String type, Provider provider, File file, KeyStore.ProtectionParameter protection)
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.
NullPointerException
- if type, file or protection is nullIllegalArgumentException
- if protection is not an instance
of either PasswordProtection or CallbackHandlerProtection; or
if file does not exist or does not refer to a normal filetype
- the type of KeyStore to be constructedprovider
- the provider from which the KeyStore is to
be instantiated (or null)file
- the File that contains the KeyStore dataprotection
- the ProtectionParameter securing the KeyStore datapublic static KeyStore.Builder newInstance(String type, Provider provider, KeyStore.ProtectionParameter protection)
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.
NullPointerException
- if type or protection is nulltype
- the type of KeyStore to be constructedprovider
- the provider from which the KeyStore is to
be instantiated (or null)protection
- the ProtectionParameter securing the Keystoreaicas GmbH, Karlsruhe, Germany —www.aicas.com
Copyright © 2001-2019 aicas GmbH. All Rights Reserved.