|
LDAPJDK 4.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--netscape.ldap.LDAPSchemaElement | +--netscape.ldap.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:
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 FormField Summary | |
protected netscape.ldap.LDAPSyntaxSchemaElement |
syntaxElement
|
Fields 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 | |
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. |
Method Summary | |
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. |
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 |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
protected netscape.ldap.LDAPSyntaxSchemaElement syntaxElement
Constructor Detail |
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 formatMethod Detail |
public 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()
public java.lang.String toString()
|
LDAPJDK 4.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |