Package org.opends.server.core

Class ConnectionHandlerConfigManager

java.lang.Object

org.opends.server.core.ConnectionHandlerConfigManager

All Implemented Interfaces:

ConfigurationAddListener<ConnectionHandlerCfg>, ConfigurationChangeListener<ConnectionHandlerCfg>, ConfigurationDeleteListener<ConnectionHandlerCfg>

public class ConnectionHandlerConfigManager
extends Object
implements ConfigurationAddListener<ConnectionHandlerCfg>, ConfigurationDeleteListener<ConnectionHandlerCfg>, ConfigurationChangeListener<ConnectionHandlerCfg>

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

Constructor Summary

Constructors

Constructor	Description
ConnectionHandlerConfigManager(ServerContext serverContext)	Creates a new instance of this connection handler config manager.

Method Summary

Modifier and Type	Method	Description
ConfigChangeResult	applyConfigurationAdd(ConnectionHandlerCfg configuration)	Adds a new configuration to this add listener.
ConfigChangeResult	applyConfigurationChange(ConnectionHandlerCfg configuration)	Applies the configuration changes to this change listener.
ConfigChangeResult	applyConfigurationDelete(ConnectionHandlerCfg configuration)	Deletes an existing configuration from this delete listener.
void	initializeConnectionHandlerConfig()	Initializes the configuration associated with the Directory Server connection handlers.
boolean	isConfigurationAddAcceptable(ConnectionHandlerCfg configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)	Indicates whether the proposed addition of a new configuration is acceptable to this add listener.
boolean	isConfigurationChangeAcceptable(ConnectionHandlerCfg configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)	Indicates whether the proposed change to the configuration is acceptable to this change listener.
boolean	isConfigurationDeleteAcceptable(ConnectionHandlerCfg configuration, List<org.forgerock.i18n.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

ConnectionHandlerConfigManager

public ConnectionHandlerConfigManager(ServerContext serverContext)

Creates a new instance of this connection handler config manager.

Parameters:

serverContext - The server context.

Method Detail

applyConfigurationAdd

public ConfigChangeResult applyConfigurationAdd(ConnectionHandlerCfg configuration)

Description copied from interface: ConfigurationAddListener

Adds a new configuration to this add listener.

Specified by:

applyConfigurationAdd in interface ConfigurationAddListener<ConnectionHandlerCfg>

Parameters:

configuration - The configuration that will be added.

Returns:

Returns information about the result of adding the configuration.

applyConfigurationChange

public ConfigChangeResult applyConfigurationChange(ConnectionHandlerCfg configuration)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<ConnectionHandlerCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.

applyConfigurationDelete

public ConfigChangeResult applyConfigurationDelete(ConnectionHandlerCfg configuration)

Description copied from interface: ConfigurationDeleteListener

Deletes an existing configuration from this delete listener.

Specified by:

applyConfigurationDelete in interface ConfigurationDeleteListener<ConnectionHandlerCfg>

Parameters:

configuration - The existing configuration that will be deleted.

Returns:

Returns information about the result of deleting the configuration.

initializeConnectionHandlerConfig

public void initializeConnectionHandlerConfig()
                                       throws ConfigException,
                                              InitializationException

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

Throws:

ConfigException - If a critical configuration problem prevents the connection handler initialization from succeeding.

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

isConfigurationAddAcceptable

public boolean isConfigurationAddAcceptable(ConnectionHandlerCfg configuration,
                                            List<org.forgerock.i18n.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<ConnectionHandlerCfg>

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.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(ConnectionHandlerCfg configuration,
                                               List<org.forgerock.i18n.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<ConnectionHandlerCfg>

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.

isConfigurationDeleteAcceptable

public boolean isConfigurationDeleteAcceptable(ConnectionHandlerCfg configuration,
                                               List<org.forgerock.i18n.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<ConnectionHandlerCfg>

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.