Package org.opends.server.core

Class HttpEndpointConfigManager

java.lang.Object

org.opends.server.core.HttpEndpointConfigManager

All Implemented Interfaces:

ConfigurationAddListener<HTTPEndpointCfg>, ConfigurationChangeListener<HTTPEndpointCfg>, ConfigurationDeleteListener<HTTPEndpointCfg>

public class HttpEndpointConfigManager
extends Object
implements ConfigurationChangeListener<HTTPEndpointCfg>, ConfigurationAddListener<HTTPEndpointCfg>, ConfigurationDeleteListener<HTTPEndpointCfg>

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

Constructor Summary

Constructors

Constructor	Description
HttpEndpointConfigManager(ServerContext serverContext)	Creates a new instance of this HTTP endpoint config manager.

Method Summary

Modifier and Type	Method	Description
ConfigChangeResult	applyConfigurationAdd(HTTPEndpointCfg configuration)	Adds a new configuration to this add listener.
ConfigChangeResult	applyConfigurationChange(HTTPEndpointCfg configuration)	Applies the configuration changes to this change listener.
ConfigChangeResult	applyConfigurationDelete(HTTPEndpointCfg configuration)	Deletes an existing configuration from this delete listener.
boolean	isConfigurationAddAcceptable(HTTPEndpointCfg configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)	Indicates whether the proposed addition of a new configuration is acceptable to this add listener.
boolean	isConfigurationChangeAcceptable(HTTPEndpointCfg configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)	Indicates whether the proposed change to the configuration is acceptable to this change listener.
boolean	isConfigurationDeleteAcceptable(HTTPEndpointCfg configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)	Indicates whether the proposed deletion of an existing configuration is acceptable to this delete listener.
void	registerTo(RootCfg rootConfiguration)	Initializes all HTTP endpoints currently defined in the Directory Server configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpEndpointConfigManager

public HttpEndpointConfigManager(ServerContext serverContext)

Creates a new instance of this HTTP endpoint config manager.

Parameters:

serverContext - The server context.

Method Detail

registerTo

public void registerTo(RootCfg rootConfiguration)
                throws ConfigException

Initializes all HTTP endpoints currently defined in the Directory Server configuration. This should only be called at Directory Server startup.

Parameters:

rootConfiguration - The root configuration containing the HttpEndpoint configurations.

Throws:

ConfigException - If a configuration problem causes the HttpEndpoint initialization process to fail.

isConfigurationAddAcceptable

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

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

Description copied from interface: ConfigurationAddListener

Adds a new configuration to this add listener.

Specified by:

applyConfigurationAdd in interface ConfigurationAddListener<HTTPEndpointCfg>

Parameters:

configuration - The configuration that will be added.

Returns:

Returns information about the result of adding the configuration.

isConfigurationDeleteAcceptable

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

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

Description copied from interface: ConfigurationDeleteListener

Deletes an existing configuration from this delete listener.

Specified by:

applyConfigurationDelete in interface ConfigurationDeleteListener<HTTPEndpointCfg>

Parameters:

configuration - The existing configuration that will be deleted.

Returns:

Returns information about the result of deleting the configuration.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(HTTPEndpointCfg 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<HTTPEndpointCfg>

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

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<HTTPEndpointCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.