public class KeyManagerFactory extends Object
Modifier | Constructor | Description |
---|---|---|
protected |
Creates a KeyManagerFactory object. |
Modifier and Type | Method | Description |
---|---|---|
final String |
getAlgorithm() |
Returns the algorithm name of this KeyManagerFactory object. |
static final String |
getDefaultAlgorithm() |
Obtains the default KeyManagerFactory algorithm name. |
static final KeyManagerFactory |
getInstance |
Returns a KeyManagerFactory object that acts as a factory for key managers. |
static final KeyManagerFactory |
getInstance |
Returns a KeyManagerFactory object that acts as a factory for key managers. |
static final KeyManagerFactory |
getInstance |
Returns a KeyManagerFactory object that acts as a factory for key managers. |
final KeyManager[] |
getKeyManagers() |
Returns one key manager for each type of key material. |
final Provider |
getProvider() |
Returns the provider of this KeyManagerFactory object. |
final void |
init |
Initializes this factory with a source of key material. |
final void |
init |
Initializes this factory with a source of provider-specific key material. |
protected KeyManagerFactory(KeyManagerFactorySpi factorySpi, Provider provider, String algorithm)
factorySpi
- the delegateprovider
- the provideralgorithm
- the algorithmpublic static final String getDefaultAlgorithm()
The default algorithm can be changed at runtime by setting the value of the ssl.KeyManagerFactory.algorithm
security property to the desired algorithm name.
ssl.KeyManagerFactory.algorithm
security property, or an implementation-specific default if no such property exists.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.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.
jdk.security.provider.preferred
Security
property to determine the preferred provider order for the specified algorithm. This may be different from the order of providers returned by Security.getProviders()
.algorithm
- the standard name of the requested algorithm. See the KeyManagerFactory section in the Java Security Standard Algorithm Names Specification for information about standard algorithm names.KeyManagerFactory
objectNoSuchAlgorithmException
- if no Provider
supports a KeyManagerFactorySpi
implementation for the specified algorithmNullPointerException
- if algorithm
is null
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. See the KeyManagerFactory section in the Java Security Standard Algorithm Names Specification for information about standard algorithm names.provider
- the name of the provider.KeyManagerFactory
objectIllegalArgumentException
- if the provider name is null
or emptyNoSuchAlgorithmException
- if a KeyManagerFactorySpi
implementation for the specified algorithm is not available from the specified providerNoSuchProviderException
- if the specified provider is not registered in the security provider listNullPointerException
- if algorithm
is null
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. See the KeyManagerFactory section in the Java Security Standard Algorithm Names Specification for information about standard algorithm names.provider
- an instance of the provider.KeyManagerFactory
objectIllegalArgumentException
- if provider is null
NoSuchAlgorithmException
- if a @KeyManagerFactorySpi
implementation for the specified algorithm is not available from the specified Provider objectNullPointerException
- if algorithm
is null
public final Provider getProvider()
KeyManagerFactory
object.KeyManagerFactory
objectpublic 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 nullpassword
- the password for recovering keys in the KeyStoreKeyStoreException
- if this operation failsNoSuchAlgorithmException
- 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).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 specificationInvalidAlgorithmParameterException
- if an error is encounteredpublic final KeyManager[] getKeyManagers()
IllegalStateException
- if the KeyManagerFactory is not initialized
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/javax/net/ssl/KeyManagerFactory.html