org.ietf.ldap
Class LDAPAttributeSchema

java.lang.Object
  |
  +--org.ietf.ldap.LDAPAttribute
        |
        +--org.ietf.ldap.LDAPSchemaElement
              |
              +--org.ietf.ldap.LDAPAttributeSchema

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable

public class LDAPAttributeSchema

extends LDAPSchemaElement

Represents the schematic definition of a particular attribute in a particular Directory Server.

See Also:

com.novell.ldap.LDAPAttributeSchema

Field Summary

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.
static int	USER_APPLICATIONS Indicates that the attribute usage is for ordinary application or user data.

Constructor Summary

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 userMod, int usage)
Constructs an attribute definition for adding to or deleting from a directory's schema.

Method Summary

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.
int	getUsage() Returns the usage of the attribute.
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.

Methods inherited from class org.ietf.ldap.LDAPSchemaElement

getDescription, getID, getNames, getQualifier, getQualifierNames, isObsolete, setQualifier, toString

Methods inherited from class org.ietf.ldap.LDAPAttribute

addValue, addValue, clone, compareTo, getBaseName, getBaseName, getByteValueArray, getByteValues, getLangSubtype, getName, getStringValueArray, getStringValues, getSubtypes, getSubtypes, hasSubtype, hasSubtypes, removeValue, removeValue, size

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

USER_APPLICATIONS

public static final int USER_APPLICATIONS

Indicates that the attribute usage is for ordinary application or user data.

See Also:

com.novell.ldap.LDAPAttributeSchema.USER_APPLICATIONS, Constant Field Values

DIRECTORY_OPERATION

public static final int DIRECTORY_OPERATION

Indicates that the attribute usage is for directory operations. Values are vendor specific.

See Also:

com.novell.ldap.LDAPAttributeSchema.DIRECTORY_OPERATION, Constant Field Values

DISTRIBUTED_OPERATION

public static final int DISTRIBUTED_OPERATION

Indicates that the attribute usage is for distributed operational attributes. These hold server (DSA) information that is shared among servers holding replicas of the entry.

See Also:

com.novell.ldap.LDAPAttributeSchema.DISTRIBUTED_OPERATION, Constant Field Values

DSA_OPERATION

public static final int DSA_OPERATION

Indicates that the attribute usage is for local operational attributes. These hold server (DSA) information that is local to a server.

See Also:

com.novell.ldap.LDAPAttributeSchema.DSA_OPERATION, Constant Field Values

Constructor Detail

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 userMod,
                           int usage)

Constructs an attribute definition for adding to or deleting from a directory's schema.

See Also:

com.novell.ldap.LDAPAttributeSchema.LDAPAttributeSchema( String[], String, String, String, boolean, String boolean, String, String, String, boolean, boolean, int)

LDAPAttributeSchema

public LDAPAttributeSchema(java.lang.String raw)

Constructs an attribute definition from the raw string value returned on a directory query for "attributetypes".

See Also:

com.novell.ldap.LDAPAttributeSchema.LDAPAttributeSchema(String)

Method Detail

getSyntaxString

public java.lang.String getSyntaxString()

Returns the object identifer of the syntax of the attribute, in dotted numerical format.

See Also:

com.novell.ldap.LDAPAttributeSchema.getSyntaxString()

getSuperior

public java.lang.String getSuperior()

Returns the name of the attribute type which this attribute derives from, or null if there is no superior attribute.

See Also:

com.novell.ldap.LDAPAttributeSchema.getSuperior()

isSingleValued

public boolean isSingleValued()

Returns true if the attribute is single-valued.

See Also:

com.novell.ldap.LDAPAttributeSchema.isSingleValued()

getEqualityMatchingRule

public java.lang.String getEqualityMatchingRule()

Returns the matching rule for this attribute.

See Also:

com.novell.ldap.LDAPAttributeSchema.getEqualityMatchingRule()

getOrderingMatchingRule

public java.lang.String getOrderingMatchingRule()

Returns the ordering matching rule for this attribute.

See Also:

com.novell.ldap.LDAPAttributeSchema.getOrderingMatchingRule()

getSubstringMatchingRule

public java.lang.String getSubstringMatchingRule()

Returns the substring matching rule for this attribute.

See Also:

com.novell.ldap.LDAPAttributeSchema.getSubstringMatchingRule()

isCollective

public boolean isCollective()

Returns true if the attribute is a collective attribute.

See Also:

com.novell.ldap.LDAPAttributeSchema.isCollective()

isUserModifiable

public boolean isUserModifiable()

Returns false if the attribute is read-only.

See Also:

com.novell.ldap.LDAPAttributeSchema.isUserModifiable()

getUsage

public int getUsage()

Returns the usage of the attribute.

See Also:

com.novell.ldap.LDAPAttributeSchema.getUsage()