javax.net.ssl
Class KeyManagerFactory
- java.lang.Object
javax.net.ssl.KeyManagerFactory
- public class KeyManagerFactory
- extends Object
Constructor Summary
Modifier | Constructor and Description |
---|---|
|
KeyManagerFactory(KeyManagerFactorySpi factorySpi,Provider provider,String algorithm)
Creates a KeyManagerFactory object.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
getAlgorithm()
Returns the algorithm name of this
KeyManagerFactory object.
|
|
|
getDefaultAlgorithm()
Obtains the default KeyManagerFactory algorithm name.
|
|
getInstance(String algorithm)
Returns a
KeyManagerFactory object that acts as a
factory for key managers.
|
|
getInstance(String algorithm,Provider provider)
Returns a
KeyManagerFactory object that acts as a
factory for key managers.
|
|
getInstance(String algorithm,String provider)
Returns a
KeyManagerFactory object that acts as a
factory for key managers.
|
getKeyManagers()
Returns one key manager for each type of key material.
|
|
getProvider()
Returns the provider of this
KeyManagerFactory object.
|
|
|
init(KeyStore ks,char[] password)
Initializes this factory with a source of key material.
|
|
init(ManagerFactoryParameters spec)
Initializes this factory with a source of provider-specific
key material.
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail
KeyManagerFactory
- protected KeyManagerFactory(KeyManagerFactorySpi factorySpi,
- Provider provider,
- String algorithm)
factorySpi
- the delegate provider
- the provider algorithm
- the algorithm Method Detail
getDefaultAlgorithm
- public static final String getDefaultAlgorithm( )
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
Security.setProperty(java.lang.String,
java.lang.String)
)
to the desired algorithm name.
getAlgorithm
- public final String getAlgorithm( )
KeyManagerFactory
object.
This is the same name that was specified in one of the
getInstance
calls that created this
KeyManagerFactory
object.
KeyManagerFactory
object. getInstance
- public static final KeyManagerFactory getInstance( String algorithm)
- throws NoSuchAlgorithmException
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.
algorithm
- the standard name of the requested algorithm. KeyManagerFactory
object. NoSuchAlgorithmException
- if no Provider supports a
KeyManagerFactorySpi implementation for the
specified algorithm. getInstance
- public static final KeyManagerFactory getInstance( String algorithm,
- String provider)
- throws NoSuchAlgorithmException
- NoSuchProviderException
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.
algorithm
- the standard name of the requested algorithm. provider
- the name of the provider. KeyManagerFactory
object. 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. getInstance
- public static final KeyManagerFactory getInstance( String algorithm,
- Provider provider)
- throws NoSuchAlgorithmException
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.
algorithm
- the standard name of the requested algorithm. provider
- an instance of the provider. KeyManagerFactory
object. NoSuchAlgorithmException
- if a KeyManagerFactorySpi
implementation for the specified algorithm is not available
from the specified Provider object. IllegalArgumentException
- if provider is null. getProvider
- public final Provider getProvider( )
KeyManagerFactory
object.
KeyManagerFactory
object init
- public final void init(KeyStore ks,
- char[] password)
- throws KeyStoreException
- NoSuchAlgorithmException
- UnrecoverableKeyException
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)
.
ks
- the key store or null password
- the password for recovering keys in the KeyStore 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). init
- public final void init(ManagerFactoryParameters spec)
- throws InvalidAlgorithmParameterException
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.
spec
- an implementation of a provider-specific parameter
specification InvalidAlgorithmParameterException
- if an error is encountered getKeyManagers
- public final KeyManager[] getKeyManagers( )
IllegalStateException
- if the KeyManagerFactory is not initialized