Package org.ldaptive.control.util
Class VirtualListViewClient
java.lang.Object
org.ldaptive.AbstractSearchOperationFactory
org.ldaptive.control.util.VirtualListViewClient
- All Implemented Interfaces:
ConnectionFactoryManager
Client that simplifies using the virtual list view control.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final org.slf4j.LoggerLogger for this class.private final SortRequestControlUsed on the search operation. -
Constructor Summary
ConstructorsConstructorDescriptionVirtualListViewClient(ConnectionFactory cf, SortKey... keys) Creates a new virtual list view client. -
Method Summary
Modifier and TypeMethodDescriptionexecute(SearchRequest request, VirtualListViewParams params) Performs a search operation with theVirtualListViewRequestControl.execute(SearchRequest request, VirtualListViewParams params, SearchResponse result) Performs a search operation with theVirtualListViewRequestControl.Methods inherited from class org.ldaptive.AbstractSearchOperationFactory
createSearchOperation, createSearchOperation, getConnectionFactory, getEntryHandlers, getExceptionHandler, getResultHandlers, getSearchResultHandlers, setConnectionFactory, setEntryHandlers, setExceptionHandler, setResultHandlers, setSearchResultHandlers
-
Field Details
-
logger
protected final org.slf4j.Logger loggerLogger for this class. -
sortControl
Used on the search operation.
-
-
Constructor Details
-
VirtualListViewClient
Creates a new virtual list view client.- Parameters:
cf- to get a connection fromkeys- to supply to a sort request control
-
-
Method Details
-
execute
public SearchResponse execute(SearchRequest request, VirtualListViewParams params) throws LdapException Performs a search operation with theVirtualListViewRequestControl. The supplied request is modified in the following way:- Parameters:
request- search request to executeparams- 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 theVirtualListViewRequestControl. The supplied request is modified in the following way:AbstractRequestMessage.setControls(org.ldaptive.control.RequestControl...)is invoked withSortRequestControlandVirtualListViewRequestControl
The content count and context id are extracted from the supplied response and replayed as appropriate in the request.
- Parameters:
request- search request to executeparams- virtual list view dataresult- of a previous VLV operation- Returns:
- search operation response
- Throws:
LdapException- if the search fails
-