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

Class MatchingRuleUse

  • All Implemented Interfaces:
    Serializable, SchemaObject
    public class MatchingRuleUse
extends AbstractSchemaObject
    Represents an LDAP MatchingRuleUseDescription defined in RFC 2252.

    According to ldapbis [MODELS]: 

      Values of the matchingRuleUse list the attributes which are suitable
  for use with an extensible matching rule.
 
    Matching rule use descriptions are written according to the following
    ABNF:
 
      MatchingRuleUseDescription = LPAREN WSP
          numericoid                ; object identifier
          [ SP "NAME" SP qdescrs ]  ; short names (descriptors)
          [ SP "DESC" SP qdstring ] ; description
          [ SP "OBSOLETE" ]         ; not active
          SP "APPLIES" SP oids      ; attribute types
          extensions WSP RPAREN     ; extensions
 
    where:
      [numericoid] is the object identifier of the matching rule
          associated with this matching rule use description;
      NAME [qdescrs] are short names (descriptors) identifying this
          matching rule use;
      DESC [qdstring] is a short descriptive string;
      OBSOLETE indicates this matching rule use is not active;
      APPLIES provides a list of attribute types the matching rule applies
          to; and
      [extensions] describe extensions.
 
  The matchingRule within the MatchingRuleUse definition can be used by an
  extensible match assertion if the assertion is based on the attributes
  listed within the MatchingRuleUse definition.  If an extensible match
  assertion is based on attributes other than those listed within the
  MatchingRuleUse definition then the assertion is deemed undefined.
 
  Also according to 3.3.20 of [SYNTAXES] (ldapbis working group):
 
  A value of the Matching Rule Use Description syntax indicates the
  attribute types to which a matching rule may be applied in an
  extensibleMatch search filter [PROT].  The LDAP-specific encoding of
  a value of this syntax is defined by the <MatchingRuleUseDescription>
  rule in [MODELS] above.
    Author:
    Apache Directory Project
    See Also:
    ldapbis [MODELS], ldapbis [SYNTAXES], Serialized Form

    • Field Detail

      • serialVersionUID

        public static final long serialVersionUID
        The mandatory serialVersionUID
        See Also:
        Constant Field Values

    • Constructor Detail

      • MatchingRuleUse

        public MatchingRuleUse​(String oid)
        Creates a new instance of MatchingRuleUseDescription
        Parameters:
        oid - the MatchingRuleUse's OID

    • Method Detail

      • getApplicableAttributeOids

        public List<String> getApplicableAttributeOids()
        Returns:
        The matchingRule's list of AttributeType OIDs the MRU applies to

      • getApplicableAttributes

        public List<AttributeType> getApplicableAttributes()
        Returns:
        The matchingRule's list of AttributeType OIDs the MRU applies to

      • setApplicableAttributeOids

        public void setApplicableAttributeOids​(List<String> applicableAttributeOids)
        Set the matchingRule's AttributeType OIDs the MRU applies to.
        Parameters:
        applicableAttributeOids - The AttributeType OIDs list

      • setApplicableAttributes

        public void setApplicableAttributes​(List<AttributeType> applicableAttributes)
        Set the matchingRule's AttributeType the MRU applies to.
        Parameters:
        applicableAttributes - The AttributeType list

      • addApplicableAttributeOids

        public void addApplicableAttributeOids​(String oid)
        Add a matchingRule's AttributeType OIDs the MRU applies to.
        Parameters:
        oid - A matchingRule's AttributeType OIDs the MRU applies to

      • addApplicableAttribute

        public void addApplicableAttribute​(AttributeType attributeType)
        Add a matchingRule's AttributeType the MRU applies to.
        Parameters:
        attributeType - A matchingRule's AttributeType the MRU applies to

      • copy

        public MatchingRuleUse copy()
        Copy an MatchingRuleUse
        Returns:
        The copied SchemaObject

      • clear

        public void clear()
        Clear the current SchemaObject : remove all the references to other objects, and all the Maps.
        Specified by:
        clear in interface SchemaObject
        Overrides:
        clear in class AbstractSchemaObject