com.communote.server.core.common.ldap

Class LdapSearchUtils

java.lang.Object

com.communote.server.core.common.ldap.LdapSearchUtils

public class LdapSearchUtils
extends Object

Utils for LDAP access.

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
static boolean	canConnectToLdapDirectory(LdapConfiguration config) Tests whether a connection to the LDAP directory is possible.
static org.springframework.ldap.core.support.LdapContextSource	createLdapContext(LdapConfiguration config, LdapAttributesMapper<?> mapper) Creates an LDAP context
static org.springframework.ldap.core.support.LdapContextSource	createLdapContext(LdapConfiguration config, String[] binaryAttributes)
static String[]	getServerUrls(LdapConfiguration config) Tries to find all available urls.
static <T> T	retrieveEntry(org.springframework.ldap.core.support.LdapContextSource contextFactory, String dn, String searchFilter, String[] attributesToReturn, Collection<LdapSearchBaseDefinition> searchBaseDefs, LdapAttributesMapper<T> mapper) Retrieve an entry with the named attributes from the LDAP directory and convert it with the provided attributes mapper.

Methods inherited from class java.lang.Object

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

Method Detail

canConnectToLdapDirectory

public static boolean canConnectToLdapDirectory(LdapConfiguration config)

Tests whether a connection to the LDAP directory is possible.

Parameters:

config - the LDAP configuration

Returns:

True if a context could be created and closed, false otherwise

createLdapContext

public static org.springframework.ldap.core.support.LdapContextSource createLdapContext(LdapConfiguration config,
                                                                                        LdapAttributesMapper<?> mapper)

Creates an LDAP context

Parameters:

config - the LDAP configuration

mapper - the attributes mapper

Returns:

the context factory

createLdapContext

public static org.springframework.ldap.core.support.LdapContextSource createLdapContext(LdapConfiguration config,
                                                                                        String[] binaryAttributes)
                                                                                 throws NamingException

Parameters:

config - the ldap configuration

binaryAttributes - optional array of attributes to be returned as binary. This argument need not to be provided if the context is not intended to retrieve entries.

Returns:

the context factory

Throws:

NamingException - Exception

getServerUrls

public static String[] getServerUrls(LdapConfiguration config)
                              throws NamingException

Tries to find all available urls.

Parameters:

config - The config.

Returns:

An array of possible urls.

Throws:

NamingException - Exception.

retrieveEntry

public static <T> T retrieveEntry(org.springframework.ldap.core.support.LdapContextSource contextFactory,
                                  String dn,
                                  String searchFilter,
                                  String[] attributesToReturn,
                                  Collection<LdapSearchBaseDefinition> searchBaseDefs,
                                  LdapAttributesMapper<T> mapper)
                           throws org.springframework.dao.DataAccessException,
                                  LdapAttributeMappingException

Retrieve an entry with the named attributes from the LDAP directory and convert it with the provided attributes mapper.

Parameters:

contextFactory - context factory to use

dn - the DN of the entry to retrieve

searchFilter - the searchFilter the entry must adhere to

attributesToReturn - the attributes to fetch

searchBaseDefs - search base definitions to assert that the DN conforms to at least one of the search bases

Returns:

the converted entry from the LDAP directory with the provided DN, that conforms to one of the search bases and is retrievable by the search filter or null if there is no such entry

Throws:

org.springframework.dao.DataAccessException - in case of access problems while communicating with the repository

LdapAttributeMappingException - in case the entry cannot be converted