Package org.springframework.security.ldap

Class LdapUtils

java.lang.Object

org.springframework.security.ldap.LdapUtils

public final class LdapUtils
extends Object

LDAP Utility methods.

Method Summary

Modifier and Type	Method	Description
static void	closeContext(Context ctx)
static void	closeEnumeration(NamingEnumeration ne)
static String	convertPasswordToString(Object passObj)
static LdapName	getFullDn(LdapName dn, Context baseCtx)
static org.springframework.ldap.core.DistinguishedName	getFullDn(org.springframework.ldap.core.DistinguishedName dn, Context baseCtx)	Deprecated. Use getFullDn(LdapName, Context)
static String	getRelativeName(String fullDn, Context baseCtx)	Obtains the part of a DN relative to a supplied base context.
static String	parseRootDnFromUrl(String url)	Works out the root DN for an LDAP URL.

Methods inherited from class java.lang.Object

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

Method Details

closeContext

public static void closeContext(Context ctx)

closeEnumeration

public static void closeEnumeration(NamingEnumeration ne)

getRelativeName

public static String getRelativeName(String fullDn,
 Context baseCtx)
                              throws NamingException

Obtains the part of a DN relative to a supplied base context.

If the DN is "cn=bob,ou=people,dc=springframework,dc=org" and the base context name is "ou=people,dc=springframework,dc=org" it would return "cn=bob".

Parameters:

fullDn - the DN

baseCtx - the context to work out the name relative to.

Returns:

the

Throws:

NamingException - any exceptions thrown by the context are propagated.

getFullDn

@Deprecated
public static org.springframework.ldap.core.DistinguishedName getFullDn(org.springframework.ldap.core.DistinguishedName dn,
 Context baseCtx)
                                                                 throws NamingException

Deprecated.

Use getFullDn(LdapName, Context)

Gets the full dn of a name by prepending the name of the context it is relative to. If the name already contains the base name, it is returned unaltered.

Throws:

NamingException

getFullDn

public static LdapName getFullDn(LdapName dn,
 Context baseCtx)
                          throws NamingException

Throws:

NamingException

convertPasswordToString

public static String convertPasswordToString(Object passObj)

parseRootDnFromUrl

public static String parseRootDnFromUrl(String url)

Works out the root DN for an LDAP URL.

For example, the URL ldap://monkeymachine:11389/dc=springframework,dc=org has the root DN "dc=springframework,dc=org".

Parameters:

url - the LDAP URL

Returns:

the root DN