javax.net.ssl

Class KeyManagerFactory


public class KeyManagerFactory
extends java.lang.Object

A class that creates key manager implementations based on a requested algorithm.
Author:
Casey Marshall (rsdio@metastatic.org)

Constructor Summary

KeyManagerFactory(KeyManagerFactorySpi kmfSpi, Provider provider, String algorithm)
Create a new key manager factory.

Method Summary

String
getAlgorithm()
Returns the name of this key manager factory algorithm.
static String
getDefaultAlgorithm()
Get the default algorithm name.
static KeyManagerFactory
getInstance(String algorithm)
Get an instance of the named key manager factory, from the first provider that implements it.
static KeyManagerFactory
getInstance(String algorithm, Provider provider)
Get an instance of the named key manager factory, from the given provider.
static KeyManagerFactory
getInstance(String algorithm, String provider)
Get an instance of the named key manager factory, from the named provider.
KeyManager[]
getKeyManagers()
Get an array of key managers appropriate for this algorithm, with the most preferred manager first.
Provider
getProvider()
Returns the provider of this implementation.
void
init(KeyStore store, char[] passwd)
Initialize this instance with a key store and a password for private key entries.
void
init(ManagerFactoryParameters params)
Initialize this instance with an implementation-dependent parameter object.

Constructor Details

KeyManagerFactory

protected KeyManagerFactory(KeyManagerFactorySpi kmfSpi,
                            Provider provider,
                            String algorithm)
Create a new key manager factory.
Parameters:
kmfSpi - The underlying engine.
provider - The engine's provider.
algorithm - The name of this algorithm.

Method Details

getAlgorithm

public final String getAlgorithm()
Returns the name of this key manager factory algorithm.
Returns:
The name of this key manager factory algorithm.

getDefaultAlgorithm

public static final String getDefaultAlgorithm()
Get the default algorithm name. This value may be specified at run-time via the security property "ssl.KeyManagerFactory.algorithm". If this property is not specified, this method returns "JessieX509".
Returns:
The default key manager factory algorithm's name.

getInstance

public static final KeyManagerFactory getInstance(String algorithm)
            throws NoSuchAlgorithmException
Get an instance of the named key manager factory, from the first provider that implements it.
Parameters:
algorithm - The type of key manager factory to get.
Returns:
An appropriate implementation of that algoritm.

getInstance

public static final KeyManagerFactory getInstance(String algorithm,
                                                  Provider provider)
            throws NoSuchAlgorithmException
Get an instance of the named key manager factory, from the given provider.
Parameters:
algorithm - The type of key manager factory to get.
provider - The provider to get the implementation from.
Returns:
An appropriate implementation of that algorithm.

getInstance

public static final KeyManagerFactory getInstance(String algorithm,
                                                  String provider)
            throws NoSuchAlgorithmException,
                   NoSuchProviderException
Get an instance of the named key manager factory, from the named provider.
Parameters:
algorithm - The type of key manager factory to get.
provider - The name of the provider to get the implementation from.
Returns:
An appropriate implementation of that algorithm.

getKeyManagers

public final KeyManager[] getKeyManagers()
Get an array of key managers appropriate for this algorithm, with the most preferred manager first.
Returns:
The array of key managers.

getProvider

public final Provider getProvider()
Returns the provider of this implementation.
Returns:
The provider of this implementation.

init

public final void init(KeyStore store,
                       char[] passwd)
            throws KeyStoreException,
                   NoSuchAlgorithmException,
                   UnrecoverableKeyException
Initialize this instance with a key store and a password for private key entries.
Parameters:
store - The key store to read.
passwd - The password protecting private keys in the store.

init

public final void init(ManagerFactoryParameters params)
            throws InvalidAlgorithmParameterException
Initialize this instance with an implementation-dependent parameter object.
Parameters:
params - The parameters to initialize with.