Package org.ldaptive.control.util

Class VirtualListViewClient

java.lang.Object

org.ldaptive.AbstractSearchOperationFactory

org.ldaptive.control.util.VirtualListViewClient

All Implemented Interfaces:

ConnectionFactoryManager

public class VirtualListViewClient
extends AbstractSearchOperationFactory

Client that simplifies using the virtual list view control.

Field Summary

Fields

Modifier and Type	Field	Description
protected Logger	logger	Logger for this class.
private SortRequestControl	sortControl	Used on the search operation.

Constructor Summary

Constructors

Constructor	Description
VirtualListViewClient(ConnectionFactory cf, SortKey... keys)	Creates a new virtual list view client.

Method Summary

Modifier and Type	Method	Description
SearchResponse	execute(SearchRequest request, VirtualListViewParams params)	Performs a search operation with the VirtualListViewRequestControl.
SearchResponse	execute(SearchRequest request, VirtualListViewParams params, SearchResponse result)	Performs a search operation with the VirtualListViewRequestControl.

Methods inherited from class org.ldaptive.AbstractSearchOperationFactory

createSearchOperation, createSearchOperation, getConnectionFactory, getEntryHandlers, getExceptionHandler, getResultHandlers, getSearchResultHandlers, setConnectionFactory, setEntryHandlers, setExceptionHandler, setResultHandlers, setSearchResultHandlers

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.

sortControl

private final SortRequestControl sortControl

Used on the search operation.

Constructor Detail

VirtualListViewClient

public VirtualListViewClient(ConnectionFactory cf,
                             SortKey... keys)

Creates a new virtual list view client.

Parameters:

cf - to get a connection from

keys - to supply to a sort request control

Method Detail

execute

public SearchResponse execute(SearchRequest request,
                              VirtualListViewParams params)
                       throws LdapException

Performs a search operation with the VirtualListViewRequestControl. The supplied request is modified in the following way:

• AbstractRequestMessage.setControls( org.ldaptive.control.RequestControl...) is invoked with SortRequestControl and VirtualListViewRequestControl

Parameters:

request - search request to execute

params - virtual list view data

Returns:

search operation response

Throws:

LdapException - if the search fails

execute

public SearchResponse execute(SearchRequest request,
                              VirtualListViewParams params,
                              SearchResponse result)
                       throws LdapException

Performs a search operation with the VirtualListViewRequestControl. The supplied request is modified in the following way:

• AbstractRequestMessage.setControls( org.ldaptive.control.RequestControl...) is invoked with SortRequestControl and VirtualListViewRequestControl

The content count and context id are extracted from the supplied response and replayed as appropriate in the request.

Parameters:

request - search request to execute

params - virtual list view data

result - of a previous VLV operation

Returns:

search operation response

Throws:

LdapException - if the search fails