KeyManagerFactory (Java Platform SE 6) (original) (raw)

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

KeyManagerFactory

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

Creates a KeyManagerFactory object.

Parameters:

factorySpi - the delegate

provider - the provider

algorithm - the algorithm

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 (set in the Java security properties file or by calling[Security.setProperty(java.lang.String, java.lang.String)](../../../java/security/Security.html#setProperty%28java.lang.String, java.lang.String%29)) to the desired algorithm name.

Returns:

the default algorithm name as specified in the Java security properties, or an implementation-specific default if no such property exists.

See Also:

[Security.setProperty(java.lang.String, java.lang.String)](../../../java/security/Security.html#setProperty%28java.lang.String, java.lang.String%29)

getAlgorithm

public final String getAlgorithm()

Returns the algorithm name of this KeyManagerFactory object.

This is the same name that was specified in one of thegetInstance calls that created thisKeyManagerFactory 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.

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](../../../java/security/NoSuchAlgorithmException.html "class in java.security") - if no Provider supports a KeyManagerFactorySpi implementation for the specified algorithm.

See Also:

Provider

getInstance

public static final KeyManagerFactory getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException

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](../../../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.

[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - if the provider name is null or empty.

See Also:

Provider

getInstance

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

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](../../../java/security/NoSuchAlgorithmException.html "class in java.security") - if a KeyManagerFactorySpi implementation for the specified algorithm is not available from the specified Provider object.

[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - if provider is null.

See Also:

Provider

getProvider

public final Provider getProvider()

Returns the provider of this KeyManagerFactory object.

Returns:

the provider of this KeyManagerFactory object

init

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

For more flexible initialization, please seeinit(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 spec) throws InvalidAlgorithmParameterException

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[] 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

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Scripting on this page tracks web page traffic, but does not change the content in any way.