- Enclosing class:
KeyStore
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.
- Since:
- 1.5
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract KeyStore
Returns theKeyStore
described by this object.abstract KeyStore.ProtectionParameter
getProtectionParameter
(String alias) Returns theProtectionParameter
that should be used to obtain theEntry
with the given alias.static KeyStore.Builder
newInstance
(File file, KeyStore.ProtectionParameter protection) Returns a newBuilder
object.static KeyStore.Builder
newInstance
(String type, Provider provider, File file, KeyStore.ProtectionParameter protection) Returns a newBuilder
object.static KeyStore.Builder
newInstance
(String type, Provider provider, KeyStore.ProtectionParameter protection) Returns a newBuilder
object.static KeyStore.Builder
newInstance
(KeyStore keyStore, KeyStore.ProtectionParameter protectionParameter) Returns a newBuilder
that encapsulates the givenKeyStore
.
-
Constructor Details
-
Builder
protected Builder()Construct a newBuilder
.
-
-
Method Details
-
getKeyStore
Returns theKeyStore
described by this object.- Returns:
- the
KeyStore
described by this object - Throws:
KeyStoreException
- if an error occurred during the operation, for example if theKeyStore
could not be instantiated or loaded
-
getProtectionParameter
public abstract KeyStore.ProtectionParameter getProtectionParameter(String alias) throws KeyStoreException Returns theProtectionParameter
that should be used to obtain theEntry
with the given alias. ThegetKeyStore
method must be invoked before this method may be called.- Parameters:
alias
- the alias of theKeyStore
entry- Returns:
- the
ProtectionParameter
that should be used to obtain theEntry
with the given alias. - Throws:
NullPointerException
- if alias isnull
KeyStoreException
- if an error occurred during the operationIllegalStateException
- if thegetKeyStore
method has not been invoked prior to calling this method
-
newInstance
public static KeyStore.Builder newInstance(KeyStore keyStore, KeyStore.ProtectionParameter protectionParameter) Returns a newBuilder
that encapsulates the givenKeyStore
. The getKeyStore() method of the returned object will returnkeyStore
, the getProtectionParameter() method will returnprotectionParameters
.This is useful if an existing
KeyStore
object needs to be used with builder-based APIs.- Parameters:
keyStore
- theKeyStore
to be encapsulatedprotectionParameter
- theProtectionParameter
used to protect theKeyStore
entries- Returns:
- a new
Builder
object - Throws:
NullPointerException
- ifkeyStore
orprotectionParameter
isnull
IllegalArgumentException
- if thekeyStore
has not been initialized
-
newInstance
public static KeyStore.Builder newInstance(String type, Provider provider, File file, KeyStore.ProtectionParameter protection) Returns a newBuilder
object.The first call to the
getKeyStore()
method on the returned builder will create aKeyStore
of typetype
and call itsload()
method. TheinputStream
argument is constructed fromfile
. Ifprotection
is aPasswordProtection
, the password is obtained by calling thegetPassword
method. Otherwise, ifprotection
is aCallbackHandlerProtection
, the password is obtained by invoking the CallbackHandler.Subsequent calls to
getKeyStore()
return the same object as the initial call. If the initial call failed with aKeyStoreException
, subsequent calls also throw aKeyStoreException
.The
KeyStore
is instantiated fromprovider
if non-null. Otherwise, all installed providers are searched.Calls to
getProtectionParameter()
will return aPasswordProtection
object encapsulating the password that was used to invoke theload
method.Note that the
getKeyStore()
method is executed within theAccessControlContext
of the code invoking this method.- Parameters:
type
- the type ofKeyStore
to be constructedprovider
- the provider from which theKeyStore
is to be instantiated (ornull
)file
- the File that contains theKeyStore
dataprotection
- theProtectionParameter
securing theKeyStore
data- Returns:
- a new
Builder
object - Throws:
NullPointerException
- if type, file or protection isnull
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
Returns a newBuilder
object.The first call to the
getKeyStore()
method on the returned builder will create aKeyStore
usingfile
to detect the keystore type and then call itsload()
method. It uses the same algorithm to determine the keystore type as described inKeyStore.getInstance(File, LoadStoreParameter)
. TheinputStream
argument is constructed fromfile
. Ifprotection
is aPasswordProtection
, the password is obtained by calling thegetPassword
method. Otherwise, ifprotection
is aCallbackHandlerProtection
, the password is obtained by invoking the CallbackHandler.Subsequent calls to
getKeyStore()
return the same object as the initial call. If the initial call failed with aKeyStoreException
, subsequent calls also throw aKeyStoreException
.Calls to
getProtectionParameter()
will return aPasswordProtection
object encapsulating the password that was used to invoke theload
method.Note that the
getKeyStore()
method is executed within theAccessControlContext
of the code invoking this method.- Parameters:
file
- the File that contains theKeyStore
dataprotection
- theProtectionParameter
securing theKeyStore
data- Returns:
- a new
Builder
object - Throws:
NullPointerException
- if file or protection isnull
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- Since:
- 9
-
newInstance
public static KeyStore.Builder newInstance(String type, Provider provider, KeyStore.ProtectionParameter protection) Returns a newBuilder
object.Each call to the
getKeyStore()
method on the returned builder will return a newKeyStore
object of typetype
. Itsload()
method is invoked using aLoadStoreParameter
that encapsulatesprotection
.The
KeyStore
is instantiated fromprovider
if non-null. Otherwise, all installed providers are searched.Calls to
getProtectionParameter()
will returnprotection
.Note that the
getKeyStore()
method is executed within theAccessControlContext
of the code invoking this method.- Parameters:
type
- the type ofKeyStore
to be constructedprovider
- the provider from which theKeyStore
is to be instantiated (ornull
)protection
- theProtectionParameter
securing theKeystore
- Returns:
- a new
Builder
object - Throws:
NullPointerException
- if type or protection isnull
-