Home » openjdk-7 » javax » naming » ldap » [javadoc | source]
javax.naming.ldap
public class: LdapName [javadoc | source]
java.lang.Object
   javax.naming.ldap.LdapName

All Implemented Interfaces:
    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:
 public LdapName(String name) throws InvalidNameException 
    Constructs an LDAP name from the given distinguished name.
    Parameters:
    name - This is a non-null distinguished name formatted according to the rules defined in RFC 2253.
    Throws:
    InvalidNameException - if a syntax violation is detected.
    Also see:
    Rdn#escapeValue(Object value)
 public LdapName(List<Rdn> rdns) 
    Constructs an LDAP name given its parsed RDN components.

    The indexing of RDNs in the list follows the numbering of RDNs described in the class description.

    Parameters:
    rdns - The non-null list of Rdns forming this LDAP name.
Method from javax.naming.ldap.LdapName Summary:
add,   add,   add,   add,   addAll,   addAll,   addAll,   addAll,   clone,   compareTo,   endsWith,   endsWith,   equals,   get,   getAll,   getPrefix,   getRdn,   getRdns,   getSuffix,   hashCode,   isEmpty,   remove,   size,   startsWith,   startsWith,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.naming.ldap.LdapName Detail:
 public Name add(String comp) throws InvalidNameException 
    Adds a single component to the end of this LDAP name.
 public Name add(Rdn comp) 
    Adds a single RDN to the end of this LDAP name.
 public Name add(int posn,
    String comp) throws InvalidNameException 
    Adds a single component at a specified position within this LDAP name. Components of this LDAP name at or after the index (if any) of the new component are shifted up by one (away from index 0) to accommodate the new component.
 public Name add(int posn,
    Rdn comp) 
    Adds a single RDN at a specified position within this LDAP name. RDNs of this LDAP name at or after the index (if any) of the new RDN are shifted up by one (away from index 0) to accommodate the new RDN.
 public Name addAll(Name suffix) throws InvalidNameException 
    Adds the components of a name -- in order -- to the end of this name.
 public Name addAll(List<Rdn> suffixRdns) 
    Adds the RDNs of a name -- in order -- to the end of this name.
 public Name addAll(int posn,
    Name suffix) throws InvalidNameException 
    Adds the components of a name -- in order -- at a specified position within this name. Components of this LDAP name at or after the index (if any) of the first new component are shifted up (away from index 0) to accomodate the new components.
 public Name addAll(int posn,
    List<Rdn> suffixRdns) 
    Adds the RDNs of a name -- in order -- at a specified position within this name. RDNs of this LDAP name at or after the index (if any) of the first new RDN are shifted up (away from index 0) to accomodate the new RDNs.
 public Object clone() 
    Generates a new copy of this name. Subsequent changes to the components of this name will not affect the new copy, and vice versa.
 public int compareTo(Object obj) 
    Compares this LdapName with the specified Object for order. Returns a negative integer, zero, or a positive integer as this Name is less than, equal to, or greater than the given Object.

    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 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.

 public boolean endsWith(Name n) 
    Determines whether this LDAP name ends with a specified LDAP name suffix. A name n is a suffix if it is equal to getSuffix(size()-n.size())--in other words this LDAP name ends with 'n'. If n is null or not a RFC2253 formatted name as described in the class description, false is returned.
 public boolean endsWith(List<Rdn> rdns) 
    Determines whether the specified RDN sequence forms a suffix of this LDAP name. Returns true if this LdapName is at least as long as rdns, and for every position p in the range [size() - rdns.size(), size()) the component getRdn(p) matches rdns.get(p). Returns false otherwise. If rdns is null, false is returned.
 public boolean equals(Object obj) 
    Determines whether two LDAP names are equal. If obj is null or not an LDAP name, false is returned.

    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 Rdn#equals(Object obj) for a definition of RDN equality.

 public String get(int posn) 
    Retrieves a component of this LDAP name as a string.
 public Enumeration<String> getAll() 
    Retrieves the components of this name as an enumeration of strings. The effect of updates to this name on this enumeration is undefined. If the name has zero components, an empty (non-null) enumeration is returned. The order of the components returned by the enumeration is same as the order in which the components are numbered as described in the class description.
 public Name getPrefix(int posn) 
    Creates a name whose components consist of a prefix of the components of this LDAP name. Subsequent changes to this name will not affect the name that is returned and vice versa.
 public Rdn getRdn(int posn) 
    Retrieves an RDN of this LDAP name as an Rdn.
 public List<Rdn> getRdns() 
    Retrieves the list of relative distinguished names. The contents of the list are unmodifiable. The indexing of RDNs in the returned list follows the numbering of RDNs as described in the class description. If the name has zero components, an empty list is returned.
 public Name getSuffix(int posn) 
    Creates a name whose components consist of a suffix of the components in this LDAP name. Subsequent changes to this name do not affect the name that is returned and vice versa.
 public int hashCode() 
    Computes the hash code of this LDAP name. The hash code is the sum of the hash codes of individual RDNs of this name.
 public boolean isEmpty() 
    Determines whether this LDAP name is empty. An empty name is one with zero components.
 public Object remove(int posn) throws InvalidNameException 
    Removes a component from this LDAP name. The component of this name at the specified position is removed. Components with indexes greater than this position (if any) are shifted down (toward index 0) by one.
 public int size() 
    Retrieves the number of components in this LDAP name.
 public boolean startsWith(Name n) 
    Determines whether this LDAP name starts with a specified LDAP name prefix. A name n is a prefix if it is equal to getPrefix(n.size())--in other words this LDAP name starts with 'n'. If n is null or not a RFC2253 formatted name as described in the class description, false is returned.
 public boolean startsWith(List<Rdn> rdns) 
    Determines whether the specified RDN sequence forms a prefix of this LDAP name. Returns true if this LdapName is at least as long as rdns, and for every position p in the range [0, rdns.size()) the component getRdn(p) matches rdns.get(p). Returns false otherwise. If rdns is null, false is returned.
 public String toString() 
    Returns a string representation of this LDAP name in a format defined by RFC 2253 and described in the class description. If the name has zero components an empty string is returned.