|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.MatchingRule<T>
T
- The type of configuration handled by this matching
rule.@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=true, mayInvoke=false) public abstract class MatchingRule<T extends MatchingRuleCfg>
This class defines the set of methods and structures that must be implemented by a Directory Server module that implements a matching rule.
Constructor Summary | |
---|---|
MatchingRule()
|
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o)
Indicates whether the provided object is equal to this matching rule. |
void |
finalizeMatchingRule()
Performs any finalization that may be needed whenever this matching rule is taken out of service. |
abstract java.lang.String |
getDescription()
Retrieves the description for this matching rule. |
abstract java.lang.String |
getName()
Retrieves the common name for this matching rule. |
java.lang.String |
getNameOrOID()
Retrieves the name or OID for this matching rule. |
abstract java.lang.String |
getOID()
Retrieves the OID for this matching rule. |
abstract java.lang.String |
getSyntaxOID()
Retrieves the OID of the syntax with which this matching rule is associated. |
int |
hashCode()
Retrieves the hash code for this matching rule. |
abstract void |
initializeMatchingRule(T configuration)
Initializes this matching rule based on the information in the provided configuration entry. |
boolean |
isConfigurationAcceptable(MatchingRuleCfg configuration,
java.util.List<Message> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this matching rule. |
boolean |
isObsolete()
Indicates whether this matching rule is declared "OBSOLETE". |
abstract ByteString |
normalizeValue(ByteString value)
Retrieves the normalized form of the provided value, which is best suite for efficiently performing matching operations on that value. |
java.lang.String |
toString()
Retrieves a string representation of this matching rule in the format defined in RFC 2252. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this matching rule in the format defined in RFC 2252 to the provided buffer. |
abstract ConditionResult |
valuesMatch(ByteString attributeValue,
ByteString assertionValue)
Indicates whether the provided attribute value should be considered a match for the given assertion value. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public MatchingRule()
Method Detail |
---|
public abstract void initializeMatchingRule(T configuration) throws ConfigException, InitializationException
configuration
- The configuration to use to intialize this
matching rule.
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.public boolean isConfigurationAcceptable(MatchingRuleCfg configuration, java.util.List<Message> unacceptableReasons)
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.
true
if the provided configuration is acceptable
for this matching rule, or false
if not.public void finalizeMatchingRule()
public abstract java.lang.String getName()
null
if it does not have a name.public abstract java.lang.String getOID()
public final java.lang.String getNameOrOID()
public abstract java.lang.String getDescription()
null
if there is none.public abstract java.lang.String getSyntaxOID()
public boolean isObsolete()
false
. If
that is not acceptable for a particular matching rule
implementation, then it should override this method and perform
the appropriate processing to return the correct value.
true
if this matching rule is declared
"OBSOLETE", or false
if not.public abstract ByteString normalizeValue(ByteString value) throws DirectoryException
value
- The value to be normalized.
DirectoryException
- If the provided value is invalid
according to the associated
attribute syntax.public abstract ConditionResult valuesMatch(ByteString attributeValue, ByteString assertionValue)
attributeValue
- The attribute value in a form that has
been normalized according to this
matching rule.assertionValue
- The assertion value in a form that has
been normalized according to this
matching rule.
TRUE
if the attribute value should be considered
a match for the provided assertion value, FALSE
if it does not match, or UNDEFINED
if the result
is undefined.public final int hashCode()
hashCode
in class java.lang.Object
public final boolean equals(java.lang.Object o)
equals
in class java.lang.Object
o
- The object for which to make the determination.
true
if the provided object is equal to this
matching rule, or false
if it is not.public final java.lang.String toString()
toString
in class java.lang.Object
public final void toString(java.lang.StringBuilder buffer)
buffer
- The buffer to which the information should be
appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |