|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.ldap.support.DistinguishedName
public class DistinguishedName
Default implementation of a Name corresponding to an LDAP path. A DistinguishedName implementation is included in JDK1.5 (LdapName), but not in prior releases. An DistinguishedName is particularly useful when building or modifying an Ldap path dynamically, as escaping will be taken care of. A path is split into several names. The Name interface specifies that the most significant part be in position 0, i.e. The path: uid=adam.skogman, ou=People, ou=EU Name[0]: ou=EU Name[1]: ou=People Name[2]: uid=adam.skogman
Useful for parsing and building LDAP paths.
DistinguishedName path = new DistinguishedName(); path.addLast("cn", entry.getUid()); path.addLast("ou", "users"); path.append(new DistinguishedName(helpdesk.getSomeSuffix())); String dn = path.toString();
Field Summary | |
---|---|
static DistinguishedName |
EMPTY_PATH
An empty, unmodifiable DistinguishedName. |
Constructor Summary | |
---|---|
DistinguishedName()
Construct a new DistinguishedName with no components. |
|
DistinguishedName(java.util.List list)
Construct a new DistinguishedName from the supplied List of LdapRdn objects. |
|
DistinguishedName(javax.naming.Name name)
Construct a new DistinguishedName from the supplied Name. |
|
DistinguishedName(java.lang.String path)
Construct a new DistinguishedName from a String. |
Method Summary | |
---|---|
void |
add(int idx,
LdapRdn rdn)
Add the supplied LdapRdn att the specified index. |
javax.naming.Name |
add(int index,
java.lang.String string)
|
void |
add(LdapRdn rdn)
Add the supplied LdapRdn last in the list of Rdns. |
javax.naming.Name |
add(java.lang.String string)
|
void |
add(java.lang.String key,
java.lang.String value)
Add a new LdapRdn using the supplied key and value. |
javax.naming.Name |
addAll(int arg0,
javax.naming.Name name)
|
javax.naming.Name |
addAll(javax.naming.Name name)
|
void |
append(DistinguishedName path)
Add a LDAP path first |
java.lang.Object |
clone()
|
int |
compareTo(java.lang.Object obj)
Compare this instance to another object. |
boolean |
contains(DistinguishedName path)
Determines if a ldap path contains another path. |
java.lang.String |
encode()
Builds a complete LDAP path, ldap encoded, useful as a DN. |
boolean |
endsWith(javax.naming.Name name)
Determines if this ldap path ends with a certian path. |
boolean |
equals(java.lang.Object obj)
|
java.lang.String |
get(int index)
|
java.util.Enumeration |
getAll()
|
LdapRdn |
getLdapRdn(int index)
Get the LdapRdn at a specified position. |
java.util.List |
getNames()
Get the name list. |
javax.naming.Name |
getPrefix(int index)
|
javax.naming.Name |
getSuffix(int index)
|
int |
hashCode()
|
boolean |
isEmpty()
|
protected void |
parse(java.lang.String path)
Parse the supplied String and make this instance represent the corresponding distinguished name. |
void |
prepend(DistinguishedName path)
Add a LDAP path first |
java.lang.Object |
remove(int arg0)
|
LdapRdn |
removeFirst()
Remove the first part of this DistinguishedName. |
void |
removeFirst(javax.naming.Name path)
Remove the supplied path from the beginning of this DistinguishedName if this instance starts with |
LdapRdn |
removeLast()
Remove the ldast part of this DistinguishedName. |
int |
size()
|
boolean |
startsWith(javax.naming.Name name)
|
java.lang.String |
toString()
Get the String representation of this DistinguishedName. |
java.lang.String |
toUrl()
Builds a complete LDAP path, ldap and url encoded. |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final DistinguishedName EMPTY_PATH
Constructor Detail |
---|
public DistinguishedName()
public DistinguishedName(java.lang.String path)
path
- a String corresponding to a (syntactically) valid LDAP path.public DistinguishedName(java.util.List list)
list
- the components that this instance will consist of.public DistinguishedName(javax.naming.Name name)
name
- the Name to construct a new DistinguishedName from.Method Detail |
---|
protected void parse(java.lang.String path)
path
- the LDAP path to parse.public LdapRdn getLdapRdn(int index)
index
- the LdapRdn to retrieve.
public java.util.List getNames()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String encode()
public java.lang.String toUrl()
public boolean contains(DistinguishedName path)
path
- the path to check.
public void append(DistinguishedName path)
path
- public void prepend(DistinguishedName path)
path
- public LdapRdn removeFirst()
public void removeFirst(javax.naming.Name path)
path
- the path to remove from the beginning of this instance.public java.lang.Object clone()
clone
in interface javax.naming.Name
clone
in class java.lang.Object
Object.clone()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Object.equals(java.lang.Object)
public int hashCode()
hashCode
in class java.lang.Object
Object.hashCode()
public int compareTo(java.lang.Object obj)
compareTo
in interface java.lang.Comparable<java.lang.Object>
compareTo
in interface javax.naming.Name
Name.compareTo(java.lang.Object)
public int size()
size
in interface javax.naming.Name
public boolean isEmpty()
isEmpty
in interface javax.naming.Name
public java.util.Enumeration getAll()
getAll
in interface javax.naming.Name
public java.lang.String get(int index)
get
in interface javax.naming.Name
public javax.naming.Name getPrefix(int index)
getPrefix
in interface javax.naming.Name
public javax.naming.Name getSuffix(int index)
getSuffix
in interface javax.naming.Name
public boolean startsWith(javax.naming.Name name)
startsWith
in interface javax.naming.Name
public boolean endsWith(javax.naming.Name name)
endsWith
in interface javax.naming.Name
name
- The suffix to check forpublic javax.naming.Name addAll(javax.naming.Name name) throws javax.naming.InvalidNameException
addAll
in interface javax.naming.Name
javax.naming.InvalidNameException
public javax.naming.Name addAll(int arg0, javax.naming.Name name) throws javax.naming.InvalidNameException
addAll
in interface javax.naming.Name
javax.naming.InvalidNameException
public javax.naming.Name add(java.lang.String string) throws javax.naming.InvalidNameException
add
in interface javax.naming.Name
javax.naming.InvalidNameException
public javax.naming.Name add(int index, java.lang.String string) throws javax.naming.InvalidNameException
add
in interface javax.naming.Name
javax.naming.InvalidNameException
public java.lang.Object remove(int arg0) throws javax.naming.InvalidNameException
remove
in interface javax.naming.Name
javax.naming.InvalidNameException
public LdapRdn removeLast()
public void add(java.lang.String key, java.lang.String value)
key
- the key of the LdapRdn.value
- the value of the LdapRdn.public void add(LdapRdn rdn)
rdn
- the LdapRdn to add.public void add(int idx, LdapRdn rdn)
idx
- the index at which to add the LdapRdn.rdn
- the LdapRdn to add.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |