Package netscape.ldap

Class LDAPMatchingRuleUseSchema

java.lang.Object
All Implemented Interfaces:
Serializable

public class LDAPMatchingRuleUseSchema extends LDAPAttributeSchema
The definition of a matching rule use in the schema. RFC 2252, Lightweight Directory Access Protocol (v3): Attribute Syntax Definitions covers the types of information that need to be specified in the definition of a matching rule use. According to the RFC, the description of a matching rule use can include the following information:

  • an OID identifying the matching rule
  • a name identifying the matching rule use
  • a description of the matching rule use
  • a list of attributes the matching rule applies to

When you construct an LDAPMatchingRuleUseSchema object, you can specify these types of information as arguments to the constructor or in the MatchingRuleUseDescription format specified in RFC 2252. When an LDAP client searches an LDAP server for the schema, the server returns schema information as an object with values in this format.

You can get the name, OID, and description of this matching rule use definition by using the getName, getOID, and getDescription methods inherited from the abstract class LDAPSchemaElement. Custom qualifiers are accessed with getQualifier and getQualifierNames from LDAPSchemaElement.

To add or remove this matching rule definition from the schema, use the add and remove methods, which this class inherits from the LDAPSchemaElement abstract class.

RFC 2252 defines MatchingRuleUseDescription follows:

 Values of the matchingRuleUse list the attributes which are suitable
 for use with an extensible matching rule.

    MatchingRuleUseDescription = "(" whsp
        numericoid whsp  ; MatchingRule identifier
        [ "NAME" qdescrs ]
        [ "DESC" qdstring ]
        [ "OBSOLETE" ]
       "APPLIES" oids    ; AttributeType identifiers
    whsp ")"
 

Version:
1.0
See Also: