org.ldaptive.concurrent

Class AbstractSearchExecutor

java.lang.Object

org.ldaptive.AbstractRequest

org.ldaptive.SearchRequest

org.ldaptive.concurrent.AbstractSearchExecutor

All Implemented Interfaces:

Message<RequestControl>, Request

Direct Known Subclasses:

AbstractAggregateSearchExecutor, AbstractParallelSearchExecutor, QueueingSearchExecutor

public abstract class AbstractSearchExecutor
extends SearchRequest

Base class for concurrent search executors.

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.
private ExecutorService	service To submit operations to.

Constructor Summary

Constructors

Constructor and Description
AbstractSearchExecutor(ExecutorService es) Creates a new abstract search executor.

Method Summary

Modifier and Type	Method and Description
protected SearchOperation	createSearchOperation(Connection conn) Creates a new search operation configured with the properties on this search executor.
protected void	finalize()
protected ExecutorService	getExecutorService() Returns the executor service for this search executor.
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.
void	shutdown() Shuts down the executor service.
List<Runnable>	shutdownNow() Immediately shuts down the executor service.
String	toString()

Methods inherited from class org.ldaptive.SearchRequest

equals, getBaseDn, getBinaryAttributes, getDerefAliases, getReturnAttributes, getSearchEntryHandlers, getSearchFilter, getSearchReferenceHandlers, getSearchScope, getSizeLimit, getSortBehavior, getTimeLimit, getTypesOnly, hashCode, newObjectScopeSearchRequest, newObjectScopeSearchRequest, newObjectScopeSearchRequest, newSearchRequest, setBaseDn, setBinaryAttributes, setDerefAliases, setReturnAttributes, setSearchEntryHandlers, setSearchFilter, setSearchReferenceHandlers, setSearchScope, setSizeLimit, setSortBehavior, setTimeLimit, setTypesOnly

Methods inherited from class org.ldaptive.AbstractRequest

getControls, getIntermediateResponseHandlers, getReferralHandler, setControls, setIntermediateResponseHandlers, setReferralHandler

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Field Detail

logger

protected final Logger logger

Logger for this class.

service

private final ExecutorService service

To submit operations to.

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

AbstractSearchExecutor

public AbstractSearchExecutor(ExecutorService es)

Creates a new abstract search executor.

Parameters:

es - executor service

Method Detail

getExecutorService

protected ExecutorService getExecutorService()

Returns the executor service for this search executor.

Returns:

executor service

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

shutdown

public void shutdown()

Shuts down the executor service. See ExecutorService.shutdown().

shutdownNow

public List<Runnable> shutdownNow()

Immediately shuts down the executor service. See ExecutorService.shutdownNow().

Returns:

list of tasks that never executed

createSearchOperation

protected SearchOperation createSearchOperation(Connection conn)

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

Parameters:

conn - to pass to the search operation

Returns:

search operation

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

toString

public String toString()

Overrides:

toString in class SearchRequest