org.opends.server.core

Class MatchingRuleConfigManager

java.lang.Object

org.opends.server.core.MatchingRuleConfigManager

All Implemented Interfaces:

ConfigurationAddListener<MatchingRuleCfg>, ConfigurationChangeListener<MatchingRuleCfg>, ConfigurationDeleteListener<MatchingRuleCfg>

public class MatchingRuleConfigManager
extends Object
implements ConfigurationChangeListener<MatchingRuleCfg>, ConfigurationAddListener<MatchingRuleCfg>, ConfigurationDeleteListener<MatchingRuleCfg>

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

Constructor Summary

Constructors

Constructor and Description
MatchingRuleConfigManager(ServerContext serverContext) Creates a new instance of this matching rule config manager.

Method Summary

Methods

Modifier and Type	Method and Description
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationAdd(MatchingRuleCfg configuration) Adds a new configuration to this add listener.
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(MatchingRuleCfg configuration) Applies the configuration changes to this change listener.
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationDelete(MatchingRuleCfg configuration) Deletes an existing configuration from this delete listener.
void	initializeMatchingRules() Initializes all matching rules after reading all the Matching Rule factories currently defined in the Directory Server configuration.
boolean	isConfigurationAddAcceptable(MatchingRuleCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed addition of a new configuration is acceptable to this add listener.
boolean	isConfigurationChangeAcceptable(MatchingRuleCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed change to the configuration is acceptable to this change listener.
boolean	isConfigurationDeleteAcceptable(MatchingRuleCfg 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

MatchingRuleConfigManager

public MatchingRuleConfigManager(ServerContext serverContext)

Creates a new instance of this matching rule config manager.

Parameters:

serverContext - The server context.

Method Detail

initializeMatchingRules

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

Initializes all matching rules after reading all the Matching Rule factories currently defined in the Directory Server configuration. This should only be called at Directory Server startup.

Throws:

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

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

isConfigurationAddAcceptable

public boolean isConfigurationAddAcceptable(MatchingRuleCfg configuration,
                                   List<LocalizableMessage> unacceptableReasons)

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

Specified by:

isConfigurationAddAcceptable in interface ConfigurationAddListener<MatchingRuleCfg>

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 org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationAdd(MatchingRuleCfg configuration)

Adds a new configuration to this add listener.

Specified by:

applyConfigurationAdd in interface ConfigurationAddListener<MatchingRuleCfg>

Parameters:

configuration - The configuration that will be added.

Returns:

Returns information about the result of adding the configuration.

isConfigurationDeleteAcceptable

public boolean isConfigurationDeleteAcceptable(MatchingRuleCfg configuration,
                                      List<LocalizableMessage> unacceptableReasons)

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

Specified by:

isConfigurationDeleteAcceptable in interface ConfigurationDeleteListener<MatchingRuleCfg>

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 org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationDelete(MatchingRuleCfg configuration)

Deletes an existing configuration from this delete listener.

Specified by:

applyConfigurationDelete in interface ConfigurationDeleteListener<MatchingRuleCfg>

Parameters:

configuration - The existing configuration that will be deleted.

Returns:

Returns information about the result of deleting the configuration.

isConfigurationChangeAcceptable

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

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

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<MatchingRuleCfg>

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

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<MatchingRuleCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.