org.opends.server.core

Class KeyManagerProviderConfigManager

java.lang.Object

org.opends.server.core.KeyManagerProviderConfigManager

All Implemented Interfaces:

ConfigurationAddListener<KeyManagerProviderCfg>, ConfigurationChangeListener<KeyManagerProviderCfg>, ConfigurationDeleteListener<KeyManagerProviderCfg>

public class KeyManagerProviderConfigManager
extends Object
implements ConfigurationChangeListener<KeyManagerProviderCfg>, ConfigurationAddListener<KeyManagerProviderCfg>, ConfigurationDeleteListener<KeyManagerProviderCfg>

This class defines a utility that will be used to manage the set of key manager providers defined in the Directory Server. It will initialize the key manager providers when the server starts, and then will manage any additions, removals, or modifications to any key manager providers while the server is running.

Constructor Summary

Constructors

Constructor and Description
KeyManagerProviderConfigManager(ServerContext serverContext) Creates a new instance of this key manager provider config manager.

Method Summary

Methods

Modifier and Type	Method and Description
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationAdd(KeyManagerProviderCfg configuration) Adds a new configuration to this add listener.
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(KeyManagerProviderCfg configuration) Applies the configuration changes to this change listener.
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationDelete(KeyManagerProviderCfg configuration) Deletes an existing configuration from this delete listener.
void	initializeKeyManagerProviders() Initializes all key manager providers currently defined in the Directory Server configuration.
boolean	isConfigurationAddAcceptable(KeyManagerProviderCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed addition of a new configuration is acceptable to this add listener.
boolean	isConfigurationChangeAcceptable(KeyManagerProviderCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed change to the configuration is acceptable to this change listener.
boolean	isConfigurationDeleteAcceptable(KeyManagerProviderCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed deletion of an existing configuration is acceptable to this delete listener.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyManagerProviderConfigManager

public KeyManagerProviderConfigManager(ServerContext serverContext)

Creates a new instance of this key manager provider config manager.

Parameters:

serverContext - The server context.

Method Detail

initializeKeyManagerProviders

public void initializeKeyManagerProviders()
                                   throws org.forgerock.opendj.config.server.ConfigException,
                                          InitializationException

Initializes all key manager providers currently defined in the Directory Server configuration. This should only be called at Directory Server startup.

Throws:

org.forgerock.opendj.config.server.ConfigException - If a configuration problem causes the key manager provider initialization process to fail.

InitializationException - If a problem occurs while initializing the key manager providers that is not related to the server configuration.

isConfigurationAddAcceptable

public boolean isConfigurationAddAcceptable(KeyManagerProviderCfg configuration,
                                   List<LocalizableMessage> unacceptableReasons)

Indicates whether the proposed addition of a new configuration is acceptable to this add listener.

Specified by:

isConfigurationAddAcceptable in interface ConfigurationAddListener<KeyManagerProviderCfg>

Parameters:

configuration - The configuration that will be added.

unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.

Returns:

Returns true if the proposed addition is acceptable, or false if it is not.

applyConfigurationAdd

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationAdd(KeyManagerProviderCfg configuration)

Adds a new configuration to this add listener.

Specified by:

applyConfigurationAdd in interface ConfigurationAddListener<KeyManagerProviderCfg>

Parameters:

configuration - The configuration that will be added.

Returns:

Returns information about the result of adding the configuration.

isConfigurationDeleteAcceptable

public boolean isConfigurationDeleteAcceptable(KeyManagerProviderCfg configuration,
                                      List<LocalizableMessage> unacceptableReasons)

Indicates whether the proposed deletion of an existing configuration is acceptable to this delete listener.

Specified by:

isConfigurationDeleteAcceptable in interface ConfigurationDeleteListener<KeyManagerProviderCfg>

Parameters:

configuration - The configuration that will be deleted.

unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.

Returns:

Returns true if the proposed deletion is acceptable, or false if it is not.

applyConfigurationDelete

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationDelete(KeyManagerProviderCfg configuration)

Deletes an existing configuration from this delete listener.

Specified by:

applyConfigurationDelete in interface ConfigurationDeleteListener<KeyManagerProviderCfg>

Parameters:

configuration - The existing configuration that will be deleted.

Returns:

Returns information about the result of deleting the configuration.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(KeyManagerProviderCfg configuration,
                                      List<LocalizableMessage> unacceptableReasons)

Indicates whether the proposed change to the configuration is acceptable to this change listener.

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<KeyManagerProviderCfg>

Parameters:

configuration - The new configuration containing the changes.

unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.

Returns:

Returns true if the proposed change is acceptable, or false if it is not.

applyConfigurationChange

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(KeyManagerProviderCfg configuration)

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<KeyManagerProviderCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.