org.apache.directory.shared.ldap.schema
Interface MatchingRuleUse

All Superinterfaces:

SchemaObject, java.io.Serializable

public interface MatchingRuleUse
extends SchemaObject

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.
 

Version:

$Rev: 437007 $

Author:

Apache Directory Project

See Also:

ldapbis [MODELS], ldapbis [SYNTAXES]

Method Summary

AttributeType[]	getApplicableAttributes() Gets the the attributes which can be used with the matching rule in an extensible match assertion.
MatchingRule	getMatchingRule() Gets the matchingRule this MatchingRuleUse definition applies to.

Methods inherited from interface org.apache.directory.shared.ldap.schema.SchemaObject

getDescription, getName, getNamesRef, getOid, getSchema, isObsolete, setSchema

Method Detail

getMatchingRule

MatchingRule getMatchingRule()
                             throws javax.naming.NamingException

Gets the matchingRule this MatchingRuleUse definition applies to.

Returns:

the matchingRule

Throws:

javax.naming.NamingException - if there is a failure resolving the object

getApplicableAttributes

AttributeType[] getApplicableAttributes()
                                        throws javax.naming.NamingException

Gets the the attributes which can be used with the matching rule in an extensible match assertion.

Returns:

the applicable attributes

Throws:

javax.naming.NamingException - if there is a failure resolving the object