KeyManagerFactory (Java SE 9 & JDK 9 ) (original) (raw)

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	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	Description
String	getAlgorithm()	Returns the algorithm name of this KeyManagerFactory object.
static String	getDefaultAlgorithm()	Obtains the default KeyManagerFactory algorithm name.
static KeyManagerFactory	getInstance(String algorithm)	Returns a KeyManagerFactory object that acts as a factory for key managers.
static KeyManagerFactory	getInstance(String algorithm,String provider)	Returns a KeyManagerFactory object that acts as a factory for key managers.
static KeyManagerFactory	getInstance(String algorithm,Provider provider)	Returns a KeyManagerFactory 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 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](../../../java/lang/Object.html "class in java.lang")  
   `[clone](../../../java/lang/Object.html#clone--), [equals](../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../java/lang/Object.html#finalize--), [getClass](../../../java/lang/Object.html#getClass--), [hashCode](../../../java/lang/Object.html#hashCode--), [notify](../../../java/lang/Object.html#notify--), [notifyAll](../../../java/lang/Object.html#notifyAll--), [toString](../../../java/lang/Object.html#toString--), [wait](../../../java/lang/Object.html#wait--), [wait](../../../java/lang/Object.html#wait-long-), [wait](../../../java/lang/Object.html#wait-long-int-)`

Constructor Detail

 * #### KeyManagerFactory  
 protected KeyManagerFactory([KeyManagerFactorySpi](../../../javax/net/ssl/KeyManagerFactorySpi.html "class in javax.net.ssl") factorySpi,  
                             [Provider](../../../java/security/Provider.html "class in java.security") provider,  
                             [String](../../../java/lang/String.html "class in java.lang") algorithm)  
 Creates a KeyManagerFactory object.  
 Parameters:  
 `factorySpi` \- the delegate  
 `provider` \- the provider  
 `algorithm` \- the algorithm

Method Detail

* #### getDefaultAlgorithm  
public static final [String](../../../java/lang/String.html "class in java.lang") 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](../../../java/security/Security.html "class in java.security")  
* #### getAlgorithm  
public final [String](../../../java/lang/String.html "class in java.lang") getAlgorithm()  
Returns the algorithm name of this `KeyManagerFactory` object.  
This is the same name that was specified in one of the`getInstance` calls that created this`KeyManagerFactory` object.  
Returns:  
the algorithm name of this `KeyManagerFactory` object.  
* #### getInstance  
public static final [KeyManagerFactory](../../../javax/net/ssl/KeyManagerFactory.html "class in javax.net.ssl") getInstance([String](../../../java/lang/String.html "class in java.lang") algorithm)  
                                           throws [NoSuchAlgorithmException](../../../java/security/NoSuchAlgorithmException.html "class in java.security")  
Returns a `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()](../../../java/security/Security.html#getProviders--) method.  
Implementation Note:  
The JDK Reference Implementation additionally uses the`jdk.security.provider.preferred` [Security](../../../java/security/Security.html#getProperty-java.lang.String-) property to determine the preferred provider order for the specified algorithm. This may be different than the order of providers returned by[Security.getProviders()](../../../java/security/Security.html#getProviders--).  
Parameters:  
`algorithm` \- the standard name of the requested algorithm. See the [ Java Security Standard Algorithm Names](../../../../specs/security/standard-names.html) document for information about standard algorithm names.  
Returns:  
the new `KeyManagerFactory` object  
Throws:  
`[NoSuchAlgorithmException](../../../java/security/NoSuchAlgorithmException.html "class in java.security")` \- if no `Provider` supports a`KeyManagerFactorySpi` implementation for the specified algorithm  
`[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if `algorithm` is `null`  
See Also:  
[Provider](../../../java/security/Provider.html "class in java.security")  
* #### getInstance  
public static final [KeyManagerFactory](../../../javax/net/ssl/KeyManagerFactory.html "class in javax.net.ssl") getInstance([String](../../../java/lang/String.html "class in java.lang") algorithm,  
                                                  [String](../../../java/lang/String.html "class in java.lang") provider)  
                                           throws [NoSuchAlgorithmException](../../../java/security/NoSuchAlgorithmException.html "class in java.security"),  
                                                  [NoSuchProviderException](../../../java/security/NoSuchProviderException.html "class in java.security")  
Returns a `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()](../../../java/security/Security.html#getProviders--) method.  
Parameters:  
`algorithm` \- the standard name of the requested algorithm. See the [ Java Security Standard Algorithm Names](../../../../specs/security/standard-names.html) document for information about standard algorithm names.  
`provider` \- the name of the provider.  
Returns:  
the new `KeyManagerFactory` object  
Throws:  
`[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the provider name is `null` or empty  
`[NoSuchAlgorithmException](../../../java/security/NoSuchAlgorithmException.html "class in java.security")` \- if a `KeyManagerFactorySpi` implementation for the specified algorithm is not available from the specified provider  
`[NoSuchProviderException](../../../java/security/NoSuchProviderException.html "class in java.security")` \- if the specified provider is not registered in the security provider list  
`[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if `algorithm` is `null`  
See Also:  
[Provider](../../../java/security/Provider.html "class in java.security")  
* #### getInstance  
public static final [KeyManagerFactory](../../../javax/net/ssl/KeyManagerFactory.html "class in javax.net.ssl") getInstance([String](../../../java/lang/String.html "class in java.lang") algorithm,  
                                                  [Provider](../../../java/security/Provider.html "class in java.security") provider)  
                                           throws [NoSuchAlgorithmException](../../../java/security/NoSuchAlgorithmException.html "class in java.security")  
Returns a `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.  
Parameters:  
`algorithm` \- the standard name of the requested algorithm. See the [ Java Security Standard Algorithm Names](../../../../specs/security/standard-names.html) document for information about standard algorithm names.  
`provider` \- an instance of the provider.  
Returns:  
the new `KeyManagerFactory` object  
Throws:  
`[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if provider is `null`  
`[NoSuchAlgorithmException](../../../java/security/NoSuchAlgorithmException.html "class in java.security")` \- if a `@KeyManagerFactorySpi` implementation for the specified algorithm is not available from the specified Provider object  
`[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if `algorithm` is `null`  
See Also:  
[Provider](../../../java/security/Provider.html "class in java.security")  
* #### getProvider  
public final [Provider](../../../java/security/Provider.html "class in java.security") getProvider()  
Returns the provider of this `KeyManagerFactory` object.  
Returns:  
the provider of this `KeyManagerFactory` object  
* #### init  
public final void init([KeyStore](../../../java/security/KeyStore.html "class in java.security") ks,  
                       char[] password)  
                throws [KeyStoreException](../../../java/security/KeyStoreException.html "class in java.security"),  
                       [NoSuchAlgorithmException](../../../java/security/NoSuchAlgorithmException.html "class in java.security"),  
                       [UnrecoverableKeyException](../../../java/security/UnrecoverableKeyException.html "class in java.security")  
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)](../../../javax/net/ssl/KeyManagerFactory.html#init-javax.net.ssl.ManagerFactoryParameters-).  
Parameters:  
`ks` \- the key store or null  
`password` \- the password for recovering keys in the KeyStore  
Throws:  
`[KeyStoreException](../../../java/security/KeyStoreException.html "class in java.security")` \- if this operation fails  
`[NoSuchAlgorithmException](../../../java/security/NoSuchAlgorithmException.html "class in java.security")` \- if the specified algorithm is not available from the specified provider.  
`[UnrecoverableKeyException](../../../java/security/UnrecoverableKeyException.html "class in java.security")` \- if the key cannot be recovered (e.g. the given password is wrong).  
* #### init  
public final void init([ManagerFactoryParameters](../../../javax/net/ssl/ManagerFactoryParameters.html "interface in javax.net.ssl") spec)  
                throws [InvalidAlgorithmParameterException](../../../java/security/InvalidAlgorithmParameterException.html "class in java.security")  
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 the `ManagerFactoryParameters` implementation to obtain the needed information.  
Parameters:  
`spec` \- an implementation of a provider-specific parameter specification  
Throws:  
`[InvalidAlgorithmParameterException](../../../java/security/InvalidAlgorithmParameterException.html "class in java.security")` \- if an error is encountered  
* #### getKeyManagers  
public final [KeyManager](../../../javax/net/ssl/KeyManager.html "interface in javax.net.ssl")[] getKeyManagers()  
Returns one key manager for each type of key material.  
Returns:  
the key managers  
Throws:  
`[IllegalStateException](../../../java/lang/IllegalStateException.html "class in java.lang")` \- if the KeyManagerFactory is not initialized

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2017, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.

KeyManagerFactory (Java SE 9 & JDK 9 ) (original) (raw)

Constructor Summary

Method Summary

Constructor Detail

Method Detail