java.lang.Object javax.net.ssl.KeyManagerFactory
public class 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.
Constructor Summary | |
---|---|
protected |
KeyManagerFactory
(
KeyManagerFactorySpi
factorySpi,
Provider
provider,
String
algorithm) Creates a KeyManagerFactory object. |
Method Summary | |
---|---|
String |
getAlgorithm
() Returns the algorithm name of this KeyManagerFactory object. |
static String |
getDefaultAlgorithm
() Obtains the default KeyManagerFactory algorithm name. |
static KeyManagerFactory |
getInstance
(
String
Returns |
static KeyManagerFactory |
getInstance
(
String
algorithm,
Provider
Returns |
static KeyManagerFactory |
getInstance
(
String
algorithm,
String
Returns |
KeyManager [] |
getKeyManagers
() Returns one key manager for each type of key material. |
Provider |
getProvider
() Returns the provider of this KeyManagerFactory object. |
void |
init
(
KeyStore
ks, char[] password) Initializes this factory with a source of key material. |
void |
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 |
---|
protected KeyManagerFactory(KeyManagerFactorySpi factorySpi, Provider provider, String algorithm)
Method Detail |
---|
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.
public final String getAlgorithm()
This is the same name that was specified in one of the getInstance calls that created this KeyManagerFactory object.
public static final KeyManagerFactory getInstance(String algorithm) throws NoSuchAlgorithmException
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.
If the default provider package provides an implementation of the requested key management algorithm, an instance of KeyManagerFactory containing that implementation is returned. If the algorithm is not available in the default provider package, other provider packages are searched.
Note that the list of registered providers may be retrieved via the Security.getProviders() method.
public static final KeyManagerFactory getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
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.
public static final KeyManagerFactory getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException
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.
public final Provider getProvider()
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) .
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.
public final KeyManager[] getKeyManagers()