public
class
KeyManagerFactory
extends Object
java.lang.Object | |
↳ | javax.net.ssl.KeyManagerFactory |
This class acts as a factory for key managers based on a source of key material. Each key manager manages a specific type of key material for use by secure sockets. The key material is based on a KeyStore and/or provider specific sources.
See also:
Protected constructors | |
---|---|
KeyManagerFactory(KeyManagerFactorySpi factorySpi, Provider provider, String algorithm)
Creates a KeyManagerFactory object. |
Public methods | |
---|---|
final
String
|
getAlgorithm()
Returns the algorithm name of this |
static
final
String
|
getDefaultAlgorithm()
Obtains the default KeyManagerFactory algorithm name. |
static
final
KeyManagerFactory
|
getInstance(String algorithm)
Returns a |
static
final
KeyManagerFactory
|
getInstance(String algorithm, String provider)
Returns a |
static
final
KeyManagerFactory
|
getInstance(String algorithm, Provider provider)
Returns a |
final
KeyManager[]
|
getKeyManagers()
Returns one key manager for each type of key material. |
final
Provider
|
getProvider()
Returns the provider of this |
final
void
|
init(ManagerFactoryParameters spec)
Initializes this factory with a source of provider-specific key material. |
final
void
|
init(KeyStore ks, char[] password)
Initializes this factory with a source of key material. |
Inherited methods | |
---|---|
From
class
java.lang.Object
|
KeyManagerFactory (KeyManagerFactorySpi factorySpi, Provider provider, String algorithm)
Creates a KeyManagerFactory object.
Parameters | |
---|---|
factorySpi |
KeyManagerFactorySpi :
the delegate |
provider |
Provider :
the provider |
algorithm |
String :
the algorithm
|
String getAlgorithm ()
Returns the algorithm name of this KeyManagerFactory
object.
This is the same name that was specified in one of the
getInstance
calls that created this
KeyManagerFactory
object.
Returns | |
---|---|
String |
the algorithm name of this KeyManagerFactory object.
|
String getDefaultAlgorithm ()
Obtains the default KeyManagerFactory algorithm name.
The default algorithm can be changed at runtime by setting
the value of the "ssl.KeyManagerFactory.algorithm" security
property (set in the Java security properties file or by calling
setProperty(java.lang.String, java.lang.String)
)
to the desired algorithm name.
Returns | |
---|---|
String |
the default algorithm name as specified in the Java security properties, or an implementation-specific default if no such property exists. |
KeyManagerFactory getInstance (String algorithm)
Returns a KeyManagerFactory
object that acts as a
factory for key managers.
This method traverses the list of registered security Providers, starting with the most preferred Provider. A new KeyManagerFactory object encapsulating the KeyManagerFactorySpi implementation from the first Provider that supports the specified algorithm is returned.
Note that the list of registered providers may be retrieved via
the Security.getProviders()
method.
Parameters | |
---|---|
algorithm |
String :
the standard name of the requested algorithm.
See the
Java Secure Socket Extension Reference Guide
for information about standard algorithm names. |
Returns | |
---|---|
KeyManagerFactory |
the new KeyManagerFactory object. |
Throws | |
---|---|
NoSuchAlgorithmException |
if no Provider supports a KeyManagerFactorySpi implementation for the specified algorithm. |
NullPointerException |
if algorithm is null. |
See also:
KeyManagerFactory getInstance (String algorithm, String provider)
Returns a KeyManagerFactory
object that acts as a
factory for key managers.
A new KeyManagerFactory object encapsulating the KeyManagerFactorySpi implementation from the specified provider is returned. The specified provider must be registered in the security provider list.
Note that the list of registered providers may be retrieved via
the Security.getProviders()
method.
Parameters | |
---|---|
algorithm |
String :
the standard name of the requested algorithm.
See the
Java Secure Socket Extension Reference Guide
for information about standard algorithm names. |
provider |
String :
the name of the provider. |
Returns | |
---|---|
KeyManagerFactory |
the new KeyManagerFactory object. |
Throws | |
---|---|
NoSuchAlgorithmException |
if a KeyManagerFactorySpi implementation for the specified algorithm is not available from the specified provider. |
NoSuchProviderException |
if the specified provider is not registered in the security provider list. |
IllegalArgumentException |
if the provider name is null or empty. |
NullPointerException |
if algorithm is null. |
See also:
KeyManagerFactory getInstance (String algorithm, Provider provider)
Returns a KeyManagerFactory
object that acts as a
factory for key managers.
A new KeyManagerFactory object encapsulating the KeyManagerFactorySpi implementation from the specified Provider object is returned. Note that the specified Provider object does not have to be registered in the provider list.
Parameters | |
---|---|
algorithm |
String :
the standard name of the requested algorithm.
See the
Java Secure Socket Extension Reference Guide
for information about standard algorithm names. |
provider |
Provider :
an instance of the provider. |
Returns | |
---|---|
KeyManagerFactory |
the new KeyManagerFactory object. |
Throws | |
---|---|
NoSuchAlgorithmException |
if a KeyManagerFactorySpi implementation for the specified algorithm is not available from the specified Provider object. |
IllegalArgumentException |
if provider is null. |
NullPointerException |
if algorithm is null. |
See also:
KeyManager[] getKeyManagers ()
Returns one key manager for each type of key material.
Returns | |
---|---|
KeyManager[] |
the key managers |
Throws | |
---|---|
IllegalStateException |
if the KeyManagerFactory is not initialized |
Provider getProvider ()
Returns the provider of this KeyManagerFactory
object.
Returns | |
---|---|
Provider |
the provider of this KeyManagerFactory object
|
void init (ManagerFactoryParameters spec)
Initializes this factory with a source of provider-specific key material.
In some cases, initialization parameters other than a keystore
and password may be needed by a provider. Users of that
particular provider are expected to pass an implementation of
the appropriate ManagerFactoryParameters
as
defined by the provider. The provider can then call the
specified methods in the ManagerFactoryParameters
implementation to obtain the needed information.
Parameters | |
---|---|
spec |
ManagerFactoryParameters :
an implementation of a provider-specific parameter
specification |
Throws | |
---|---|
InvalidAlgorithmParameterException |
if an error is encountered |
void init (KeyStore ks, char[] password)
Initializes this factory with a source of key material.
The provider typically uses a KeyStore for obtaining key material for use during secure socket negotiations. The KeyStore is generally password-protected.
For more flexible initialization, please see
init(ManagerFactoryParameters)
.
Parameters | |
---|---|
ks |
KeyStore :
the key store or null |
password |
char :
the password for recovering keys in the KeyStore |
Throws | |
---|---|
KeyStoreException |
if this operation fails |
NoSuchAlgorithmException |
if the specified algorithm is not available from the specified provider. |
UnrecoverableKeyException |
if the key cannot be recovered (e.g. the given password is wrong). |