com.ibm.itim.dataservices.schema
Class SchemaAttribute

java.lang.Object
  com.ibm.itim.dataservices.schema.SchemaAttribute

All Implemented Interfaces:

java.io.Serializable

public class SchemaAttribute
extends java.lang.Object
implements java.io.Serializable

Class that represents the definition of an attribute within the LDAP schema.

See Also:

Serialized Form

Field Summary

static java.lang.String	BINARY_SYNTAX
static java.lang.String	BIT_STRING_SYNTAX
static java.lang.String	BOOLEAN_SYNTAX
static java.lang.String	CASE_EXACT_IA5_MATCH_EQUALITY_NAME
static java.lang.String	CASE_EXACT_IA5_MATCH_EQUALITY_OID
static java.lang.String	CASE_EXACT_MATCH_EQUALITY_NAME
static java.lang.String	CASE_EXACT_MATCH_EQUALITY_OID
static java.lang.String	CASE_IGNORE_IA5_MATCH_EQUALITY_NAME
static java.lang.String	CASE_IGNORE_IA5_MATCH_EQUALITY_OID
static java.lang.String	CASE_IGNORE_MATCH_EQUALITY_NAME
static java.lang.String	CASE_IGNORE_MATCH_EQUALITY_OID
static java.lang.String	CERTIFICATE_SYNTAX
static java.lang.String	DIRECTORY_STRING_SYNTAX
static java.lang.String	DN_SYNTAX
static java.lang.String	FAX_SYNTAX
static java.lang.String	GENERALIZED_TIME_SYNTAX
static java.lang.String	IA5_STRING_SYNTAX
static java.lang.String	INTEGER_SYNTAX
static java.lang.String	NUMERIC_STRING
static java.lang.String	OID_MATCH_EQUALITY_NAME
static java.lang.String	OID_MATCH_EQUALITY_OID
static java.lang.String	OID_SYNTAX
static java.lang.String	PHONE_NUMBER_SYNTAX
static java.lang.String	POSTAL_ADDRESS_SYNTAX
static java.lang.String	UTC_TIME_SYNTAX

Constructor Summary

SchemaAttribute(java.lang.String name, java.lang.String syntax, boolean isSingleValue, com.ibm.itim.dataservices.schema.AttributeConstraint attrConstraint, java.lang.String equality)
Creates SchemaAttribute object.

SchemaAttribute(java.lang.String name, java.lang.String syntax, boolean isSingleValue, boolean isRequired, com.ibm.itim.dataservices.schema.AttributeConstraint attrConstraint, java.lang.String equality)
Deprecated. please use the SchemaAttribute(name,syntax,isSingleValue, attrContraint,equality) constructor.

Method Summary

boolean	equals(java.lang.Object schema)
com.ibm.itim.dataservices.schema.AttributeConstraint	getConstraint() Returns the attribute's constraint (if any).
java.lang.String	getEquality() Returns the equality of the attribute (if any).
java.lang.String	getName() Returns the name of the attribute.
java.lang.String	getOID() Returns the OID of the attribute.
java.lang.String	getSyntax() Returns the syntax of the attribute.
int	hashCode()
boolean	isRequired() Deprecated. isRequired is not part of Attribute definition. Use SchemaClass.getRequiredAttributes() to find all required attributes for that class.
boolean	isSingleValued() Returns whether the attribute is single valued or not.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

BINARY_SYNTAX

public static final java.lang.String BINARY_SYNTAX

See Also:

Constant Field Values

BIT_STRING_SYNTAX

public static final java.lang.String BIT_STRING_SYNTAX

See Also:

Constant Field Values

BOOLEAN_SYNTAX

public static final java.lang.String BOOLEAN_SYNTAX

See Also:

Constant Field Values

CERTIFICATE_SYNTAX

public static final java.lang.String CERTIFICATE_SYNTAX

See Also:

Constant Field Values

DN_SYNTAX

public static final java.lang.String DN_SYNTAX

See Also:

Constant Field Values

DIRECTORY_STRING_SYNTAX

public static final java.lang.String DIRECTORY_STRING_SYNTAX

See Also:

Constant Field Values

FAX_SYNTAX

public static final java.lang.String FAX_SYNTAX

See Also:

Constant Field Values

GENERALIZED_TIME_SYNTAX

public static final java.lang.String GENERALIZED_TIME_SYNTAX

See Also:

Constant Field Values

IA5_STRING_SYNTAX

public static final java.lang.String IA5_STRING_SYNTAX

See Also:

Constant Field Values

INTEGER_SYNTAX

public static final java.lang.String INTEGER_SYNTAX

See Also:

Constant Field Values

NUMERIC_STRING

public static final java.lang.String NUMERIC_STRING

See Also:

Constant Field Values

OID_SYNTAX

public static final java.lang.String OID_SYNTAX

See Also:

Constant Field Values

POSTAL_ADDRESS_SYNTAX

public static final java.lang.String POSTAL_ADDRESS_SYNTAX

See Also:

Constant Field Values

PHONE_NUMBER_SYNTAX

public static final java.lang.String PHONE_NUMBER_SYNTAX

See Also:

Constant Field Values

UTC_TIME_SYNTAX

public static final java.lang.String UTC_TIME_SYNTAX

See Also:

Constant Field Values

CASE_IGNORE_MATCH_EQUALITY_NAME

public static final java.lang.String CASE_IGNORE_MATCH_EQUALITY_NAME

See Also:

Constant Field Values

CASE_IGNORE_MATCH_EQUALITY_OID

public static final java.lang.String CASE_IGNORE_MATCH_EQUALITY_OID

See Also:

Constant Field Values

CASE_EXACT_MATCH_EQUALITY_NAME

public static final java.lang.String CASE_EXACT_MATCH_EQUALITY_NAME

See Also:

Constant Field Values

CASE_EXACT_MATCH_EQUALITY_OID

public static final java.lang.String CASE_EXACT_MATCH_EQUALITY_OID

See Also:

Constant Field Values

CASE_EXACT_IA5_MATCH_EQUALITY_NAME

public static final java.lang.String CASE_EXACT_IA5_MATCH_EQUALITY_NAME

See Also:

Constant Field Values

CASE_EXACT_IA5_MATCH_EQUALITY_OID

public static final java.lang.String CASE_EXACT_IA5_MATCH_EQUALITY_OID

See Also:

Constant Field Values

CASE_IGNORE_IA5_MATCH_EQUALITY_NAME

public static final java.lang.String CASE_IGNORE_IA5_MATCH_EQUALITY_NAME

See Also:

Constant Field Values

CASE_IGNORE_IA5_MATCH_EQUALITY_OID

public static final java.lang.String CASE_IGNORE_IA5_MATCH_EQUALITY_OID

See Also:

Constant Field Values

OID_MATCH_EQUALITY_NAME

public static final java.lang.String OID_MATCH_EQUALITY_NAME

See Also:

Constant Field Values

OID_MATCH_EQUALITY_OID

public static final java.lang.String OID_MATCH_EQUALITY_OID

See Also:

Constant Field Values

Constructor Detail

SchemaAttribute

public SchemaAttribute(java.lang.String name,
                       java.lang.String syntax,
                       boolean isSingleValue,
                       boolean isRequired,
                       com.ibm.itim.dataservices.schema.AttributeConstraint attrConstraint,
                       java.lang.String equality)

Deprecated. please use the SchemaAttribute(name,syntax,isSingleValue, attrContraint,equality) constructor.

Parameters:

name -

syntax -

isSingleValue -

isRequired -

attrConstraint -

equality -

SchemaAttribute

public SchemaAttribute(java.lang.String name,
                       java.lang.String syntax,
                       boolean isSingleValue,
                       com.ibm.itim.dataservices.schema.AttributeConstraint attrConstraint,
                       java.lang.String equality)

Creates SchemaAttribute object.

Parameters:

name - The attribute name.

syntax - The LDAP syntax.

isSingleValue - The boolean value for whether it is single valued or multi valued.

attrConstraint - The attribute constraint.

equality - The equality.

Method Detail

getOID

public java.lang.String getOID()

Returns the OID of the attribute.

Returns:

OID of the attribute (String).

getName

public java.lang.String getName()

Returns the name of the attribute.

Returns:

Name of the attribute (String).

isSingleValued

public boolean isSingleValued()

Returns whether the attribute is single valued or not.

Returns:

true if single valued, false if multi-valued.

getSyntax

public java.lang.String getSyntax()

Returns the syntax of the attribute. The syntax is identified by its object id.

Returns:

object id for the syntax of the attribute (String).

isRequired

public boolean isRequired()

Deprecated. isRequired is not part of Attribute definition. Use SchemaClass.getRequiredAttributes() to find all required attributes for that class.

Returns whether the attribute is required or not within the context of the class this definition is associated with.

Returns:

true if required, false if not.

getConstraint

public com.ibm.itim.dataservices.schema.AttributeConstraint getConstraint()

Returns the attribute's constraint (if any).

Returns:

AttributeConstraint object, null if none found.

getEquality

public java.lang.String getEquality()

Returns the equality of the attribute (if any).

Returns:

Equality of the attribute (String).

equals

public boolean equals(java.lang.Object schema)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object