org.ldaptive.control.util

Class PersistentSearchClient

java.lang.Object

org.ldaptive.control.util.PersistentSearchClient

public class PersistentSearchClient
extends Object

Client that simplifies using the persistent search control.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	changesOnly Whether to return only changed entries.
private EnumSet<PersistentSearchChangeType>	changeTypes Change types.
private Connection	connection Connection to invoke the search operation on.
protected Logger	logger Logger for this class.
private boolean	returnEcs Whether to return an Entry Change Notification control.

Constructor Summary

Constructors

Constructor and Description
PersistentSearchClient(Connection conn, EnumSet<PersistentSearchChangeType> types, boolean co, boolean re) Creates a new persistent search client.

Method Summary

Modifier and Type	Method and Description
void	abandon(int messageId) Invokes an abandon operation on the supplied ldap message id.
BlockingQueue<PersistentSearchItem>	execute(SearchRequest request) Invokes execute(SearchRequest, int) with a capacity of Integer.MAX_VALUE.
BlockingQueue<PersistentSearchItem>	execute(SearchRequest request, int capacity) Performs an async search operation with the PersistentSearchRequestControl.

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.

connection

private final Connection connection

Connection to invoke the search operation on.

changeTypes

private final EnumSet<PersistentSearchChangeType> changeTypes

Change types.

changesOnly

private final boolean changesOnly

Whether to return only changed entries.

returnEcs

private final boolean returnEcs

Whether to return an Entry Change Notification control.

Constructor Detail

PersistentSearchClient

public PersistentSearchClient(Connection conn,
                              EnumSet<PersistentSearchChangeType> types,
                              boolean co,
                              boolean re)

Creates a new persistent search client.

Parameters:

conn - to execute the async search operation on

types - persistent search change types

co - whether only changed entries are returned

re - return an Entry Change Notification control

Method Detail

execute

public BlockingQueue<PersistentSearchItem> execute(SearchRequest request)
                                            throws LdapException

Invokes execute(SearchRequest, int) with a capacity of Integer.MAX_VALUE.

Parameters:

request - search request to execute

Returns:

blocking queue to wait for persistent search items

Throws:

LdapException - if the search fails

execute

public BlockingQueue<PersistentSearchItem> execute(SearchRequest request,
                                                   int capacity)
                                            throws LdapException

Performs an async search operation with the PersistentSearchRequestControl. The supplied request is modified in the following way:

• AbstractRequest.setControls( org.ldaptive.control.RequestControl...) is invoked with PersistentSearchRequestControl
• SearchRequest.setSearchEntryHandlers(SearchEntryHandler...) is invoked with a custom handler that places persistent search data in a blocking queue.
• AbstractAsyncOperation.setExceptionHandler(org.ldaptive.async.handler.ExceptionHandler) is invoked with a custom handler that places the exception in a blocking queue.

The search request object should not be reused for any other search operations.

Parameters:

request - search request to execute

capacity - of the returned blocking queue

Returns:

blocking queue to wait for persistent search items

Throws:

LdapException - if the search fails

abandon

public void abandon(int messageId)
             throws LdapException

Invokes an abandon operation on the supplied ldap message id. Convenience method supplied to abandon persistent search operations.

Parameters:

messageId - of the operation to abandon

Throws:

LdapException - if the abandon operation fails