org.opends.server.core

Class BackendConfigManager

java.lang.Object

org.opends.server.core.BackendConfigManager

All Implemented Interfaces:

ConfigurationAddListener<BackendCfg>, ConfigurationChangeListener<BackendCfg>, ConfigurationDeleteListener<BackendCfg>

public class BackendConfigManager
extends Object
implements ConfigurationChangeListener<BackendCfg>, ConfigurationAddListener<BackendCfg>, ConfigurationDeleteListener<BackendCfg>

This class defines a utility that will be used to manage the configuration for the set of backends defined in the Directory Server. It will perform the necessary initialization of those backends when the server is first started, and then will manage any changes to them while the server is running.

Constructor Summary

Constructors

Constructor and Description
BackendConfigManager(ServerContext serverContext) Creates a new instance of this backend config manager.

Method Summary

Methods

Modifier and Type	Method and Description
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationAdd(BackendCfg cfg) Adds a new configuration to this add listener.
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(BackendCfg cfg) Applies the configuration changes to this change listener.
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationDelete(BackendCfg configEntry) Deletes an existing configuration from this delete listener.
void	initializeBackendConfig() Initializes the configuration associated with the Directory Server backends.
boolean	isConfigurationAddAcceptable(BackendCfg configEntry, List<LocalizableMessage> unacceptableReason) Indicates whether the proposed addition of a new configuration is acceptable to this add listener.
boolean	isConfigurationChangeAcceptable(BackendCfg configEntry, List<LocalizableMessage> unacceptableReason) Indicates whether the proposed change to the configuration is acceptable to this change listener.
boolean	isConfigurationDeleteAcceptable(BackendCfg configEntry, List<LocalizableMessage> unacceptableReason) 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

BackendConfigManager

public BackendConfigManager(ServerContext serverContext)

Creates a new instance of this backend config manager.

Parameters:

serverContext - The server context.

Method Detail

initializeBackendConfig

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

Initializes the configuration associated with the Directory Server backends. This should only be called at Directory Server startup.

Throws:

org.forgerock.opendj.config.server.ConfigException - If a critical configuration problem prevents the backend initialization from succeeding.

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

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(BackendCfg configEntry,
                                      List<LocalizableMessage> unacceptableReason)

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

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<BackendCfg>

Parameters:

configEntry - The new configuration containing the changes.

unacceptableReason - 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(BackendCfg cfg)

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<BackendCfg>

Parameters:

cfg - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.

isConfigurationAddAcceptable

public boolean isConfigurationAddAcceptable(BackendCfg configEntry,
                                   List<LocalizableMessage> unacceptableReason)

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

Specified by:

isConfigurationAddAcceptable in interface ConfigurationAddListener<BackendCfg>

Parameters:

configEntry - The configuration that will be added.

unacceptableReason - 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(BackendCfg cfg)

Adds a new configuration to this add listener.

Specified by:

applyConfigurationAdd in interface ConfigurationAddListener<BackendCfg>

Parameters:

cfg - The configuration that will be added.

Returns:

Returns information about the result of adding the configuration.

isConfigurationDeleteAcceptable

public boolean isConfigurationDeleteAcceptable(BackendCfg configEntry,
                                      List<LocalizableMessage> unacceptableReason)

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

Specified by:

isConfigurationDeleteAcceptable in interface ConfigurationDeleteListener<BackendCfg>

Parameters:

configEntry - The configuration that will be deleted.

unacceptableReason - 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(BackendCfg configEntry)

Deletes an existing configuration from this delete listener.

Specified by:

applyConfigurationDelete in interface ConfigurationDeleteListener<BackendCfg>

Parameters:

configEntry - The existing configuration that will be deleted.

Returns:

Returns information about the result of deleting the configuration.