org.opends.server.core

Class KeyManagerProviderConfigManager

java.lang.Object

org.opends.server.core.KeyManagerProviderConfigManager

All Implemented Interfaces:

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

public final 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.

Method Summary

Modifier and Type	Method and Description
ConfigChangeResult	applyConfigurationAdd(KeyManagerProviderCfg configuration) Adds a new configuration to this add listener.
ConfigChangeResult	applyConfigurationChange(KeyManagerProviderCfg configuration) Applies the configuration changes to this change listener.
ConfigChangeResult	applyConfigurationDelete(KeyManagerProviderCfg configuration) Deletes an existing configuration from this delete listener.
KeyManagerProvider<?>	getKeyManagerProvider(Dn dn) Retrieves the key manager provider registered with the provided entry DN.
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

Method Detail

initializeKeyManagerProviders

public void initializeKeyManagerProviders()
                                   throws ConfigException

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

Throws:

ConfigException - If a configuration problem causes the key manager provider initialization process to fail.

getKeyManagerProvider

public KeyManagerProvider<?> getKeyManagerProvider(Dn dn)

Retrieves the key manager provider registered with the provided entry DN.

Parameters:

dn - The DN with which the key manager provider is registered.

Returns:

The KeyManagerProvider registered with the provided entry Dn, or null if there is no such key manager provider registered with the server.

isConfigurationAddAcceptable

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

Description copied from interface: ConfigurationAddListener

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 ConfigChangeResult applyConfigurationAdd(KeyManagerProviderCfg configuration)

Description copied from interface: ConfigurationAddListener

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)

Description copied from interface: ConfigurationDeleteListener

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 ConfigChangeResult applyConfigurationDelete(KeyManagerProviderCfg configuration)

Description copied from interface: ConfigurationDeleteListener

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)

Description copied from interface: ConfigurationChangeListener

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 ConfigChangeResult applyConfigurationChange(KeyManagerProviderCfg configuration)

Description copied from interface: ConfigurationChangeListener

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.