Class KeyManagerFactory
- 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 Summary
Constructors Modifier Constructor and Description protected
KeyManagerFactory(KeyManagerFactorySpi factorySpi, Provider provider, String algorithm)
Creates a KeyManagerFactory object.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description String
getAlgorithm()
Returns the algorithm name of thisKeyManagerFactory
object.static String
getDefaultAlgorithm()
Obtains the default KeyManagerFactory algorithm name.static KeyManagerFactory
getInstance(String algorithm)
Returns aKeyManagerFactory
object that acts as a factory for key managers.static KeyManagerFactory
getInstance(String algorithm, Provider provider)
Returns aKeyManagerFactory
object that acts as a factory for key managers.static KeyManagerFactory
getInstance(String algorithm, String provider)
Returns aKeyManagerFactory
object that acts as a factory for key managers.KeyManager[]
getKeyManagers()
Returns one key manager for each type of key material.Provider
getProvider()
Returns the provider of thisKeyManagerFactory
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.
-
-
-
Constructor Detail
KeyManagerFactory
protected KeyManagerFactory(KeyManagerFactorySpi factorySpi, Provider provider, String algorithm)
Creates a KeyManagerFactory object.- Parameters:
-
factorySpi
- the delegate -
provider
- the provider -
algorithm
- the algorithm
-
Method Detail
getDefaultAlgorithm
public 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.algorithm
security property to the desired algorithm name.- Returns:
-
the default algorithm name as specified by the
ssl.KeyManagerFactory.algorithm
security property, or an implementation-specific default if no such property exists. - See Also:
-
security properties
getAlgorithm
public final String getAlgorithm()
Returns the algorithm name of thisKeyManagerFactory
object.This is the same name that was specified in one of the
getInstance
calls that created thisKeyManagerFactory
object.- Returns:
-
the algorithm name of this
KeyManagerFactory
object.
getInstance
public static final KeyManagerFactory getInstance(String algorithm) throws NoSuchAlgorithmException
Returns aKeyManagerFactory
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
- the standard name of the requested algorithm. See the Java Secure Socket Extension Reference Guide for information about standard algorithm names. - Returns:
-
the new
KeyManagerFactory
object. - Throws:
-
NoSuchAlgorithmException
- if no Provider supports a KeyManagerFactorySpi implementation for the specified algorithm. -
NullPointerException
- ifalgorithm
is null. - See Also:
-
Provider
getInstance
public static final KeyManagerFactory getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
Returns aKeyManagerFactory
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
- the standard name of the requested algorithm. See the Java Secure Socket Extension Reference Guide for information about standard algorithm names. -
provider
- the name of the provider. - Returns:
-
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
- ifalgorithm
is null. - See Also:
-
Provider
getInstance
public static final KeyManagerFactory getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException
Returns aKeyManagerFactory
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
- the standard name of the requested algorithm. See the Java Secure Socket Extension Reference Guide for information about standard algorithm names. -
provider
- an instance of the provider. - Returns:
-
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
- ifalgorithm
is null. - See Also:
-
Provider
getProvider
public final Provider getProvider()
Returns the provider of thisKeyManagerFactory
object.- Returns:
-
the provider of this
KeyManagerFactory
object
init
public 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).
init
public 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
ManagerFactoryParameters
as defined by the provider. The provider can then call the specified methods in theManagerFactoryParameters
implementation to obtain the needed information.- Parameters:
-
spec
- an implementation of a provider-specific parameter specification - Throws:
-
InvalidAlgorithmParameterException
- if an error is encountered
getKeyManagers
public 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
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.