- java.lang.Object
- 
- javax.net.ssl.KeyManagerFactory
 
- 
 public class KeyManagerFactory extends Object 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.- Since:
- 1.4
- See Also:
- KeyManager
 
- 
- 
Constructor SummaryConstructors Modifier Constructor Description protectedKeyManagerFactory(KeyManagerFactorySpi factorySpi, Provider provider, String algorithm)Creates a KeyManagerFactory object.
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetAlgorithm()Returns the algorithm name of thisKeyManagerFactoryobject.static StringgetDefaultAlgorithm()Obtains the default KeyManagerFactory algorithm name.static KeyManagerFactorygetInstance(String algorithm)Returns aKeyManagerFactoryobject that acts as a factory for key managers.static KeyManagerFactorygetInstance(String algorithm, String provider)Returns aKeyManagerFactoryobject that acts as a factory for key managers.static KeyManagerFactorygetInstance(String algorithm, Provider provider)Returns aKeyManagerFactoryobject that acts as a factory for key managers.KeyManager[]getKeyManagers()Returns one key manager for each type of key material.ProvidergetProvider()Returns the provider of thisKeyManagerFactoryobject.voidinit(KeyStore ks, char[] password)Initializes this factory with a source of key material.voidinit(ManagerFactoryParameters spec)Initializes this factory with a source of provider-specific key material.
 
- 
- 
- 
Constructor Detail- 
KeyManagerFactoryprotected KeyManagerFactory(KeyManagerFactorySpi factorySpi, Provider provider, String algorithm) Creates a KeyManagerFactory object.- Parameters:
- factorySpi- the delegate
- provider- the provider
- algorithm- the algorithm
 
 
- 
 - 
Method Detail- 
getDefaultAlgorithmpublic static final String getDefaultAlgorithm() Obtains the default KeyManagerFactory algorithm name.The default algorithm can be changed at runtime by setting the value of the ssl.KeyManagerFactory.algorithmsecurity property to the desired algorithm name.- Returns:
- the default algorithm name as specified by the
          ssl.KeyManagerFactory.algorithmsecurity property, or an implementation-specific default if no such property exists.
- See Also:
- security properties
 
 - 
getAlgorithmpublic final String getAlgorithm() Returns the algorithm name of thisKeyManagerFactoryobject.This is the same name that was specified in one of the getInstancecalls that created thisKeyManagerFactoryobject.- Returns:
- the algorithm name of this KeyManagerFactoryobject.
 
 - 
getInstancepublic static final KeyManagerFactory getInstance(String algorithm) throws NoSuchAlgorithmException Returns aKeyManagerFactoryobject 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.- Implementation Note:
- The JDK Reference Implementation additionally uses the
 jdk.security.provider.preferredSecurityproperty to determine the preferred provider order for the specified algorithm. This may be different than the order of providers returned bySecurity.getProviders().
- Parameters:
- algorithm- the standard name of the requested algorithm. See the Java Security Standard Algorithm Names document for information about standard algorithm names.
- Returns:
- the new KeyManagerFactoryobject
- Throws:
- NoSuchAlgorithmException- if no- Providersupports a- KeyManagerFactorySpiimplementation for the specified algorithm
- NullPointerException- if- algorithmis- null
- See Also:
- Provider
 
 - 
getInstancepublic static final KeyManagerFactory getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException Returns aKeyManagerFactoryobject 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- the standard name of the requested algorithm. See the Java Security Standard Algorithm Names document for information about standard algorithm names.
- provider- the name of the provider.
- Returns:
- the new KeyManagerFactoryobject
- Throws:
- IllegalArgumentException- if the provider name is- nullor empty
- NoSuchAlgorithmException- if a- KeyManagerFactorySpiimplementation for the specified algorithm is not available from the specified provider
- NoSuchProviderException- if the specified provider is not registered in the security provider list
- NullPointerException- if- algorithmis- null
- See Also:
- Provider
 
 - 
getInstancepublic static final KeyManagerFactory getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException Returns aKeyManagerFactoryobject 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- the standard name of the requested algorithm. See the Java Security Standard Algorithm Names document for information about standard algorithm names.
- provider- an instance of the provider.
- Returns:
- the new KeyManagerFactoryobject
- Throws:
- IllegalArgumentException- if provider is- null
- NoSuchAlgorithmException- if a- @KeyManagerFactorySpiimplementation for the specified algorithm is not available from the specified Provider object
- NullPointerException- if- algorithmis- null
- See Also:
- Provider
 
 - 
getProviderpublic final Provider getProvider() Returns the provider of thisKeyManagerFactoryobject.- Returns:
- the provider of this KeyManagerFactoryobject
 
 - 
initpublic final void init(KeyStore ks, char[] password) throws KeyStoreException, NoSuchAlgorithmException, UnrecoverableKeyException 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- the key store or null
- password- 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).
 
 - 
initpublic final void init(ManagerFactoryParameters spec) throws InvalidAlgorithmParameterException 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 ManagerFactoryParametersas defined by the provider. The provider can then call the specified methods in theManagerFactoryParametersimplementation to obtain the needed information.- Parameters:
- spec- an implementation of a provider-specific parameter specification
- Throws:
- InvalidAlgorithmParameterException- if an error is encountered
 
 - 
getKeyManagerspublic final KeyManager[] getKeyManagers() Returns one key manager for each type of key material.- Returns:
- the key managers
- Throws:
- IllegalStateException- if the KeyManagerFactory is not initialized
 
 
- 
 
-