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.

Version:

$Revision: 2885 $ $Date: 2014-02-05 16:28:49 -0500 (Wed, 05 Feb 2014) $

Author:

Middleware Services

Field Summary

protected org.slf4j.Logger

logger Logger for this class.

Constructor Summary

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

Method Summary

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 org.slf4j.Logger logger

Logger for this class.

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