Package netscape.ldap

Class LDAPDITContentRuleSchema

java.lang.Object
netscape.ldap.LDAPSchemaElement
netscape.ldap.LDAPDITContentRuleSchema
All Implemented Interfaces:
Serializable

public class LDAPDITContentRuleSchema extends LDAPSchemaElement
The definition of a DIT content rule in the schema. RFC 2252, Lightweight Directory Access Protocol (v3): DIT Content Rule Description covers the types of information to specify when defining a DIT content rule. According to the RFC, the description of a DIT content rule can include the following:

  • an OID identifying the attribute type
  • a name identifying the attribute type
  • a description of the attribute type
  • the name of the parent attribute type
  • the syntax used by the attribute (for example, cis or int)
  • an indication of whether the attribute type is single-valued or multi-valued

When you construct an LDAPDITContentRuleSchema object, you can specify these types of information as arguments to the constructor or in the AttributeTypeDescription 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 attribute values in this format.

There are a number of additional optional description fields which are not explicitly accessible through LDAPDITContentRuleSchema, but which can be managed with setQualifier, getQualifier, and getQualifierNames:

  • OBSOLETE

To get the name, OID, and description of this DIT content rule , use the getName, getOID, and getDescription methods inherited from the abstract class LDAPSchemaElement. Optional and custom qualifiers are accessed with getQualifier and getQualifierNames from LDAPSchemaElement.

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

RFC 2252 defines DITContentRuleDescription as follows:

    DITContentRuleDescription = "("
        numericoid   ; Structural ObjectClass identifier
        [ "NAME" qdescrs ]
        [ "DESC" qdstring ]
        [ "OBSOLETE" ]
        [ "AUX" oids ]    ; Auxiliary ObjectClasses
        [ "MUST" oids ]   ; AttributeType identifiers
        [ "MAY" oids ]    ; AttributeType identifiers
        [ "NOT" oids ]    ; AttributeType identifiers
       ")"
 
Version:
1.0
See Also: