org.opends.server.api

Class MatchingRuleFactory<T extends MatchingRuleCfg>

java.lang.Object

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

Type Parameters:

T - The type of configuration handled by this matching rule.

Direct Known Subclasses:

AuthPasswordEqualityMatchingRuleFactory, AuthPasswordExactEqualityMatchingRuleFactory, BitStringEqualityMatchingRuleFactory, BooleanEqualityMatchingRuleFactory, CaseExactEqualityMatchingRuleFactory, CaseExactIA5EqualityMatchingRuleFactory, CaseExactIA5SubstringMatchingRuleFactory, CaseExactOrderingMatchingRuleFactory, CaseExactSubstringMatchingRuleFactory, CaseIgnoreEqualityMatchingRuleFactory, CaseIgnoreIA5EqualityMatchingRuleFactory, CaseIgnoreIA5SubstringMatchingRuleFactory, CaseIgnoreListEqualityMatchingRuleFactory, CaseIgnoreListSubstringMatchingRuleFactory, CaseIgnoreOrderingMatchingRuleFactory, CaseIgnoreSubstringMatchingRuleFactory, CertificateExactMatchingRuleFactory, CollationMatchingRuleFactory, DirectoryStringFirstComponentEqualityMatchingRuleFactory, DistinguishedNameEqualityMatchingRuleFactory, DoubleMetaphoneApproximateMatchingRuleFactory, GeneralizedTimeEqualityMatchingRuleFactory, GeneralizedTimeOrderingMatchingRuleFactory, HistoricalCsnOrderingMatchingRuleFactory, IntegerEqualityMatchingRuleFactory, IntegerFirstComponentEqualityMatchingRuleFactory, IntegerOrderingMatchingRuleFactory, KeywordEqualityMatchingRuleFactory, NumericStringEqualityMatchingRuleFactory, NumericStringOrderingMatchingRuleFactory, NumericStringSubstringMatchingRuleFactory, ObjectIdentifierEqualityMatchingRuleFactory, ObjectIdentifierFirstComponentEqualityMatchingRuleFactory, OctetStringEqualityMatchingRuleFactory, OctetStringOrderingMatchingRuleFactory, OctetStringSubstringMatchingRuleFactory, PresentationAddressEqualityMatchingRuleFactory, ProtocolInformationEqualityMatchingRuleFactory, TelephoneNumberEqualityMatchingRuleFactory, TelephoneNumberSubstringMatchingRuleFactory, TimeBasedMatchingRuleFactory, UniqueMemberEqualityMatchingRuleFactory, UserPasswordEqualityMatchingRuleFactory, UserPasswordExactEqualityMatchingRuleFactory, UUIDEqualityMatchingRuleFactory, UUIDOrderingMatchingRuleFactory, WordEqualityMatchingRuleFactory

@PublicAPI(stability=VOLATILE,
           mayInstantiate=false,
           mayExtend=true,
           mayInvoke=false)
public abstract class MatchingRuleFactory<T extends MatchingRuleCfg>
extends Object

This class defines the set of methods and structures that must be implemented by a Directory Server module that implements a matching rule factory.

Constructor Summary

Constructors

Constructor and Description
MatchingRuleFactory()

Method Summary

Methods

Modifier and Type	Method and Description
void	finalizeMatchingRule() Performs any finalization that may be needed whenever this matching rule factory is taken out of service.
abstract Collection<org.forgerock.opendj.ldap.schema.MatchingRule>	getMatchingRules() Returns an umodifiable view of Collection of associated MatchingRules.
abstract void	initializeMatchingRule(T configuration) Initializes the matching rule(s) based on the information in the provided configuration entry.
boolean	isConfigurationAcceptable(T configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the provided configuration is acceptable for this matching rule.

Methods inherited from class java.lang.Object

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

Constructor Detail

MatchingRuleFactory

public MatchingRuleFactory()

Method Detail

initializeMatchingRule

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

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

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.

isConfigurationAcceptable

public boolean isConfigurationAcceptable(T configuration,
                                List<LocalizableMessage> unacceptableReasons)

Indicates whether the provided configuration is acceptable for this matching rule. It should be possible to call this method on an uninitialized matching rule instance in order to determine whether the matching rule would be able to use the provided configuration.

Note that implementations which use a subclass of the provided configuration class will likely need to cast the configuration to the appropriate subclass type.

Parameters:

configuration - The matching rule configuration for which to make the determination.

unacceptableReasons - A list that may be used to hold the reasons that the provided configuration is not acceptable.

Returns:

true if the provided configuration is acceptable for this matching rule, or false if not.

getMatchingRules

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

Returns an umodifiable view of Collection of associated MatchingRules.

Returns:

An unmodifiable view of Collection of MatchingRule instances.