org.ldaptive.concurrent

Class QueueingSearchExecutor

java.lang.Object

org.ldaptive.AbstractRequest

org.ldaptive.SearchRequest

org.ldaptive.concurrent.AbstractSearchExecutor

org.ldaptive.concurrent.QueueingSearchExecutor

All Implemented Interfaces:

Message<RequestControl>, Request

public class QueueingSearchExecutor
extends AbstractSearchExecutor

Executes a search filter and places the results of the operation on a blocking queue. The capacity of the queue can be configured to address memory concerns related to large result sets.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	QueueingSearchExecutor.AbstractHandler Common implementation for the handler classes.
protected class	QueueingSearchExecutor.IntermediateResponseHandler Places intermediate responses on a blocking queue.
protected class	QueueingSearchExecutor.SearchEntryHandler Places search entries on a blocking queue.
static class	QueueingSearchExecutor.SearchItem Contains data returned when using the QueueingSearchExecutor.
protected class	QueueingSearchExecutor.SearchReferenceHandler Places search references on a blocking queue.

Field Summary

Fields

Modifier and Type	Field and Description
private int	queueCapacity Capacity of the blocking queue created by search operations.

Fields inherited from class org.ldaptive.concurrent.AbstractSearchExecutor

logger

Constructor Summary

Constructors

Constructor and Description
QueueingSearchExecutor() Default constructor.
QueueingSearchExecutor(java.util.concurrent.ExecutorService es) Creates a new blocking search executor.
QueueingSearchExecutor(int capacity) Creates a new blocking search executor.
QueueingSearchExecutor(int capacity, java.util.concurrent.ExecutorService es) Creates a new blocking search executor.

Method Summary

Modifier and Type	Method and Description
protected void	configureSearchRequest(SearchRequest request, java.util.concurrent.BlockingQueue<QueueingSearchExecutor.SearchItem> queue) Sets the appropriate handlers on the supplied search request so that entries, references, and intermediate responses are made available on the supplied queue.
protected java.util.concurrent.Callable<Response<SearchResult>>	createCallable(Connection conn, SearchOperation operation, SearchRequest request, java.util.concurrent.BlockingQueue<QueueingSearchExecutor.SearchItem> queue) Returns a Callable that executes the supplied request with the supplied operation in a try-finally block that opens and closes the connection.
java.util.concurrent.BlockingQueue<QueueingSearchExecutor.SearchItem>	search(ConnectionFactory factory) Performs a search operation with the supplied connection factory.
java.util.concurrent.BlockingQueue<QueueingSearchExecutor.SearchItem>	search(ConnectionFactory factory, SearchFilter filter) Performs a search operation with the supplied connection factory.
java.util.concurrent.BlockingQueue<QueueingSearchExecutor.SearchItem>	search(ConnectionFactory factory, SearchFilter filter, java.lang.String... attrs) Performs a search operation with the supplied connection factory.
java.util.concurrent.BlockingQueue<QueueingSearchExecutor.SearchItem>	search(ConnectionFactory factory, SearchFilter filter, java.lang.String[] attrs, SearchEntryHandler... handlers) Performs a search operation with the supplied connection factory.
java.util.concurrent.BlockingQueue<QueueingSearchExecutor.SearchItem>	search(ConnectionFactory factory, java.lang.String filter) Performs a search operation with the supplied connection factory.
java.util.concurrent.BlockingQueue<QueueingSearchExecutor.SearchItem>	search(ConnectionFactory factory, java.lang.String filter, java.lang.String... attrs) Performs a search operation with the supplied connection factory.

Methods inherited from class org.ldaptive.concurrent.AbstractSearchExecutor

createSearchOperation, finalize, getExecutorService, getSearchCache, getSearchExceptionHandler, getSearchResponseHandlers, setSearchCache, setSearchExceptionHandler, setSearchResponseHandlers, shutdown, shutdownNow, 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

queueCapacity

private final int queueCapacity

Capacity of the blocking queue created by search operations.

Constructor Detail

QueueingSearchExecutor

public QueueingSearchExecutor()

Default constructor.

QueueingSearchExecutor

public QueueingSearchExecutor(int capacity)

Creates a new blocking search executor.

Parameters:

capacity - of the blocking queue returned from search operations

QueueingSearchExecutor

public QueueingSearchExecutor(java.util.concurrent.ExecutorService es)

Creates a new blocking search executor.

Parameters:

es - executor service

QueueingSearchExecutor

public QueueingSearchExecutor(int capacity,
                              java.util.concurrent.ExecutorService es)

Creates a new blocking search executor.

Parameters:

capacity - of the blocking queue returned from search operations

es - executor service

Method Detail

search

public java.util.concurrent.BlockingQueue<QueueingSearchExecutor.SearchItem> search(ConnectionFactory factory)
                                                                             throws LdapException

Performs a search operation with the supplied connection factory.

Parameters:

factory - to get a connection from

Returns:

blocking queue to receive search items

Throws:

LdapException - if the connection factory cannot create a connection

search

public java.util.concurrent.BlockingQueue<QueueingSearchExecutor.SearchItem> search(ConnectionFactory factory,
                                                                                    java.lang.String filter)
                                                                             throws LdapException

Performs a search operation with the supplied connection factory.

Parameters:

factory - to get a connection from

filter - to search with

Returns:

blocking queue to receive search items

Throws:

LdapException - if the connection factory cannot create a connection

search

public java.util.concurrent.BlockingQueue<QueueingSearchExecutor.SearchItem> search(ConnectionFactory factory,
                                                                                    SearchFilter filter)
                                                                             throws LdapException

Performs a search operation with the supplied connection factory.

Parameters:

factory - to get a connection from

filter - to search with

Returns:

blocking queue to receive search items

Throws:

LdapException - if the connection factory cannot create a connection

search

public java.util.concurrent.BlockingQueue<QueueingSearchExecutor.SearchItem> search(ConnectionFactory factory,
                                                                                    java.lang.String filter,
                                                                                    java.lang.String... attrs)
                                                                             throws LdapException

Performs a search operation with the supplied connection factory.

Parameters:

factory - to get a connection from

filter - to search with

attrs - to return

Returns:

blocking queue to receive search items

Throws:

LdapException - if the connection factory cannot create a connection

search

public java.util.concurrent.BlockingQueue<QueueingSearchExecutor.SearchItem> search(ConnectionFactory factory,
                                                                                    SearchFilter filter,
                                                                                    java.lang.String... attrs)
                                                                             throws LdapException

Performs a search operation with the supplied connection factory.

Parameters:

factory - to get a connection from

filter - to search with

attrs - to return

Returns:

blocking queue to receive search items

Throws:

LdapException - if the connection factory cannot create a connection

search

public java.util.concurrent.BlockingQueue<QueueingSearchExecutor.SearchItem> search(ConnectionFactory factory,
                                                                                    SearchFilter filter,
                                                                                    java.lang.String[] attrs,
                                                                                    SearchEntryHandler... handlers)
                                                                             throws LdapException

Performs a search operation with the supplied connection factory.

Parameters:

factory - to get a connection from

filter - to search with

attrs - to return

handlers - entry handlers

Returns:

blocking queue to receive search items

Throws:

LdapException - if the connection factory cannot create a connection

createCallable

protected java.util.concurrent.Callable<Response<SearchResult>> createCallable(Connection conn,
                                                                               SearchOperation operation,
                                                                               SearchRequest request,
                                                                               java.util.concurrent.BlockingQueue<QueueingSearchExecutor.SearchItem> queue)

Returns a Callable that executes the supplied request with the supplied operation in a try-finally block that opens and closes the connection.

Parameters:

conn - connection that the operation will execute on

operation - to execute

request - to pass to the operation

queue - to put search items on

Returns:

callable for the supplied operation and request

configureSearchRequest

protected void configureSearchRequest(SearchRequest request,
                                      java.util.concurrent.BlockingQueue<QueueingSearchExecutor.SearchItem> queue)

Sets the appropriate handlers on the supplied search request so that entries, references, and intermediate responses are made available on the supplied queue.

Parameters:

request - search request to modify

queue - to use in the handlers