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.

Version:

$Revision: 3056 $ $Date: 2014-09-09 16:01:06 -0400 (Tue, 09 Sep 2014) $

Author:

Middleware Services

Field Summary

Fields inherited from class org.ldaptive.auth.AbstractSearchOperationFactory

logger

Constructor Summary

SearchEntryResolver()
Default constructor.

SearchEntryResolver(ConnectionFactory cf)
Creates a new search entry resolver.

SearchEntryResolver(ConnectionFactory cf, String... attrs)
Deprecated. return attributes are provided in the authentication criteria

SearchEntryResolver(String... attrs)
Deprecated. return attributes are provided in the authentication criteria

Method Summary

ConnectionFactory	getConnectionFactory() Returns the connection factory.
SearchResult	performLdapSearch(Connection conn, AuthenticationCriteria ac) Executes an ldap search with the supplied authentication criteria.
void	setConnectionFactory(ConnectionFactory cf) Sets the connection factory.
String	toString()

Methods inherited from class org.ldaptive.auth.AbstractSearchEntryResolver

createSearchFilter, createSearchRequest, createSearchRequest, getAllowMultipleEntries, getBaseDn, getDerefAliases, getFollowReferrals, getReturnAttributes, getSearchEntryHandlers, getSubtreeSearch, getUserFilter, getUserFilterParameters, resolve, setAllowMultipleEntries, setBaseDn, setDerefAliases, setFollowReferrals, setReturnAttributes, 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

Constructor Detail

SearchEntryResolver

public SearchEntryResolver()

Default constructor.

SearchEntryResolver

@Deprecated
public SearchEntryResolver(String... attrs)

Deprecated. return attributes are provided in the authentication criteria

Creates a new search entry resolver.

Parameters:

attrs - to return

SearchEntryResolver

public SearchEntryResolver(ConnectionFactory cf)

Creates a new search entry resolver.

Parameters:

cf - connection factory

SearchEntryResolver

@Deprecated
public SearchEntryResolver(ConnectionFactory cf,
                                      String... attrs)

Deprecated. return attributes are provided in the authentication criteria

Creates a new search entry resolver.

Parameters:

cf - connection factory

attrs - to return

Method Detail

getConnectionFactory

public ConnectionFactory getConnectionFactory()

Returns the connection factory.

Specified by:

getConnectionFactory in interface ConnectionFactoryManager

Returns:

connection factory

setConnectionFactory

public void setConnectionFactory(ConnectionFactory cf)

Sets the connection factory.

Specified by:

setConnectionFactory in interface ConnectionFactoryManager

Parameters:

cf - connection factory

performLdapSearch

public SearchResult performLdapSearch(Connection conn,
                                      AuthenticationCriteria ac)
                               throws LdapException

Executes an ldap search with the supplied authentication criteria.

Specified by:

performLdapSearch in class AbstractSearchEntryResolver

Parameters:

conn - that the user attempted to bind on

ac - authentication criteria associated with the user

Returns:

search result

Throws:

LdapException - if an error occurs attempting the search

toString

public String toString()

Overrides:

toString in class Object