org.opends.server.core

Class PasswordStorageSchemeConfigManager

java.lang.Object

org.opends.server.core.PasswordStorageSchemeConfigManager

All Implemented Interfaces:

ConfigurationAddListener<PasswordStorageSchemeCfg>, ConfigurationChangeListener<PasswordStorageSchemeCfg>, ConfigurationDeleteListener<PasswordStorageSchemeCfg>

public class PasswordStorageSchemeConfigManager
extends Object
implements ConfigurationChangeListener<PasswordStorageSchemeCfg>, ConfigurationAddListener<PasswordStorageSchemeCfg>, ConfigurationDeleteListener<PasswordStorageSchemeCfg>

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

Constructor Summary

Constructors

Constructor and Description
PasswordStorageSchemeConfigManager(ServerContext serverContext) Creates a new instance of this password storage scheme config manager.

Method Summary

Methods

Modifier and Type	Method and Description
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationAdd(PasswordStorageSchemeCfg configuration) Adds a new configuration to this add listener.
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(PasswordStorageSchemeCfg configuration) Applies the configuration changes to this change listener.
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationDelete(PasswordStorageSchemeCfg configuration) Deletes an existing configuration from this delete listener.
void	initializePasswordStorageSchemes() Initializes all password storage schemes currently defined in the Directory Server configuration.
boolean	isConfigurationAddAcceptable(PasswordStorageSchemeCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed addition of a new configuration is acceptable to this add listener.
boolean	isConfigurationChangeAcceptable(PasswordStorageSchemeCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed change to the configuration is acceptable to this change listener.
boolean	isConfigurationDeleteAcceptable(PasswordStorageSchemeCfg 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

PasswordStorageSchemeConfigManager

public PasswordStorageSchemeConfigManager(ServerContext serverContext)

Creates a new instance of this password storage scheme config manager.

Parameters:

serverContext - The server context.

Method Detail

initializePasswordStorageSchemes

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

Initializes all password storage schemes 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 password storage scheme initialization process to fail.

InitializationException - If a problem occurs while initializing the password storage scheme that is not related to the server configuration.

isConfigurationChangeAcceptable

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

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

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<PasswordStorageSchemeCfg>

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(PasswordStorageSchemeCfg configuration)

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<PasswordStorageSchemeCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.

isConfigurationAddAcceptable

public boolean isConfigurationAddAcceptable(PasswordStorageSchemeCfg 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<PasswordStorageSchemeCfg>

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(PasswordStorageSchemeCfg configuration)

Adds a new configuration to this add listener.

Specified by:

applyConfigurationAdd in interface ConfigurationAddListener<PasswordStorageSchemeCfg>

Parameters:

configuration - The configuration that will be added.

Returns:

Returns information about the result of adding the configuration.

isConfigurationDeleteAcceptable

public boolean isConfigurationDeleteAcceptable(PasswordStorageSchemeCfg 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<PasswordStorageSchemeCfg>

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(PasswordStorageSchemeCfg configuration)

Deletes an existing configuration from this delete listener.

Specified by:

applyConfigurationDelete in interface ConfigurationDeleteListener<PasswordStorageSchemeCfg>

Parameters:

configuration - The existing configuration that will be deleted.

Returns:

Returns information about the result of deleting the configuration.