Package javax.net.ssl

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

Method Summary

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.
KeyManager[]	getKeyManagers()	Returns one key manager for each type of key material.
void	init(KeyStore ks, char[] password)	Initializes this factory with a source of key material.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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.

getAlgorithm

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.

getInstance

public static final KeyManagerFactory getInstance(String algorithm)
                                           throws NoSuchAlgorithmException

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.

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.

init

public final void init(@Nullable
                       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.

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

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