Package netscape.ldap

Class LDAPSyntaxSchema

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

public class LDAPSyntaxSchema extends LDAPSchemaElement
The definition of a syntax type in the schema. RFC 2252, Lightweight Directory Access Protocol (v3): LDAP Subschema Attribute covers the types of information to specify when defining a syntax. The description of a syntax can include the following:

  • an OID identifying the syntax
  • a description of the attribute type

When you construct an LDAPSyntaxSchema object, you can specify these types of information as arguments to the constructor or in the ldapSyntaxes 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.

RFC 2252 defines SyntaxDescription as follows:

     SyntaxDescription = "(" whsp
        numericoid whsp
        [ "DESC" qdstring ]
        whsp ")"
 

Syntax definitions do not have a name, so the getName method inherited from LDAPSchemaElement returns "". To get the OID and description of this syntax type definition, use the getOID and getDescription methods inherited from the abstract class LDAPSchemaElement.

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

Version:
1.0
See Also: