com.rli.slapd.server

Class LDAPDN

java.lang.Object

com.rli.slapd.server.LDAPDN

public class LDAPDN
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static char[]	DN_ESCAPED_CHAR Array of the characters that may be escaped in a DN.

Constructor Summary

Constructors

Constructor and Description
LDAPDN() Constructs an empty LDAPDN object.
LDAPDN(java.lang.String dn) Constructs a LDAPDN object from the specified distinguished name.

Method Summary

Modifier and Type	Method and Description
void	addRDN(LDAPRDN rdn)
void	addRDNToBack(LDAPRDN rdn) Adds the specified relative distinguished name (RDN) to the end of the current DN.
void	addRDNToFront(LDAPRDN rdn) Adds the specified relative distinguished name (RDN) to the beginning of the current DN.
static java.lang.String	dnBackslashDeNormalizer(java.lang.String dn)
static java.lang.String	dnNormalizer(java.lang.String dn) Normalize dn by: 1) Remove extra write space; 2) LDAPv2 to LDAPv3 For Example: ou= "One, Two, Three, GO!" , o = radiant logic and always return the following: ou=\"One\, Two\, Three\, GO!\",o=radiant logic
boolean	equals(java.lang.Object o)
static java.lang.String	getParent(java.lang.String dn)
LDAPDN	getParentDN()
java.lang.String	getParentDNString()
LDAPRDN	getRDN()
LDAPRDN	getRDN(int index)
static java.lang.String	getRdn(java.lang.String dn)
java.util.Vector<LDAPRDN>	getRDNs()
java.lang.String	getRDNString()
int	hashCode() Retrieves the hash code for this LDAPDN.
boolean	isDescendantOf(LDAPDN dn)
static boolean	isDN(java.lang.String dn) Determines if the given string is an distinguished name or not.
boolean	isNullDN()
static void	main(java.lang.String[] args)
static LDAPDN	nullDN() Retrieves a singleton instance of the null DN.
static java.lang.String	rdnBackslashDeNormalizer(java.lang.String rdn)
static java.lang.String	rdnSpaceNormalizer(java.lang.String rdn)
int	size()
java.lang.String	toNormalizedString() Retrieves a normalized string representation of this LDAPDN.
java.lang.String	toString() Returns the DN in RFC 1485 format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DN_ESCAPED_CHAR

public static final char[] DN_ESCAPED_CHAR

Array of the characters that may be escaped in a DN.

If a value should contain any of the following characters

Character ASCII value Position RFC since ---------------------------------------------------------------------- '#' 0x23 at the beginning 2253, 4514 ' ' 0x20 at the beginning or the end 2253, 4514 '"' 0x22 anywhere 1179 '+' 0x2b anywhere 1179 ',' 0x2c anywhere 1179 ';' 0x3b anywhere 1179 only '<' 0x3c anywhere 1179 '=' 0x3d anywhere 1179, 2253 '>' 0x3e anywhere 1179 '\' 0x5c anywhere 1179 NUL 0x00 anywhere 4514

the character must be prefixed by a backslash '\'. The others, like NULL or non-printable char, must be encoded as the backslash '\' character (ASCII 0x5c) followed by the two hexadecimal digits representing the ASCII value of the encoded character. The case of the two hexadecimal digits is not significant.

Constructor Detail

LDAPDN

public LDAPDN()

Constructs an empty LDAPDN object.

LDAPDN

public LDAPDN(java.lang.String dn)
       throws LDAPException

Constructs a LDAPDN object from the specified distinguished name. The string representation of the DN can be in RFC 1485 format.

Parameters:

dn - string representation of the distinguished name

Throws:

LDAPException

Method Detail

size

public int size()

getRDN

public LDAPRDN getRDN()

getRDN

public LDAPRDN getRDN(int index)

getRDNs

public java.util.Vector<LDAPRDN> getRDNs()

getParentDN

public LDAPDN getParentDN()

addRDN

public void addRDN(LDAPRDN rdn)

addRDNToFront

public void addRDNToFront(LDAPRDN rdn)

Adds the specified relative distinguished name (RDN) to the beginning of the current DN.

addRDNToBack

public void addRDNToBack(LDAPRDN rdn)

Adds the specified relative distinguished name (RDN) to the end of the current DN.

toString

public java.lang.String toString()

Returns the DN in RFC 1485 format.

Overrides:

toString in class java.lang.Object

getRDNString

public java.lang.String getRDNString()

getParentDNString

public java.lang.String getParentDNString()

dnNormalizer

public static java.lang.String dnNormalizer(java.lang.String dn)

Normalize dn by: 1) Remove extra write space; 2) LDAPv2 to LDAPv3 For Example: ou= "One, Two, Three, GO!" , o = radiant logic and always return the following: ou=\"One\, Two\, Three\, GO!\",o=radiant logic

dnBackslashDeNormalizer

public static java.lang.String dnBackslashDeNormalizer(java.lang.String dn)

rdnSpaceNormalizer

public static java.lang.String rdnSpaceNormalizer(java.lang.String rdn)

rdnBackslashDeNormalizer

public static java.lang.String rdnBackslashDeNormalizer(java.lang.String rdn)

getParent

public static java.lang.String getParent(java.lang.String dn)
                                  throws LDAPException

Throws:

LDAPException

getRdn

public static java.lang.String getRdn(java.lang.String dn)
                               throws LDAPException

Throws:

LDAPException

main

public static void main(java.lang.String[] args)

isDN

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

Determines if the given string is an distinguished name or not.

Parameters:

dn - distinguished name

Returns:

true or false.

isNullDN

public boolean isNullDN()

isDescendantOf

public boolean isDescendantOf(LDAPDN dn)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Retrieves the hash code for this LDAPDN.

Overrides:

hashCode in class java.lang.Object

Returns:

The hash code for this LDAPDN.

toNormalizedString

public java.lang.String toNormalizedString()

Retrieves a normalized string representation of this LDAPDN.

Returns:

A normalized string representation of this LDAPDN.

nullDN

public static LDAPDN nullDN()

Retrieves a singleton instance of the null DN.

Returns:

A singleton instance of the null DN.