netscape.ldap
Class LDAPSyntaxSchema
- java.io.Serializable
public class LDAPSyntaxSchema
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.
OBSOLETE , SUPERIOR , SYNTAX , aliases , attrName , binary , binaryString , ces , cesString , cis , cisString , description , dn , dnString , intString , integer , name , novalsTable , oid , properties , rawValue , telephone , telephoneString , unknown |
LDAPSyntaxSchema() - 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.
|
int | getSyntax() - Gets the syntax of the schema element
|
String | getSyntaxString() - Gets the syntax of the syntax type in dotted-decimal format,
for example "1.2.3.4.5"
|
String | getValue() - Prepares a value in RFC 2252 format for submission to a server
|
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 , getValue , isObsolete , modify , modify , parseValue , remove , remove , setQualifier , setQualifier , update , update , update |
syntaxElement
protected netscape.ldap.LDAPSyntaxSchemaElement syntaxElement
LDAPSyntaxSchema
protected LDAPSyntaxSchema()
Constructs a blank element.
LDAPSyntaxSchema
public LDAPSyntaxSchema(String raw)
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.)
raw
- definition of the syntax type in the
ldapSyntaxes format
LDAPSyntaxSchema
public LDAPSyntaxSchema(String oid,
String description)
Constructs a syntax type definition, using the specified
information.
oid
- object identifier (OID) of the syntax type
in dotted-string format (for example, "1.2.3.4")description
- description of syntax type
getSyntax
public int getSyntax()
Gets the syntax of the schema element
- 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
public String getSyntaxString()
Gets the syntax of the syntax type in dotted-decimal format,
for example "1.2.3.4.5"
- The syntax syntax in dotted-decimal format.
getValue
public String getValue()
Prepares a value in RFC 2252 format for submission to a server
- getValue in interface LDAPSchemaElement
- a String ready for submission to an LDAP server.
toString
public String 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.
- definition of the syntax type in a user friendly format.