| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
String name = …;
LdapName dn = new LdapName(name);
Based on 18 examples
public class LdapName extends Object implements Name
This class represents a distinguished name as specified by RFC 2253. A distinguished name, or DN, is composed of an ordered list of components called relative distinguished names, or RDNs. Details of a DN's syntax are described in RFC 2253.
This class resolves a few ambiguities found in RFC 2253 as follows:
String names passed to LdapName
or returned by it
use the full Unicode character set. They may also contain
characters encoded into UTF-8 with each octet represented by a
three-character substring such as "\\B4".
They may not, however, contain characters encoded into UTF-8 with
each octet represented by a single character in the string: the
meaning would be ambiguous.
LdapName
will properly parse all valid names, but
does not attempt to detect all possible violations when parsing
invalid names. It is "generous" in accepting invalid names.
The "validity" of a name is determined ultimately when it
is supplied to an LDAP server, which may accept or
reject the name based on factors such as its schema information
and interoperability considerations.
When names are tested for equality, attribute types, both binary and string values, are case-insensitive. String values with different but equivalent usage of quoting, escaping, or UTF8-hex-encoding are considered equal. The order of components in multi-valued RDNs (such as "ou=Sales+cn=Bob") is not significant.
The components of a LDAP name, that is, RDNs, are numbered. The indexes of a LDAP name with n RDNs range from 0 to n-1. This range may be written as [0,n). The right most RDN is at index 0, and the left most RDN is at index n-1. For example, the distinguished name: "CN=Steve Kille, O=Isode Limited, C=GB" is numbered in the following sequence ranging from 0 to 2: {C=GB, O=Isode Limited, CN=Steve Kille}. An empty LDAP name is represented by an empty RDN list.
Concurrent multithreaded read-only access of an instance of LdapName need not be synchronized.
Unless otherwise noted, the behavior of passing a null argument to a constructor or method in this class will cause a NullPointerException to be thrown.
Constructor Summary | |
---|---|
Constructs an LDAP name given its parsed RDN components. |
|
Constructs an LDAP name from the given distinguished name. |
Method Summary | |
---|---|
Name |
Adds a single RDN at a specified position within this LDAP name. |
Name |
Adds a single component at a specified position within this LDAP name. |
Name |
Adds a single RDN to the end of this LDAP name. |
Name |
Adds a single component to the end of this LDAP name. |
Name |
Adds the RDNs of a name -- in order -- at a specified position within this name. |
Name |
Adds the components of a name -- in order -- at a specified position within this name. |
Name |
Adds the RDNs of a name -- in order -- to the end of this name. |
Name |
Adds the components of a name -- in order -- to the end of this name. |
Object |
clone() Generates a new copy of this name. |
int |
Compares this LdapName with the specified Object for order. |
boolean |
Determines whether the specified RDN sequence forms a suffix of this LDAP name. |
boolean |
Determines whether this LDAP name ends with a specified LDAP name suffix. |
boolean |
Determines whether two LDAP names are equal. |
String |
get(int posn) Retrieves a component of this LDAP name as a string. |
Enumeration |
getAll() Retrieves the components of this name as an enumeration of strings. |
Name |
getPrefix(int posn) Creates a name whose components consist of a prefix of the components of this LDAP name. |
Rdn |
getRdn(int posn) Retrieves an RDN of this LDAP name as an Rdn. |
List |
getRdns() Retrieves the list of relative distinguished names. |
Name |
getSuffix(int posn) Creates a name whose components consist of a suffix of the components in this LDAP name. |
int |
hashCode() Computes the hash code of this LDAP name. |
boolean |
isEmpty() Determines whether this LDAP name is empty. |
Object |
remove(int posn) Removes a component from this LDAP name. |
int |
size() Retrieves the number of components in this LDAP name. |
boolean |
startsWith(List rdns) Determines whether the specified RDN sequence forms a prefix of this LDAP name. |
boolean |
startsWith(Name n) Determines whether this LDAP name starts with a specified LDAP name prefix. |
String |
toString() Returns a string representation of this LDAP name in a format defined by RFC 2253 and described in the class description. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LdapName(List rdns)
The indexing of RDNs in the list follows the numbering of RDNs described in the class description.
rdns
- The non-null list of Rdns forming this LDAP name.public LdapName(String name) throws InvalidNameException
name
- This is a non-null distinguished name formatted
according to the rules defined in
RFC 2253.InvalidNameException
- if a syntax violation is detected.Method Detail |
---|
public Name add(int posn, Rdn comp)
posn
- The index at which to add the new RDN.
Must be in the range [0,size()].comp
- The non-null RDN to add.public Name add(int posn, String comp) throws InvalidNameException
posn
- The index at which to add the new component.
Must be in the range [0,size()].comp
- The non-null component to add.InvalidNameException
- If adding comp at the
specified position would violate the name's syntax.public Name add(Rdn comp)
comp
- The non-null RDN to add.public Name add(String comp) throws InvalidNameException
comp
- The non-null component to add.InvalidNameException
- If adding comp at end of the name
would violate the name's syntax.public Name addAll(int posn, List suffixRdns)
posn
- The index at which to add the suffix RDNs.
Must be in the range [0,size()].suffixRdns
- The non-null suffix Rdns to add.public Name addAll(int posn, Name suffix) throws InvalidNameException
posn
- The index at which to add the new component.
Must be in the range [0,size()].suffix
- The non-null components to add.InvalidNameException
- if suffix is not a valid LDAP
name, or if the addition of the components would violate the
syntax rules of this LDAP name.public Name addAll(List suffixRdns)
suffixRdns
- The non-null suffix Rdns to add.public Name addAll(Name suffix) throws InvalidNameException
suffix
- The non-null components to add.InvalidNameException
- if suffix is not a valid LDAP
name, or if the addition of the components would violate the
syntax rules of this LDAP name.public Object clone()
clone
in class Object
public int compareTo(Object obj)
If obj is null or not an instance of LdapName, ClassCastException is thrown.
Ordering of LDAP names follows the lexicographical rules for string comparison, with the extension that this applies to all the RDNs in the LDAP name. All the RDNs are lined up in their specified order and compared lexicographically. See {@link Rdn#compareTo(Object obj) Rdn.compareTo(Object obj)} for RDN comparison rules.
If this LDAP name is lexicographically lesser than obj, a negative number is returned. If this LDAP name is lexicographically greater than obj, a positive number is returned.
obj
- The non-null LdapName instance to compare against.public boolean endsWith(List rdns)
rdns
- The sequence of Rdns to check.public boolean endsWith(Name n)
n
- The LDAP name to check.public boolean equals(Object obj)
Two LDAP names are equal if each RDN in one is equal to the corresponding RDN in the other. This implies both have the same number of RDNs, and each RDN's equals() test against the corresponding RDN in the other name returns true. See {@link Rdn#equals(Object obj)} for a definition of RDN equality.
equals
in class Object
obj
- The possibly null object to compare against.public String get(int posn)
posn
- The 0-based index of the component to retrieve.
Must be in the range [0,size()).public Enumeration getAll()
public Name getPrefix(int posn)
posn
- The 0-based index of the component at which to stop.
Must be in the range [0,size()].public Rdn getRdn(int posn)
posn
- The 0-based index of the RDN to retrieve.
Must be in the range [0,size()).public List getRdns()
public Name getSuffix(int posn)
posn
- The 0-based index of the component at which to start.
Must be in the range [0,size()].public int hashCode()
hashCode
in class Object
public boolean isEmpty()
public Object remove(int posn) throws InvalidNameException
posn
- The index of the component to remove.
Must be in the range [0,size()).InvalidNameException
- if deleting the component
would violate the syntax rules of the name.public int size()
public boolean startsWith(List rdns)
rdns
- The sequence of Rdns to check.public boolean startsWith(Name n)
n
- The LDAP name to check.public String toString()
toString
in class Object
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |