java.lang.Object
- org.ldaptive.AbstractRequest
- - org.ldaptive.SearchRequest
  - - org.ldaptive.SearchExecutor

All Implemented Interfaces:

Message<RequestControl>, Request
```
public class SearchExecutor
extends SearchRequest
```
Helper class which encapsulates the try, finally idiom used to execute a SearchOperation. This is a convenience class for searching if you don't need to manage individual connections. In addition, this class provides a way to hold common search request properties constant while changing properties that tend to be more dynamic.

Field Summary

Fields
Modifier and Type	Field	Description
`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 Description

SearchExecutor()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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.
`Response<SearchResult>`	`search(ConnectionFactory factory)`	Performs a search operation with the supplied connection factory.
`Response<SearchResult>`	`search(ConnectionFactory factory, String filter)`	Performs a search operation with the supplied connection factory.
`Response<SearchResult>`	`search(ConnectionFactory factory, String filter, String... attrs)`	Performs a search operation with the supplied connection factory.
`Response<SearchResult>`	`search(ConnectionFactory factory, SearchFilter filter)`	Performs a search operation with the supplied connection factory.
`Response<SearchResult>`	`search(ConnectionFactory factory, SearchFilter filter, String... attrs)`	Performs a search operation with the supplied connection factory.
`Response<SearchResult>`	`search(ConnectionFactory factory, SearchFilter filter, String[] attrs, SearchEntryHandler... handlers)`	Performs a search operation with the supplied connection factory.
`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 org.ldaptive.AbstractRequest
getControls, getIntermediateResponseHandlers, getReferralHandler, setControls, setIntermediateResponseHandlers, setReferralHandler

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

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
- SearchExecutor
```
public SearchExecutor()
```

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

search
```
public Response<SearchResult> search(ConnectionFactory factory)
                              throws LdapException
```
Performs a search operation with the supplied connection factory.

Parameters:

factory - to get a connection from

Returns:

search result

Throws:

LdapException - if the search fails