Class LDAPSyntaxSchema
- All Implemented Interfaces:
Serializable
- 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:
-
Field Summary
FieldsFields inherited from class netscape.ldap.LDAPSchemaElement
aliases, attrName, binary, binaryString, ces, cesString, cis, cisString, description, dn, dnString, integer, intString, name, novalsTable, OBSOLETE, oid, properties, rawValue, SUPERIOR, SYNTAX, telephone, telephoneString, unknown
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Constructs a blank element.LDAPSyntaxSchema
(String raw) Constructs a syntax type definition based on a description in the ldapSyntaxes format.LDAPSyntaxSchema
(String oid, String description) Constructs a syntax type definition, using the specified information. -
Method Summary
Modifier and TypeMethodDescriptionint
Gets the syntax of the schema elementGets the syntax of the syntax type in dotted-decimal format, for example "1.2.3.4.5"getValue()
Prepares a value in RFC 2252 format for submission to a servertoString()
Gets the definition of the syntax type in a user friendly format.Methods inherited from class netscape.ldap.LDAPSchemaElement
add, add, getAliases, getCustomValues, getDescription, getID, getName, getOID, getOptionalValues, getQualifier, getQualifierNames, isObsolete, modify, modify, parseValue, remove, remove, setQualifier, setQualifier, update, update, update
-
Field Details
-
syntaxElement
protected netscape.ldap.LDAPSyntaxSchemaElement syntaxElement
-
-
Constructor Details
-
LDAPSyntaxSchema
protected LDAPSyntaxSchema()Constructs a blank element. -
LDAPSyntaxSchema
Constructs a syntax type definition, using the specified information.- Parameters:
oid
- object identifier (OID) of the syntax type in dotted-string format (for example, "1.2.3.4")description
- description of syntax type
-
LDAPSyntaxSchema
Constructs a syntax type definition based on a description in the ldapSyntaxes format. For information on this format, (see RFC 2252, Lightweight Directory Access Protocol (v3): LDAP Subschema Attribute. This is the format that LDAP servers and clients use to exchange schema information. (For example, when you search an LDAP server for its schema, the server returns an entry with the syntaxs "objectclasses" and "ldapSyntaxes". The values of "ldapSyntaxes" are syntax type descriptions in this format.)- Parameters:
raw
- definition of the syntax type in the ldapSyntaxes format
-
-
Method Details
-
getSyntax
public int getSyntax()Gets the syntax of the schema element- Returns:
- one of the following values:
cis
(case-insensitive string)ces
(case-exact string)binary
(binary data)int
(integer)telephone
(telephone number -- identical to cis, but blanks and dashes are ignored during comparisons)dn
(distinguished name)unknown
(not a known syntax)
-
getSyntaxString
Gets the syntax of the syntax type in dotted-decimal format, for example "1.2.3.4.5"- Returns:
- The syntax syntax in dotted-decimal format.
-
getValue
Prepares a value in RFC 2252 format for submission to a server- Overrides:
getValue
in classLDAPSchemaElement
- Returns:
- a String ready for submission to an LDAP server.
-
toString
Gets the definition of the syntax type in a user friendly format. This is the format that the syntax type definition uses when printing the syntax type or the schema.
-