com.ibm.itim.dataservices.model
Class DistinguishedName

java.lang.Object
  com.ibm.itim.dataservices.model.DistinguishedName

All Implemented Interfaces:

java.io.Serializable

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

DistinguishedName represents the distinguishing name, or key, that uniquely identifies an entry in the ITIM data model. It is important that a client treats the distinguishing name as a "black box" and does not attempt to associate meaning with the content or format of the object. This will ensure portability and backwards compatibility in future versions.

See Also:

Serialized Form

Constructor Summary

DistinguishedName(java.lang.String rawDn)
Constructs the DistinguishedName with a raw input.

Method Summary

java.lang.Object	clone() Clones this DistinguishedName object.
boolean	equals(java.lang.Object dn) Compares another DistinguishedName for equality.
java.lang.String	getAsString() Returns the distinguished name in it raw string format.
int	hashCode() Returns a hash value that can be used in hash tables.
static boolean	isDN(java.lang.String dn) Returns true if the given String is a DN consistent with netscape.ldap.util.DN.
java.lang.String	toString() Returns the string representation of the distinguished name.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DistinguishedName

public DistinguishedName(java.lang.String rawDn)

Constructs the DistinguishedName with a raw input. The input will not be portable and is intended to be used internally to ITIM.

Parameters:

rawDn - String representation of the raw key

Method Detail

getAsString

public java.lang.String getAsString()

Returns the distinguished name in it raw string format. It is highly recommended that clients do not use the raw formatted name to avoid portability issues.

Returns:

distinguished name in raw String format.

equals

public boolean equals(java.lang.Object dn)

Compares another DistinguishedName for equality.

Overrides:

equals in class java.lang.Object

Parameters:

dn - DistinguishedName to compare

Returns:

true if equal, false if not

hashCode

public int hashCode()

Returns a hash value that can be used in hash tables.

Overrides:

hashCode in class java.lang.Object

Returns:

Hash value for the distinguished name.

toString

public java.lang.String toString()

Returns the string representation of the distinguished name.

Overrides:

toString in class java.lang.Object

Returns:

String representation.

isDN

public static boolean isDN(java.lang.String dn)

Returns true if the given String is a DN consistent with netscape.ldap.util.DN.

clone

public java.lang.Object clone()

Clones this DistinguishedName object.

Overrides:

clone in class java.lang.Object

Returns:

DistinguishedName