Package org.apache.directory.api.ldap.model.schema

Class MatchingRule

  • All Implemented Interfaces:
    Serializable, SchemaObject
    public class MatchingRule
extends AbstractSchemaObject
    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.
    Author:
    Apache Directory Project
    See Also:
    RFC 2252 Section 4.5, ldapbis [MODELS], Serialized Form