org.opends.server.schema

Class CollationMatchingRuleFactory

java.lang.Object

org.opends.server.api.MatchingRuleFactory<CollationMatchingRuleCfg>

org.opends.server.schema.CollationMatchingRuleFactory

All Implemented Interfaces:

ConfigurationChangeListener<CollationMatchingRuleCfg>

public final class CollationMatchingRuleFactory
extends MatchingRuleFactory<CollationMatchingRuleCfg>
implements ConfigurationChangeListener<CollationMatchingRuleCfg>

This class is a factory class for Collation matching rules. It creates different matching rules based on the configuration entries.

Constructor Summary

Constructors

Constructor and Description
CollationMatchingRuleFactory() Creates a new instance of CollationMatchingRuleFactory.

Method Summary

Methods

Modifier and Type	Method and Description
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(CollationMatchingRuleCfg configuration) Applies the configuration changes to this change listener.
void	finalizeMatchingRule() Performs any finalization that may be needed whenever this matching rule factory is taken out of service.
Collection<org.forgerock.opendj.ldap.schema.MatchingRule>	getMatchingRules() Returns an umodifiable view of Collection of associated MatchingRules.
void	initializeMatchingRule(CollationMatchingRuleCfg configuration) Initializes the matching rule(s) based on the information in the provided configuration entry.
boolean	isConfigurationChangeAcceptable(CollationMatchingRuleCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed change to the configuration is acceptable to this change listener.

Methods inherited from class org.opends.server.api.MatchingRuleFactory

isConfigurationAcceptable

Methods inherited from class java.lang.Object

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

Constructor Detail

CollationMatchingRuleFactory

public CollationMatchingRuleFactory()

Creates a new instance of CollationMatchingRuleFactory.

Method Detail

getMatchingRules

public final Collection<org.forgerock.opendj.ldap.schema.MatchingRule> getMatchingRules()

Returns an umodifiable view of Collection of associated MatchingRules.

Specified by:

getMatchingRules in class MatchingRuleFactory<CollationMatchingRuleCfg>

Returns:

An unmodifiable view of Collection of MatchingRule instances.

initializeMatchingRule

public void initializeMatchingRule(CollationMatchingRuleCfg configuration)
                            throws org.forgerock.opendj.config.server.ConfigException,
                                   InitializationException

Initializes the matching rule(s) based on the information in the provided configuration entry.

Specified by:

initializeMatchingRule in class MatchingRuleFactory<CollationMatchingRuleCfg>

Parameters:

configuration - The configuration to use to intialize this matching rule.

Throws:

org.forgerock.opendj.config.server.ConfigException - If an unrecoverable problem arises in the process of performing the initialization.

InitializationException - If a problem that is not configuration-related occurs during initialization.

finalizeMatchingRule

public void finalizeMatchingRule()

Performs any finalization that may be needed whenever this matching rule factory is taken out of service.

Overrides:

finalizeMatchingRule in class MatchingRuleFactory<CollationMatchingRuleCfg>

applyConfigurationChange

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(CollationMatchingRuleCfg configuration)

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<CollationMatchingRuleCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.

isConfigurationChangeAcceptable

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

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

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<CollationMatchingRuleCfg>

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.