org.ldaptive.auth

Class AbstractSearchOperationFactory

java.lang.Object

org.ldaptive.auth.AbstractSearchOperationFactory

Direct Known Subclasses:

AbstractSearchDnResolver, AbstractSearchEntryResolver, AbstractSearchRoleResolver

public abstract class AbstractSearchOperationFactory
extends Object

Base class for authentication related classes that perform searches.

Field Summary

Fields

Modifier and Type	Field and Description
protected Logger	logger Logger for this class.
private Cache<SearchRequest>	searchCache Cache to use when performing searches.
private OperationExceptionHandler<SearchRequest,SearchResult>	searchExceptionHandler Handler to handle search exceptions.
private OperationResponseHandler<SearchRequest,SearchResult>[]	searchResponseHandlers Handlers to handle search responses.

Constructor Summary

Constructors

Constructor and Description
AbstractSearchOperationFactory()

Method Summary

Modifier and Type	Method and Description
protected SearchOperation	createSearchOperation(Connection conn) Creates a new search operation configured with the properties on this factory.
Cache<SearchRequest>	getSearchCache() Returns the search cache.
OperationExceptionHandler<SearchRequest,SearchResult>	getSearchExceptionHandler() Returns the search exception handler.
OperationResponseHandler<SearchRequest,SearchResult>[]	getSearchResponseHandlers() Returns the search response handlers.
void	setSearchCache(Cache<SearchRequest> cache) Sets the search cache.
void	setSearchExceptionHandler(OperationExceptionHandler<SearchRequest,SearchResult> handler) Sets the search exception handler.
void	setSearchResponseHandlers(OperationResponseHandler<SearchRequest,SearchResult>... handlers) Sets the search response handlers.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final Logger logger

Logger for this class.

searchExceptionHandler

private OperationExceptionHandler<SearchRequest,SearchResult> searchExceptionHandler

Handler to handle search exceptions.

searchResponseHandlers

private OperationResponseHandler<SearchRequest,SearchResult>[] searchResponseHandlers

Handlers to handle search responses.

searchCache

private Cache<SearchRequest> searchCache

Cache to use when performing searches.

Constructor Detail

AbstractSearchOperationFactory

public AbstractSearchOperationFactory()

Method Detail

getSearchExceptionHandler

public OperationExceptionHandler<SearchRequest,SearchResult> getSearchExceptionHandler()

Returns the search exception handler.

Returns:

search exception handler

setSearchExceptionHandler

public void setSearchExceptionHandler(OperationExceptionHandler<SearchRequest,SearchResult> handler)

Sets the search exception handler.

Parameters:

handler - search exception handler

getSearchResponseHandlers

public OperationResponseHandler<SearchRequest,SearchResult>[] getSearchResponseHandlers()

Returns the search response handlers.

Returns:

search response handlers

setSearchResponseHandlers

public void setSearchResponseHandlers(OperationResponseHandler<SearchRequest,SearchResult>... handlers)

Sets the search response handlers.

Parameters:

handlers - search response handlers

getSearchCache

public Cache<SearchRequest> getSearchCache()

Returns the search cache.

Returns:

cache

setSearchCache

public void setSearchCache(Cache<SearchRequest> cache)

Sets the search cache.

Parameters:

cache - to set

createSearchOperation

protected SearchOperation createSearchOperation(Connection conn)

Creates a new search operation configured with the properties on this factory.

Parameters:

conn - to pass to the search operation

Returns:

search operation