org.opends.server.core

Class CoreConfigManager

java.lang.Object

org.opends.server.core.CoreConfigManager

All Implemented Interfaces:

ConfigurationChangeListener<GlobalCfg>

public class CoreConfigManager
extends Object
implements ConfigurationChangeListener<GlobalCfg>

This class defines a utility that will be used to manage the set of core configuration attributes defined in the Directory Server. These configuration attributes appear in the "cn=config" configuration entry.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(GlobalCfg configuration) Applies the configuration changes to this change listener.
void	initializeCoreConfig() Initializes the Directory Server's core configuration.
boolean	isConfigurationChangeAcceptable(GlobalCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed change to the configuration is acceptable to this change listener.

Methods inherited from class java.lang.Object

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

Constructor Detail

CoreConfigManager

public CoreConfigManager(ServerContext serverContext)

Creates a new instance of this core config manager.

Parameters:

serverContext - The server context.

Method Detail

initializeCoreConfig

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

Initializes the Directory Server's core configuration. This should only be called at server startup.

Throws:

org.forgerock.opendj.config.server.ConfigException - If a configuration problem causes the identity mapper initialization process to fail.

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

isConfigurationChangeAcceptable

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

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

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<GlobalCfg>

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

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<GlobalCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.