org.opends.server.core

Class SASLConfigManager

java.lang.Object

org.opends.server.core.SASLConfigManager

All Implemented Interfaces:

ConfigurationAddListener<SaslMechanismHandlerCfg>, ConfigurationChangeListener<SaslMechanismHandlerCfg>, ConfigurationDeleteListener<SaslMechanismHandlerCfg>

public class SASLConfigManager
extends Object
implements ConfigurationChangeListener<SaslMechanismHandlerCfg>, ConfigurationAddListener<SaslMechanismHandlerCfg>, ConfigurationDeleteListener<SaslMechanismHandlerCfg>

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

Constructor Summary

Constructors

Constructor and Description
SASLConfigManager(ServerContext serverContext) Creates a new instance of this SASL mechanism handler config manager.

Method Summary

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

SASLConfigManager

public SASLConfigManager(ServerContext serverContext)

Creates a new instance of this SASL mechanism handler config manager.

Parameters:

serverContext - The server context.

Method Detail

initializeSASLMechanismHandlers

public void initializeSASLMechanismHandlers()
                                     throws ConfigException

Initializes all SASL mechanism handlers currently defined in the Directory Server configuration. This should only be called at Directory Server startup.

Throws:

ConfigException - If a configuration problem causes the SASL mechanism handler initialization process to fail.

isConfigurationAddAcceptable

public boolean isConfigurationAddAcceptable(SaslMechanismHandlerCfg configuration,
                                            List<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<SaslMechanismHandlerCfg>

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

Description copied from interface: ConfigurationAddListener

Adds a new configuration to this add listener.

Specified by:

applyConfigurationAdd in interface ConfigurationAddListener<SaslMechanismHandlerCfg>

Parameters:

configuration - The configuration that will be added.

Returns:

Returns information about the result of adding the configuration.

isConfigurationDeleteAcceptable

public boolean isConfigurationDeleteAcceptable(SaslMechanismHandlerCfg configuration,
                                               List<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<SaslMechanismHandlerCfg>

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

Description copied from interface: ConfigurationDeleteListener

Deletes an existing configuration from this delete listener.

Specified by:

applyConfigurationDelete in interface ConfigurationDeleteListener<SaslMechanismHandlerCfg>

Parameters:

configuration - The existing configuration that will be deleted.

Returns:

Returns information about the result of deleting the configuration.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(SaslMechanismHandlerCfg configuration,
                                               List<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<SaslMechanismHandlerCfg>

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

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<SaslMechanismHandlerCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.