KeyManagerFactory

AI-generated Key Takeaways

• KeyManagerFactory acts as a factory for creating KeyManager objects, which manage key material for secure sockets.

• It uses a KeyStore and/or provider-specific sources to obtain key material.

• Android supports the "PKIX" algorithm for KeyManagerFactory.

• Developers can obtain an instance of KeyManagerFactory using the getInstance() methods and initialize it with a keystore and password or provider-specific parameters.

• The getKeyManagers() method returns an array of KeyManager objects for use in secure socket connections.

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.

Android provides the following KeyManagerFactory algorithms:

Algorithm	Supported API Levels
PKIX	1+

See Also

• KeyManager

Protected Constructor Summary

KeyManagerFactory(KeyManagerFactorySpi factorySpi, Provider provider, String algorithm) Creates a KeyManagerFactory object.

Public Method Summary

final String	getAlgorithm() Returns the algorithm name of this KeyManagerFactory object.
final static String	getDefaultAlgorithm() Obtains the default KeyManagerFactory algorithm name.
final static KeyManagerFactory	getInstance(String algorithm) Returns a KeyManagerFactory object that acts as a factory for key managers.
final static KeyManagerFactory	getInstance(String algorithm, String provider) Returns a KeyManagerFactory object that acts as a factory for key managers.
final static KeyManagerFactory	getInstance(String algorithm, Provider provider) 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(ManagerFactoryParameters spec) Initializes this factory with a source of provider-specific key material.
final void	init(KeyStore ks, char[] password) Initializes this factory with a source of key material.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Protected Constructors

protected KeyManagerFactory (KeyManagerFactorySpi factorySpi, Provider provider, String algorithm)

Creates a KeyManagerFactory object.

Parameters

factorySpi	the delegate
provider	the provider
algorithm	the algorithm

Public Methods

public final String 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.

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

public static final KeyManagerFactory getInstance (String algorithm)

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() 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	if algorithm is null.

See Also

• Provider

public static final KeyManagerFactory getInstance (String algorithm, String provider)

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() 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	if algorithm is null.

See Also

• Provider

public static final KeyManagerFactory getInstance (String algorithm, Provider provider)

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 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	if algorithm is null.

See Also

• Provider

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

public final Provider getProvider ()

Returns the provider of this KeyManagerFactory object.

Returns

• the provider of this KeyManagerFactory object

public final void init (ManagerFactoryParameters spec)

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	if an error is encountered

public final void init (KeyStore ks, char[] password)

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).