org.opends.server.extensions

Class NullKeyManagerProvider

java.lang.Object

org.opends.server.api.KeyManagerProvider<KeyManagerProviderCfg>

org.opends.server.extensions.NullKeyManagerProvider

public class NullKeyManagerProvider
extends KeyManagerProvider<KeyManagerProviderCfg>

This class provides an implementation of a key manager provider that does not actually have the ability to provide a key manager. It will be used when no other key manager provider has been defined in the server configuration.

Constructor Summary

Constructors

Constructor and Description
NullKeyManagerProvider() Creates a new instance of this null key manager provider.

Method Summary

Methods

Modifier and Type	Method and Description
void	finalizeKeyManagerProvider() Performs any finalization that may be necessary for this key manager provider.
KeyManager[]	getKeyManagers() Retrieves a KeyManager object that may be used for interactions requiring access to a key manager.
void	initializeKeyManagerProvider(KeyManagerProviderCfg configuration) Initializes this key manager provider based on the information in the provided key manager provider configuration.

Methods inherited from class org.opends.server.api.KeyManagerProvider

containsAtLeastOneKey, containsKeyWithAlias, isConfigurationAcceptable

Methods inherited from class java.lang.Object

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

Constructor Detail

NullKeyManagerProvider

public NullKeyManagerProvider()

Creates a new instance of this null key manager provider. The initializeKeyManagerProvider method must be called on the resulting object before it may be used.

Method Detail

initializeKeyManagerProvider

public void initializeKeyManagerProvider(KeyManagerProviderCfg configuration)
                                  throws org.forgerock.opendj.config.server.ConfigException,
                                         InitializationException

Initializes this key manager provider based on the information in the provided key manager provider configuration.

Specified by:

initializeKeyManagerProvider in class KeyManagerProvider<KeyManagerProviderCfg>

Parameters:

configuration - The key manager provider configuration that contains the information to use to initialize this key manager provider.

Throws:

org.forgerock.opendj.config.server.ConfigException - If an unrecoverable problem arises in the process of performing the initialization as a result of the server configuration.

InitializationException - If a problem occurs during initialization that is not related to the server configuration.

finalizeKeyManagerProvider

public void finalizeKeyManagerProvider()

Performs any finalization that may be necessary for this key manager provider.

Specified by:

finalizeKeyManagerProvider in class KeyManagerProvider<KeyManagerProviderCfg>

getKeyManagers

public KeyManager[] getKeyManagers()
                            throws DirectoryException

Retrieves a KeyManager object that may be used for interactions requiring access to a key manager.

Specified by:

getKeyManagers in class KeyManagerProvider<KeyManagerProviderCfg>

Returns:

A KeyManager object that may be used for interactions requiring access to a key manager.

Throws:

DirectoryException - If a problem occurs while attempting to obtain the set of key managers.