Added in API level 1

Summary: Protected Ctors | Methods | Inherited Methods

KeyManagerFactory

public class KeyManagerFactory
extends Object

java.lang.Object
↳	javax.net.ssl.KeyManagerFactory

---

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

Summary

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

Public methods
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(String algorithm) Returns a KeyManagerFactory object that acts as a factory for key managers.
static final KeyManagerFactory	getInstance(String algorithm, String provider) Returns a KeyManagerFactory object that acts as a factory for key managers.
static final 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 methods

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Protected constructors

KeyManagerFactory

Added in API level 1

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

Creates a KeyManagerFactory object.

Parameters
factorySpi	KeyManagerFactorySpi: the delegate
provider	Provider: the provider
algorithm	String: the algorithm

Public methods

getAlgorithm

Added in API level 1

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
String	the algorithm name of this KeyManagerFactory object.

getDefaultAlgorithm

Added in API level 1

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
String	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

getInstance

Added in API level 1

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	String: the standard name of the requested algorithm. See the Java Secure Socket Extension Reference Guide for information about standard algorithm names.

Returns
KeyManagerFactory	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

getInstance

Added in API level 1

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	String: the standard name of the requested algorithm. See the Java Secure Socket Extension Reference Guide for information about standard algorithm names.
provider	String: the name of the provider.

Returns
KeyManagerFactory	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

getInstance

Added in API level 1

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	String: the standard name of the requested algorithm. See the Java Secure Socket Extension Reference Guide for information about standard algorithm names.
provider	Provider: an instance of the provider.

Returns
KeyManagerFactory	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

getKeyManagers

Added in API level 1

public final KeyManager[] getKeyManagers ()

Returns one key manager for each type of key material.

Returns
KeyManager[]	the key managers

Throws
IllegalStateException	if the KeyManagerFactory is not initialized

getProvider

Added in API level 1

public final Provider getProvider ()

Returns the provider of this KeyManagerFactory object.

Returns
Provider	the provider of this KeyManagerFactory object

init

Added in API level 1

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	ManagerFactoryParameters: an implementation of a provider-specific parameter specification

Throws
InvalidAlgorithmParameterException	if an error is encountered

init

Added in API level 1

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(javax.net.ssl.ManagerFactoryParameters).

Parameters
ks	KeyStore: the key store or null
password	char: 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).