Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
netscape.ldap.util.DN
public final class DN
extends java.lang.Object
implements Serializable
netscape.ldap.LDAPDN
class uses this class
internally. In most cases, when working with DNs in the
LDAP Java classes, you should use the
netscape.ldap.LDAPDN
class.
The following DNs are examples of the different formats
for DNs that may appear:
LDAPDN
Field Summary | |
static char[] |
|
static int |
|
static int |
|
Constructor Summary | |
| |
|
Method Summary | |
void | |
void |
|
void |
|
boolean | |
int |
|
boolean | |
String[] |
|
int |
|
DN |
|
Vector |
|
static boolean |
|
boolean |
|
boolean |
|
void |
|
String |
|
String |
|
String |
|
public static final char[] ESCAPED_CHAR
Array of the characters that may be escaped in a DN.
public static int OSF
Type specifying a DN in the OSF format.
- See Also:
getDNType()
,setDNType(int)
public static int RFC
Type specifying a DN in the RFC format.
- See Also:
getDNType()
,setDNType(int)
public DN()
Constructs an emptyDN
object.
public DN(String dn)
Constructs aDN
object from the specified distinguished name. The string representation of the DN can be in RFC 1485 or OSF format.
- Parameters:
dn
- string representation of the distinguished name
public void addRDN(RDN rdn)
Adds the specified relative distinguished name (RDN) to the current DN. If the DN is in RFC 1485 format, the RDN is added to the beginning of the DN. If the DN is in OSF format, the RDN is appended to the end of the DN.
- Parameters:
rdn
- the relative distinguished name to add to the current DN
- See Also:
RDN
public void addRDNToBack(RDN rdn)
Adds the specified relative distinguished name (RDN) to the end of the current DN.
- Parameters:
rdn
- the relative distinguished name to append to the current DN
- See Also:
RDN
public void addRDNToFront(RDN rdn)
Adds the specified relative distinguished name (RDN) to the beginning of the current DN.
- Parameters:
rdn
- the relative distinguished name to add to the beginning of the current DN
- See Also:
RDN
public boolean contains(DN dn)
Deprecated. Please use isDescendantOf() instead.
Determines if the given DN is under the subtree defined by this DN. For example, the following section of code determines if the DN specified bydn1
is under the subtree specified bydn2
.DN dn1 = new DN("uid=bjensen, ou=People, o=Airius.com"); DN dn2 = new DN("ou=People, o=Airius.com"); boolean isContain = dn1.contains(dn2)In this case, since "uid=bjensen, ou=People, o=Airius.com" is an entry under the subtree "ou=People, o=Airius.com", the value ofisContain
is true.
- Parameters:
dn
- the DN of a subtree to check
- Returns:
true
if the current DN belongs to the subtree specified bydn
.
public int countRDNs()
Returns the number of components that make up the current DN.
- Returns:
- the number of components in this DN.
public boolean equals(DN dn)
Determines if the current DN is equal to the specified DN.
- Parameters:
dn
- DN to compare against the current DN
- Returns:
true
if the two DNs are the same.
public String[] explodeDN(boolean noTypes)
Returns an array of the individual components that make up the current distinguished name.
- Parameters:
noTypes
- specifytrue
to remove the attribute type and equals sign (for example, "cn=") from each component
public int getDNType()
Gets the type of format used for the DN (RFC format or OSF format).
- Returns:
- one of the following constants:
DN.RFC
(if the DN is in RFC format) orDN.OSF
(if the DN is in OSF format).
- See Also:
setDNType(int)
,RFC
,OSF
public DN getParent()
Gets the parent DN for this DN. For example, the following section of code gets the parent DN of "uid=bjensen, ou=People, o=Airius.com."DN dn = new DN("uid=bjensen, ou=People, o=Airius.com"); DN parent = dn.getParent();The parent DN in this example is "ou=People, o=Airius.com".
- Returns:
- DN of the parent of this DN.
public Vector getRDNs()
Returns a list of the components (RDN
objects) that make up the current DN.
- Returns:
- a list of the components of this DN.
- See Also:
RDN
public static boolean isDN(String dn)
Determines if the given string is an distinguished name or not.
- Parameters:
dn
- distinguished name
- Returns:
true
orfalse
.
public boolean isDescendantOf(DN dn)
Determines if this DN is a descendant of the given DN. For example, the following section of code determines if the DN specified bydn1
is a descendant of the DN specified bydn2
.DN dn1 = new DN("uid=bjensen, ou=People, o=Airius.com"); DN dn2 = new DN("ou=People, o=Airius.com"); boolean isDescendant = dn1.isDescendantOf(dn2)In this case, since "uid=bjensen, ou=People, o=Airius.com" is an entry under the subtree "ou=People, o=Airius.com", the value ofisDescendant
is true. In the case where the given DN is equal to this DN it returns false.
- Parameters:
dn
- the DN of a subtree to check
- Returns:
true
if the current DN is a descendant of the DN specified bydn
.
public boolean isRFC()
Determines if the DN is in RFC 1485 format.
- Returns:
true
if the DN is in RFC 1485 format.
public void setDNType(int type)
Sets the type of format used for the DN (RFC format or OSF format).
- Parameters:
type
- one of the following constants:DN.RFC
(to use the RFC format) orDN.OSF
(to use the OSF format)
- See Also:
getDNType()
,RFC
,OSF
public String toOSFString()
Returns the DN in OSF format.
- Returns:
- the DN in OSF format.
public String toRFCString()
Returns the DN in RFC 1485 format.
- Returns:
- the DN in RFC 1485 format.
public String toString()
Returns the string representation of the DN in its original format. (For example, if theDN
object was constructed from a DN in RFC 1485 format, this method returns the DN in RFC 1485 format.
- Returns:
- the string representation of the DN.