- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable<Object>
,Name
This class resolves a few ambiguities found in RFC 2253 as follows:
- RFC 2253 leaves the term "whitespace" undefined. The ASCII space character 0x20 (" ") is used in its place.
- Whitespace is allowed on either side of ',', ';', '=', and '+'. Such whitespace is accepted but not generated by this code, and is ignored when comparing names.
- AttributeValue strings containing '=' or non-leading '#' characters (unescaped) are accepted.
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.
- Since:
- 1.5
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionAdds a single component at a specified position within this LDAP name.Adds a single RDN at a specified position within this LDAP name.Adds a single component to the end of this LDAP name.Adds a single RDN to the end of this LDAP name.Adds the RDNs of a name -- in order -- at a specified position within this name.Adds the components of a name -- in order -- at a specified position within this name.Adds the RDNs of a name -- in order -- to the end of this name.Adds the components of a name -- in order -- to the end of this name.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.get
(int posn) Retrieves a component of this LDAP name as a string.getAll()
Retrieves the components of this name as an enumeration of strings.getPrefix
(int posn) Creates a name whose components consist of a prefix of the components of this LDAP name.getRdn
(int posn) Retrieves an RDN of this LDAP name as an Rdn.getRdns()
Retrieves the list of relative distinguished names.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.remove
(int posn) Removes a component from this LDAP name.int
size()
Retrieves the number of components in this LDAP name.boolean
startsWith
(List<Rdn> 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.toString()
Returns a string representation of this LDAP name in a format defined by RFC 2253 and described in the class description.
-
Constructor Details
-
LdapName
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.- See Also:
-
LdapName
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 ofRdn
s forming this LDAP name.
-
-
Method Details
-
size
public int size()Retrieves the number of components in this LDAP name. -
isEmpty
public boolean isEmpty()Determines whether this LDAP name is empty. An empty name is one with zero components. -
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. -
get
Retrieves a component of this LDAP name as a string.- Specified by:
get
in interfaceName
- Parameters:
posn
- The 0-based index of the component to retrieve. Must be in the range [0,size()).- Returns:
- The non-null component at index posn.
- Throws:
IndexOutOfBoundsException
- if posn is outside the specified range.
-
getRdn
Retrieves an RDN of this LDAP name as an Rdn.- Parameters:
posn
- The 0-based index of the RDN to retrieve. Must be in the range [0,size()).- Returns:
- The non-null RDN at index posn.
- Throws:
IndexOutOfBoundsException
- if posn is outside the specified range.
-
getPrefix
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.- Specified by:
getPrefix
in interfaceName
- Parameters:
posn
- The 0-based index of the component at which to stop. Must be in the range [0,size()].- Returns:
- An instance of
LdapName
consisting of the components at indexes in the range [0,posn). If posn is zero, an empty LDAP name is returned. - Throws:
IndexOutOfBoundsException
- If posn is outside the specified range.
-
getSuffix
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.- Specified by:
getSuffix
in interfaceName
- Parameters:
posn
- The 0-based index of the component at which to start. Must be in the range [0,size()].- Returns:
- An instance of
LdapName
consisting of the components at indexes in the range [posn,size()). If posn is equal to size(), an empty LDAP name is returned. - Throws:
IndexOutOfBoundsException
- If posn is outside the specified range.
-
startsWith
Determines whether this LDAP name starts with a specified LDAP name prefix. A namen
is a prefix if it is equal togetPrefix(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.- Specified by:
startsWith
in interfaceName
- Parameters:
n
- The LDAP name to check.- Returns:
- true if
n
is a prefix of this LDAP name, false otherwise. - See Also:
-
startsWith
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.- Parameters:
rdns
- The sequence ofRdn
s to check.- Returns:
- true if
rdns
form a prefix of this LDAP name, false otherwise.
-
endsWith
Determines whether this LDAP name ends with a specified LDAP name suffix. A namen
is a suffix if it is equal togetSuffix(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. -
endsWith
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.- Parameters:
rdns
- The sequence ofRdn
s to check.- Returns:
- true if
rdns
form a suffix of this LDAP name, false otherwise.
-
addAll
Adds the components of a name -- in order -- to the end of this name.- Specified by:
addAll
in interfaceName
- Parameters:
suffix
- The non-null components to add.- Returns:
- The updated name (not a new instance).
- Throws:
InvalidNameException
- ifsuffix
is not a valid LDAP name, or if the addition of the components would violate the syntax rules of this LDAP name.
-
addAll
Adds the RDNs of a name -- in order -- to the end of this name.- Parameters:
suffixRdns
- The non-null suffixRdn
s to add.- Returns:
- The updated name (not a new instance).
-
addAll
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 accommodate the new components.- Specified by:
addAll
in interfaceName
- Parameters:
posn
- The index at which to add the new component. Must be in the range [0,size()].suffix
- The non-null components to add.- Returns:
- The updated name (not a new instance).
- Throws:
InvalidNameException
- ifsuffix
is not a valid LDAP name, or if the addition of the components would violate the syntax rules of this LDAP name.IndexOutOfBoundsException
- If posn is outside the specified range.
-
addAll
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 accommodate the new RDNs.- Parameters:
posn
- The index at which to add the suffix RDNs. Must be in the range [0,size()].suffixRdns
- The non-null suffixRdn
s to add.- Returns:
- The updated name (not a new instance).
- Throws:
IndexOutOfBoundsException
- If posn is outside the specified range.
-
add
Adds a single component to the end of this LDAP name.- Specified by:
add
in interfaceName
- Parameters:
comp
- The non-null component to add.- Returns:
- The updated LdapName, not a new instance. Cannot be null.
- Throws:
InvalidNameException
- If adding comp at end of the name would violate the name's syntax.
-
add
Adds a single RDN to the end of this LDAP name.- Parameters:
comp
- The non-null RDN to add.- Returns:
- The updated LdapName, not a new instance. Cannot be null.
-
add
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.- Specified by:
add
in interfaceName
- Parameters:
posn
- The index at which to add the new component. Must be in the range [0,size()].comp
- The non-null component to add.- Returns:
- The updated LdapName, not a new instance. Cannot be null.
- Throws:
IndexOutOfBoundsException
- If posn is outside the specified range.InvalidNameException
- If adding comp at the specified position would violate the name's syntax.
-
add
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.- Parameters:
posn
- The index at which to add the new RDN. Must be in the range [0,size()].comp
- The non-null RDN to add.- Returns:
- The updated LdapName, not a new instance. Cannot be null.
- Throws:
IndexOutOfBoundsException
- If posn is outside the specified range.
-
remove
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.- Specified by:
remove
in interfaceName
- Parameters:
posn
- The index of the component to remove. Must be in the range [0,size()).- Returns:
- The component removed (a String).
- Throws:
IndexOutOfBoundsException
- if posn is outside the specified range.InvalidNameException
- if deleting the component would violate the syntax rules of the name.
-
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.- Returns:
- The name as a list of RDNs which are instances of
the class
Rdn
.
-
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. -
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. -
equals
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. -
compareTo
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.
- Specified by:
compareTo
in interfaceComparable<Object>
- Specified by:
compareTo
in interfaceName
- Parameters:
obj
- The non-null LdapName instance to compare against.- Returns:
- A negative integer, zero, or a positive integer as this Name is less than, equal to, or greater than the given obj.
- Throws:
ClassCastException
- if obj is null or not a LdapName.- See Also:
-
hashCode
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.
-