|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.shared.ldap.schema.AbstractSchemaObject
org.apache.directory.shared.ldap.schema.LdapSyntax
public class LdapSyntax
A syntax definition. Each attribute stored in a directory has a defined syntax (i.e. data type) which constrains the structure and format of its values. The description of each syntax specifies how attribute or assertion values conforming to the syntax are normally represented when transferred in LDAP operations. This representation is referred to as the LDAP-specific encoding to distinguish it from other methods of encoding attribute values.
According to ldapbis [MODELS]:
4.1.5. LDAP Syntaxes LDAP Syntaxes of (attribute and assertion) values are described in terms of ASN.1 [X.680] and, optionally, have an octet string encoding known as the LDAP-specific encoding. Commonly, the LDAP-specific encoding is constrained to string of Universal Character Set (UCS) [ISO10646] characters in UTF-8 [UTF-8] form. Each LDAP syntax is identified by an object identifier (OID). LDAP syntax definitions are written according to the ABNF: SyntaxDescription = LPAREN WSP numericoid ; object identifier [ SP "DESC" SP qdstring ] ; description extensions WSP RPAREN ; extensions where: [numericoid] is object identifier assigned to this LDAP syntax; DESC [qdstring] is a short descriptive string; and [extensions] describe extensions.
DescriptionUtils#getDescription(Syntax)
,
Serialized FormField Summary | |
---|---|
protected boolean |
isHumanReadable
the human readable flag |
static long |
serialVersionUID
The serialVersionUID |
protected SyntaxChecker |
syntaxChecker
The associated SyntaxChecker |
Fields inherited from class org.apache.directory.shared.ldap.schema.AbstractSchemaObject |
---|
description, extensions, isEnabled, isObsolete, isReadOnly, locked, names, objectType, oid, schemaName, specification |
Constructor Summary | |
---|---|
LdapSyntax(java.lang.String oid)
Creates a Syntax object using a unique OID. |
|
LdapSyntax(java.lang.String oid,
java.lang.String description)
Creates a Syntax object using a unique OID. |
|
LdapSyntax(java.lang.String oid,
java.lang.String description,
boolean isHumanReadable)
Creates a Syntax object using a unique OID. |
Method Summary | |
---|---|
void |
addToRegistries(java.util.List<java.lang.Throwable> errors,
Registries registries)
Inject the Syntax into the registries, updating the references to other SchemaObject |
void |
clear()
Clear the current SchemaObject : remove all the references to other objects, and all the Maps. |
LdapSyntax |
copy()
Copy a LdapSyntax |
boolean |
equals(java.lang.Object o)
|
SyntaxChecker |
getSyntaxChecker()
Gets the SyntaxChecker used to validate values in accordance with this Syntax. |
boolean |
isHumanReadable()
Gets whether or not the Syntax is human readable. |
void |
removeFromRegistries(java.util.List<java.lang.Throwable> errors,
Registries registries)
Remove the SDyntax from the registries, updating the references to other SchemaObject. |
void |
setHumanReadable(boolean isHumanReadable)
Sets the human readable flag value. |
void |
setSyntaxChecker(SyntaxChecker syntaxChecker)
Sets the associated SyntaxChecker |
java.lang.String |
toString()
|
void |
updateSyntaxChecker(SyntaxChecker syntaxChecker)
Update the associated SyntaxChecker, even if the SchemaObject is readOnly |
Methods inherited from class org.apache.directory.shared.ldap.schema.AbstractSchemaObject |
---|
addExtension, addName, compareOid, copy, getDescription, getExtensions, getName, getNames, getObjectType, getOid, getSchemaName, getSpecification, hashCode, isDisabled, isEnabled, isObsolete, isReadOnly, lock, registerOid, setDescription, setEnabled, setExtensions, setNames, setNames, setObsolete, setOid, setReadOnly, setRegistries, setSchemaName, setSpecification |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final long serialVersionUID
protected boolean isHumanReadable
protected SyntaxChecker syntaxChecker
Constructor Detail |
---|
public LdapSyntax(java.lang.String oid)
oid
- the OID for this Syntaxpublic LdapSyntax(java.lang.String oid, java.lang.String description)
oid
- the OID for this Syntaxpublic LdapSyntax(java.lang.String oid, java.lang.String description, boolean isHumanReadable)
oid
- the OID for this SyntaxMethod Detail |
---|
public boolean isHumanReadable()
public void setHumanReadable(boolean isHumanReadable)
isHumanReadable
- the human readable flag value to setpublic SyntaxChecker getSyntaxChecker()
public void setSyntaxChecker(SyntaxChecker syntaxChecker)
syntaxChecker
- The associated SyntaxCheckerpublic void updateSyntaxChecker(SyntaxChecker syntaxChecker)
syntaxChecker
- The associated SyntaxCheckerpublic java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public void addToRegistries(java.util.List<java.lang.Throwable> errors, Registries registries) throws LdapException
addToRegistries
in interface SchemaObject
addToRegistries
in class AbstractSchemaObject
registries
- The Registrieserrors
- The errors we got
If
- the addition failed
LdapException
public void removeFromRegistries(java.util.List<java.lang.Throwable> errors, Registries registries) throws LdapException
removeFromRegistries
in interface SchemaObject
removeFromRegistries
in class AbstractSchemaObject
registries
- The Registrieserrors
- The errors we got
If
- the Syntx is not valid
LdapException
public LdapSyntax copy()
copy
in interface SchemaObject
copy
in class AbstractSchemaObject
public boolean equals(java.lang.Object o)
equals
in interface SchemaObject
equals
in class AbstractSchemaObject
Object#equals()
public void clear()
clear
in interface SchemaObject
clear
in class AbstractSchemaObject
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |