org.apache.directory.shared.ldap.util

Class NamespaceTools

java.lang.Object

org.apache.directory.shared.ldap.util.NamespaceTools

public class NamespaceTools
extends Object

Tools dealing with common Naming operations.

Version:

$Revision: 926996 $

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
NamespaceTools()

Method Summary

Modifier and Type	Method and Description
static String[]	getCompositeComponents(String compositeNameComponent) Gets the '+' appended components of a composite name component.
static String	getRdnAttribute(String rdn) Gets the attribute of a single attribute rdn or name component.
static String	getRdnValue(String rdn) Gets the value of a single name component of a distinguished name.
static DN	getRelativeName(DN ancestor, DN descendant) Gets the relative name between an ancestor and a potential descendant.
static boolean	hasCompositeComponents(String name) Checks to see if a name has name complex name components in it.
static String	inferLdapName(String realm) Uses the algorithm in RFC 2247 to infer an LDAP name from a Kerberos realm name or a DNS domain name.
static boolean	isDescendant(DN ancestor, DN descendant) Tests to see if a candidate entry is a descendant of a base.
static boolean	isSibling(DN name1, DN name2) Checks to see if two names are siblings.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NamespaceTools

public NamespaceTools()

Method Detail

getRdnAttribute

public static String getRdnAttribute(String rdn)

Gets the attribute of a single attribute rdn or name component.

Parameters:

rdn - the name component

Returns:

the attribute name TODO the name rdn is misused rename refactor this method

getRdnValue

public static String getRdnValue(String rdn)

Gets the value of a single name component of a distinguished name.

Parameters:

rdn - the name component to get the value from

Returns:

the value of the single name component TODO the name rdn is misused rename refactor this method

isSibling

public static boolean isSibling(DN name1,
                                DN name2)
                         throws LdapInvalidDnException

Checks to see if two names are siblings.

Parameters:

name1 - the first name

name2 - the second name

Returns:

true if the names are siblings, false otherwise.

Throws:

LdapInvalidDnException

isDescendant

public static boolean isDescendant(DN ancestor,
                                   DN descendant)

Tests to see if a candidate entry is a descendant of a base.

Parameters:

ancestor - the base ancestor

descendant - the candidate to test for descendancy

Returns:

true if the candidate is a descendant

getRelativeName

public static DN getRelativeName(DN ancestor,
                                 DN descendant)
                          throws LdapInvalidDnException

Gets the relative name between an ancestor and a potential descendant. Both name arguments must be normalized. The returned name is also normalized.

Parameters:

ancestor - the normalized distinguished name of the ancestor context

descendant - the normalized distinguished name of the descendant context

Returns:

the relative normalized name between the ancestor and the descendant contexts

Throws:

LdapInvalidDnException - if the contexts are not related in the ancestual sense

inferLdapName

public static String inferLdapName(String realm)

Uses the algorithm in RFC 2247 to infer an LDAP name from a Kerberos realm name or a DNS domain name.

Parameters:

realm - the realm or domain name

Returns:

the LDAP name for the realm or domain

getCompositeComponents

public static String[] getCompositeComponents(String compositeNameComponent)
                                       throws LdapInvalidDnException

Gets the '+' appended components of a composite name component.

Parameters:

compositeNameComponent - a single name component not a whole name

Returns:

the components of the complex name component in order

Throws:

LdapInvalidDnException - if nameComponent is invalid (starts with a +)

hasCompositeComponents

public static boolean hasCompositeComponents(String name)
                                      throws LdapInvalidDnException

Checks to see if a name has name complex name components in it.

Parameters:

name - The name to check

Returns:

true if the name has composite components

Throws:

LdapInvalidDnException - If the name is invalid