org.ldaptive.control.util

Class VirtualListViewClient

java.lang.Object

org.ldaptive.control.util.VirtualListViewClient

public class VirtualListViewClient
extends Object

Client that simplifies using the virtual list view control.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
VirtualListViewClient(Connection conn, SortKey... keys) Creates a new virtual list view client.

Method Summary

Modifier and Type	Method and Description
Response<SearchResult>	execute(SearchRequest request, VirtualListViewParams params) Performs a search operation with the VirtualListViewRequestControl.
Response<SearchResult>	execute(SearchRequest request, VirtualListViewParams params, Response<SearchResult> response) Performs a search operation with the VirtualListViewRequestControl.

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.

sortControl

private final SortRequestControl sortControl

Used on the search operation.

Constructor Detail

VirtualListViewClient

public VirtualListViewClient(Connection conn,
                             SortKey... keys)

Creates a new virtual list view client.

Parameters:

conn - to execute the search operation on

keys - to supply to a sort request control

Method Detail

execute

public Response<SearchResult> execute(SearchRequest request,
                                      VirtualListViewParams params)
                               throws LdapException

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

• AbstractRequest.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 Response<SearchResult> execute(SearchRequest request,
                                      VirtualListViewParams params,
                                      Response<SearchResult> response)
                               throws LdapException

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

• AbstractRequest.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

response - of a previous VLV operation

Returns:

search operation response

Throws:

LdapException - if the search fails