public class LDAPSyntaxSchema extends LDAPSchemaElement
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.
LDAPSchemaElement
,
Serialized FormModifier and Type | Field and Description |
---|---|
protected netscape.ldap.LDAPSyntaxSchemaElement |
syntaxElement |
aliases, attrName, binary, binaryString, ces, cesString, cis, cisString, description, dn, dnString, integer, intString, name, novalsTable, OBSOLETE, oid, properties, rawValue, SUPERIOR, SYNTAX, telephone, telephoneString, unknown
Modifier | Constructor and Description |
---|---|
protected |
LDAPSyntaxSchema()
Constructs a blank element.
|
|
LDAPSyntaxSchema(java.lang.String raw)
Constructs a syntax type definition based on a description in
the ldapSyntaxes format.
|
|
LDAPSyntaxSchema(java.lang.String oid,
java.lang.String description)
Constructs a syntax type definition, using the specified
information.
|
Modifier and Type | Method and Description |
---|---|
int |
getSyntax()
Gets the syntax of the schema element
|
java.lang.String |
getSyntaxString()
Gets the syntax of the syntax type in dotted-decimal format,
for example "1.2.3.4.5"
|
java.lang.String |
getValue()
Prepares a value in RFC 2252 format for submission to a server
|
java.lang.String |
toString()
Gets the definition of the syntax type in a user friendly format.
|
add, add, getAliases, getCustomValues, getDescription, getID, getName, getOID, getOptionalValues, getQualifier, getQualifierNames, isObsolete, modify, modify, parseValue, remove, remove, setQualifier, setQualifier, update, update, update
protected LDAPSyntaxSchema()
public LDAPSyntaxSchema(java.lang.String oid, java.lang.String description)
oid
- object identifier (OID) of the syntax type
in dotted-string format (for example, "1.2.3.4")description
- description of syntax typepublic LDAPSyntaxSchema(java.lang.String raw)
raw
- definition of the syntax type in the
ldapSyntaxes formatpublic int getSyntax()
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)
public java.lang.String getSyntaxString()
public java.lang.String getValue()
getValue
in class LDAPSchemaElement
public java.lang.String toString()
toString
in class java.lang.Object