org.ldaptive.auth

Class SearchEntryResolver

java.lang.Object

org.ldaptive.auth.AbstractSearchOperationFactory

org.ldaptive.auth.AbstractSearchEntryResolver

org.ldaptive.auth.SearchEntryResolver

All Implemented Interfaces:

EntryResolver, ConnectionFactoryManager

public class SearchEntryResolver
extends AbstractSearchEntryResolver
implements ConnectionFactoryManager

Looks up the LDAP entry associated with a user. If a connection factory is configured it will be used to perform the search for user. The connection will be opened and closed for each resolution. If no connection factory is configured the search will occur using the connection that the bind was attempted on.

Field Summary

Fields

Modifier and Type	Field and Description
private ConnectionFactory	factory Connection factory.

Fields inherited from class org.ldaptive.auth.AbstractSearchOperationFactory

logger

Constructor Summary

Constructors

Constructor and Description
SearchEntryResolver() Default constructor.
SearchEntryResolver(ConnectionFactory cf) Creates a new search entry resolver.

Method Summary

Modifier and Type	Method and Description
ConnectionFactory	getConnectionFactory() Returns the connection factory.
SearchResult	performLdapSearch(AuthenticationCriteria criteria, AuthenticationHandlerResponse response) Executes an ldap search with the supplied authentication criteria.
void	setConnectionFactory(ConnectionFactory cf) Sets the connection factory.
java.lang.String	toString()

Methods inherited from class org.ldaptive.auth.AbstractSearchEntryResolver

createSearchFilter, createSearchRequest, getAllowMultipleEntries, getBaseDn, getDerefAliases, getReferralHandler, getSearchEntryHandlers, getSubtreeSearch, getUserFilter, getUserFilterParameters, resolve, setAllowMultipleEntries, setBaseDn, setDerefAliases, setReferralHandler, setSearchEntryHandlers, setSubtreeSearch, setUserFilter, setUserFilterParameters

Methods inherited from class org.ldaptive.auth.AbstractSearchOperationFactory

createSearchOperation, getSearchCache, getSearchExceptionHandler, getSearchResponseHandlers, setSearchCache, setSearchExceptionHandler, setSearchResponseHandlers

Methods inherited from class java.lang.Object

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

Field Detail

factory

private ConnectionFactory factory

Connection factory.

Constructor Detail

SearchEntryResolver

public SearchEntryResolver()

Default constructor.

SearchEntryResolver

public SearchEntryResolver(ConnectionFactory cf)

Creates a new search entry resolver.

Parameters:

cf - connection factory

Method Detail

getConnectionFactory

public ConnectionFactory getConnectionFactory()

Description copied from interface: ConnectionFactoryManager

Returns the connection factory.

Specified by:

getConnectionFactory in interface ConnectionFactoryManager

Returns:

connection factory

setConnectionFactory

public void setConnectionFactory(ConnectionFactory cf)

Description copied from interface: ConnectionFactoryManager

Sets the connection factory.

Specified by:

setConnectionFactory in interface ConnectionFactoryManager

Parameters:

cf - connection factory

performLdapSearch

public SearchResult performLdapSearch(AuthenticationCriteria criteria,
                                      AuthenticationHandlerResponse response)
                               throws LdapException

Description copied from class: AbstractSearchEntryResolver

Executes an ldap search with the supplied authentication criteria.

Specified by:

performLdapSearch in class AbstractSearchEntryResolver

Parameters:

criteria - authentication criteria associated with the user

response - response from the authentication event

Returns:

search result

Throws:

LdapException - if an error occurs attempting the search

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object