|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.shared.ldap.schema.AbstractSchemaObject
org.apache.directory.shared.ldap.schema.MatchingRule
public class MatchingRule
A matchingRule definition. MatchingRules associate a comparator and a normalizer, forming the basic tools necessary to assert actions against attribute values. MatchingRules are associated with a specific Syntax for the purpose of resolving a normalized form and for comparisons.
According to ldapbis [MODELS]:
4.1.3. Matching Rules Matching rules are used by servers to compare attribute values against assertion values when performing Search and Compare operations. They are also used to identify the value to be added or deleted when modifying entries, and are used when comparing a purported distinguished name with the name of an entry. A matching rule specifies the syntax of the assertion value. Each matching rule is identified by an object identifier (OID) and, optionally, one or more short names (descriptors). Matching rule definitions are written according to the ABNF: MatchingRuleDescription = LPAREN WSP numericoid ; object identifier [ SP "NAME" SP qdescrs ] ; short names (descriptors) [ SP "DESC" SP qdstring ] ; description [ SP "OBSOLETE" ] ; not active SP "SYNTAX" SP numericoid ; assertion syntax extensions WSP RPAREN ; extensions where: [numericoid] is object identifier assigned to this matching rule; NAME [qdescrs] are short names (descriptors) identifying this matching rule; DESC [qdstring] is a short descriptive string; OBSOLETE indicates this matching rule is not active; SYNTAX identifies the assertion syntax by object identifier; and [extensions] describe extensions.
DescriptionUtils.getDescription(MatchingRule)
,
Serialized FormField Summary | |
---|---|
protected LdapComparator<? super java.lang.Object> |
ldapComparator
The associated Comparator |
protected LdapSyntax |
ldapSyntax
The associated LdapSyntax |
protected Normalizer |
normalizer
The associated Normalizer |
Fields inherited from class org.apache.directory.shared.ldap.schema.AbstractSchemaObject |
---|
description, extensions, isEnabled, isObsolete, isReadOnly, locked, names, objectType, oid, schemaName, specification |
Constructor Summary | |
---|---|
MatchingRule(java.lang.String oid)
Creates a new instance of MatchingRule. |
Method Summary | |
---|---|
void |
addToRegistries(java.util.List<java.lang.Throwable> errors,
Registries registries)
Inject the MatchingRule into the registries, updating the references to other SchemaObject |
void |
clear()
Clear the current SchemaObject : remove all the references to other objects, and all the Maps. |
MatchingRule |
copy()
Copy an MatchingRule |
boolean |
equals(java.lang.Object o)
|
LdapComparator<? super java.lang.Object> |
getLdapComparator()
Gets the LdapComparator enabling the use of this MatchingRule for ORDERING and sorted indexing. |
Normalizer |
getNormalizer()
Gets the Normalizer enabling the use of this MatchingRule for EQUALITY matching and indexing. |
LdapSyntax |
getSyntax()
Gets the LdapSyntax used by this MatchingRule. |
java.lang.String |
getSyntaxOid()
Gets the LdapSyntax OID used by this MatchingRule. |
void |
removeFromRegistries(java.util.List<java.lang.Throwable> errors,
Registries registries)
Remove the MatchingRule from the registries, updating the references to other SchemaObject. |
void |
setLdapComparator(LdapComparator<?> ldapComparator)
Sets the LdapComparator |
void |
setNormalizer(Normalizer normalizer)
Sets the Normalizer |
void |
setSyntax(LdapSyntax ldapSyntax)
Sets the Syntax |
void |
setSyntaxOid(java.lang.String oid)
Sets the Syntax's OID |
java.lang.String |
toString()
|
void |
updateLdapComparator(LdapComparator<?> ldapComparator)
Update the associated Comparator, even if the SchemaObject is readOnly |
void |
updateNormalizer(Normalizer normalizer)
Update the associated Normalizer, even if the SchemaObject is readOnly |
void |
updateSyntax(LdapSyntax ldapSyntax)
Update the associated Syntax, even if the SchemaObject is readOnly |
Methods inherited from class org.apache.directory.shared.ldap.schema.AbstractSchemaObject |
---|
addExtension, addName, compareOid, copy, getDescription, getExtensions, getName, getNames, getObjectType, getOid, getSchemaName, getSpecification, hashCode, isDisabled, isEnabled, isObsolete, isReadOnly, lock, registerOid, setDescription, setEnabled, setExtensions, setNames, setNames, setObsolete, setOid, setReadOnly, setRegistries, setSchemaName, setSpecification |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected LdapComparator<? super java.lang.Object> ldapComparator
protected Normalizer normalizer
protected LdapSyntax ldapSyntax
Constructor Detail |
---|
public MatchingRule(java.lang.String oid)
oid
- The MatchingRule OIDregistries
- The Registries referenceMethod Detail |
---|
public void addToRegistries(java.util.List<java.lang.Throwable> errors, Registries registries) throws LdapException
addToRegistries
in interface SchemaObject
addToRegistries
in class AbstractSchemaObject
registries
- The Registrieserrors
- The errors we got
If
- the addition failed
LdapException
public void removeFromRegistries(java.util.List<java.lang.Throwable> errors, Registries registries) throws LdapException
removeFromRegistries
in interface SchemaObject
removeFromRegistries
in class AbstractSchemaObject
registries
- The Registrieserrors
- The errors we got
If
- the MatchingRule is not valid
LdapException
public LdapSyntax getSyntax()
public java.lang.String getSyntaxOid()
NamingException
- if there is a failure resolving the objectpublic void setSyntaxOid(java.lang.String oid)
oid
- The Syntax's OIDpublic void setSyntax(LdapSyntax ldapSyntax)
oid
- The Syntaxpublic void updateSyntax(LdapSyntax ldapSyntax)
oid
- The Syntaxpublic LdapComparator<? super java.lang.Object> getLdapComparator()
NamingException
- if there is a failure resolving the objectpublic void setLdapComparator(LdapComparator<?> ldapComparator)
oid
- The LdapComparatorpublic void updateLdapComparator(LdapComparator<?> ldapComparator)
oid
- The LdapComparatorpublic Normalizer getNormalizer()
NamingException
- if there is a failure resolving the objectpublic void setNormalizer(Normalizer normalizer)
oid
- The Normalizerpublic void updateNormalizer(Normalizer normalizer)
oid
- The Normalizerpublic java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public MatchingRule copy()
copy
in interface SchemaObject
copy
in class AbstractSchemaObject
public boolean equals(java.lang.Object o)
equals
in interface SchemaObject
equals
in class AbstractSchemaObject
Object#equals()
public void clear()
clear
in interface SchemaObject
clear
in class AbstractSchemaObject
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |