|
All LDAP Classes Internal LDAP Classes |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.novell.ldap.LDAPAttribute
com.novell.ldap.LDAPSchemaElement
com.novell.ldap.LDAPAttributeSchema
public class LDAPAttributeSchema
The definition of an attribute type in the schema.
LDAPAttributeSchema is used to discover an attribute's syntax, and add or delete an attribute definition. RFC 2252, "Lightweight Directory Access Protocol (v3): Attribute Syntax Definitions" contains a description of the information on the LDAP representation of schema. draft-sermerseim-nds-ldap-schema-02, "LDAP Schema for NDS" defines the schema descriptions and non-standard syntaxes used by Novell eDirectory.
Sample Code: ExtendSchema.java
LDAPSchema
,
Serialized FormField Summary | |
---|---|
private boolean |
collective
|
static int |
DIRECTORY_OPERATION
Indicates that the attribute usage is for directory operations. |
static int |
DISTRIBUTED_OPERATION
Indicates that the attribute usage is for distributed operational attributes. |
static int |
DSA_OPERATION
Indicates that the attribute usage is for local operational attributes. |
private java.lang.String |
equality
|
private java.lang.String |
ordering
|
private boolean |
single
|
private java.lang.String |
substring
|
private java.lang.String |
superior
|
private java.lang.String |
syntaxString
|
private int |
usage
|
static int |
USER_APPLICATIONS
Indicates that the attribute usage is for ordinary application or user data. |
private boolean |
userMod
|
Fields inherited from class com.novell.ldap.LDAPSchemaElement |
---|
description, hashQualifier, names, obsolete, oid, qualifier |
Constructor Summary | |
---|---|
LDAPAttributeSchema()
This constructor was added to support default Serialization |
|
LDAPAttributeSchema(java.lang.String raw)
Constructs an attribute definition from the raw string value returned on a directory query for "attributetypes". |
|
LDAPAttributeSchema(java.lang.String[] names,
java.lang.String oid,
java.lang.String description,
java.lang.String syntaxString,
boolean single,
java.lang.String superior,
boolean obsolete,
java.lang.String equality,
java.lang.String ordering,
java.lang.String substring,
boolean collective,
boolean isUserModifiable,
int usage)
Constructs an attribute definition for adding to or deleting from a directory's schema. |
Method Summary | |
---|---|
protected java.lang.String |
formatString()
Returns a string in a format suitable for directly adding to a directory, as a value of the particular schema element attribute. |
java.lang.String |
getEqualityMatchingRule()
Returns the matching rule for this attribute. |
java.lang.String |
getOrderingMatchingRule()
Returns the ordering matching rule for this attribute. |
java.lang.String |
getSubstringMatchingRule()
Returns the substring matching rule for this attribute. |
java.lang.String |
getSuperior()
Returns the name of the attribute type which this attribute derives from, or null if there is no superior attribute. |
java.lang.String |
getSyntaxString()
Returns the object identifer of the syntax of the attribute, in dotted numerical format. |
private static LDAPXMLHandler |
getTopXMLHandler(java.lang.String tagname,
LDAPXMLHandler parenthandler)
|
int |
getUsage()
Returns the usage of the attribute. |
(package private) static LDAPXMLHandler |
getXMLHandler(java.lang.String tagname,
LDAPXMLHandler parenthandler)
This method return the LDAPHandler which handles the XML (DSML) tags for this class |
boolean |
isCollective()
Returns true if the attribute is a collective attribute. |
boolean |
isSingleValued()
Returns true if the attribute is single-valued. |
boolean |
isUserModifiable()
Returns false if the attribute is read-only. |
static java.lang.Object |
readDSML(java.io.InputStream input)
This method is used to deserialize the DSML encoded representation of this class. |
protected void |
setDeserializedValues(java.io.BufferedInputStream istream)
|
protected void |
writeValue(java.lang.StringBuffer buff)
|
protected void |
writeValue(java.io.Writer out)
|
Methods inherited from class com.novell.ldap.LDAPSchemaElement |
---|
addValue, addValue, getDescription, getID, getNames, getQualifier, getQualifierNames, isObsolete, removeValue, removeValue, setQualifier, toString |
Methods inherited from class com.novell.ldap.LDAPAttribute |
---|
addBase64Value, addBase64Value, addBase64Value, addURLValue, addURLValue, addValue, clone, compareTo, getBaseName, getBaseName, getByteValue, getByteValueArray, getByteValues, getLangSubtype, getName, getStringValue, getStringValueArray, getStringValues, getSubtypes, getSubtypes, hasSubtype, hasSubtypes, newLine, readExternal, removeValue, setValue, size, writeDSML, writeExternal |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private java.lang.String syntaxString
private boolean single
private java.lang.String superior
private java.lang.String equality
private java.lang.String ordering
private java.lang.String substring
private boolean collective
private boolean userMod
private int usage
public static final int USER_APPLICATIONS
public static final int DIRECTORY_OPERATION
public static final int DISTRIBUTED_OPERATION
public static final int DSA_OPERATION
Constructor Detail |
---|
public LDAPAttributeSchema()
public LDAPAttributeSchema(java.lang.String[] names, java.lang.String oid, java.lang.String description, java.lang.String syntaxString, boolean single, java.lang.String superior, boolean obsolete, java.lang.String equality, java.lang.String ordering, java.lang.String substring, boolean collective, boolean isUserModifiable, int usage)
names
- Names of the attribute.
oid
- Object identifer of the attribute, in
dotted numerical format.
description
- Optional description of the attribute.
syntaxString
- Object identifer of the syntax of the
attribute, in dotted numerical format.
single
- True if the attribute is to be single-valued.
superior
- Optional name of the attribute type which this
attribute type derives from; null if there is no
superior attribute type.
obsolete
- True if the attribute is obsolete.
equality
- Optional matching rule name; null if there is not
an equality matching rule for this attribute.
ordering
- Optional matching rule name; null if there is not
an ordering matching rule for this attribute.
substring
- Optional matching rule name; null if there is not
a substring matching rule for this attribute.
collective
- True of this attribute is a collective attribute
isUserModifiable
- False if this attribute is a read-only attribute
usage
- Describes what the attribute is used for. Must be
one of the following: USER_APPLICATIONS,
DIRECTORY_OPERATION, DISTRIBUTED_OPERATION or
DSA_OPERATION.public LDAPAttributeSchema(java.lang.String raw)
raw
- The raw string value returned on a directory
query for "attributetypes".Method Detail |
---|
public java.lang.String getSyntaxString()
public java.lang.String getSuperior()
public boolean isSingleValued()
public java.lang.String getEqualityMatchingRule()
public java.lang.String getOrderingMatchingRule()
public java.lang.String getSubstringMatchingRule()
public boolean isCollective()
public boolean isUserModifiable()
public int getUsage()
protected java.lang.String formatString()
formatString
in class LDAPSchemaElement
protected void setDeserializedValues(java.io.BufferedInputStream istream) throws java.io.IOException
setDeserializedValues
in class LDAPAttribute
java.io.IOException
protected void writeValue(java.io.Writer out) throws java.io.IOException
writeValue
in class LDAPAttribute
java.io.IOException
protected void writeValue(java.lang.StringBuffer buff)
writeValue
in class LDAPAttribute
public static java.lang.Object readDSML(java.io.InputStream input) throws java.io.IOException
input
- InputStream for the DSML formatted data.
java.io.IOException
- when serialization fails.private static LDAPXMLHandler getTopXMLHandler(java.lang.String tagname, LDAPXMLHandler parenthandler)
static LDAPXMLHandler getXMLHandler(java.lang.String tagname, LDAPXMLHandler parenthandler)
tagname
- Name of the Root tag used to represent this class.parenthandler
- Parent LDAPXMLHandler for this tag.
|
All LDAP Classes Internal LDAP Classes |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |