org.ldaptive.control.util

Class PagedResultsClient

java.lang.Object

org.ldaptive.control.util.PagedResultsClient

public class PagedResultsClient
extends Object

Client that simplifies using the paged results 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 int	resultSize Results page size.

Constructor Summary

Constructors

Constructor and Description
PagedResultsClient(Connection conn, int size) Creates a new paged results client.

Method Summary

Modifier and Type	Method and Description
Response<SearchResult>	execute(SearchRequest request) Performs a search operation with the PagedResultsControl.
Response<SearchResult>	execute(SearchRequest request, CookieManager manager) Performs a search operation with the PagedResultsControl.
Response<SearchResult>	execute(SearchRequest request, Response<SearchResult> response) Performs a search operation with the PagedResultsControl.
Response<SearchResult>	executeToCompletion(SearchRequest request) Performs a search operation with the PagedResultsControl.
Response<SearchResult>	executeToCompletion(SearchRequest request, CookieManager manager) Performs a search operation with the PagedResultsControl.
protected byte[]	getPagedResultsCookie(Response<SearchResult> response) Returns the paged results cookie in the supplied response or null if no cookie exists.
boolean	hasMore(Response<SearchResult> response) Returns whether execute(SearchRequest, Response) can be invoked again.

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.

resultSize

private final int resultSize

Results page size.

Constructor Detail

PagedResultsClient

public PagedResultsClient(Connection conn,
                          int size)

Creates a new paged results client.

Parameters:

conn - to execute the search operation on

size - the results page size to request

Method Detail

execute

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

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

• AbstractRequest.setControls( org.ldaptive.control.RequestControl...) is invoked with PagedResultsControl

Parameters:

request - search request to execute

Returns:

search operation response

Throws:

LdapException - if the search fails

execute

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

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

• AbstractRequest.setControls( org.ldaptive.control.RequestControl...) is invoked with PagedResultsControl

The cookie is extracted from the supplied response and replayed in the request.

Parameters:

request - search request to execute

response - of a previous paged results operation

Returns:

search operation response

Throws:

LdapException - if the search fails

execute

public Response<SearchResult> execute(SearchRequest request,
                                      CookieManager manager)
                               throws LdapException

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

• AbstractRequest.setControls( org.ldaptive.control.RequestControl...) is invoked with PagedResultsControl

The cookie used in the request is read from the cookie manager and written to the cookie manager after a successful search, if the response contains a cookie.

Parameters:

request - search request to execute

manager - for reading and writing cookies

Returns:

search operation response

Throws:

LdapException - if the search fails

hasMore

public boolean hasMore(Response<SearchResult> response)

Returns whether execute(SearchRequest, Response) can be invoked again.

Parameters:

response - of a previous paged results operation

Returns:

whether more paged search results can be retrieved from the server

executeToCompletion

public Response<SearchResult> executeToCompletion(SearchRequest request)
                                           throws LdapException

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

• AbstractRequest.setControls( org.ldaptive.control.RequestControl...) is invoked with PagedResultsControl

This method will continue to execute search operations until all paged search results have been retrieved from the server. The returned response contains the response data of the last paged result operation plus the entries and references returned by all previous search operations.

Parameters:

request - search request to execute

Returns:

search operation response of the last paged result operation

Throws:

LdapException - if the search fails

executeToCompletion

public Response<SearchResult> executeToCompletion(SearchRequest request,
                                                  CookieManager manager)
                                           throws LdapException

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

• AbstractRequest.setControls( org.ldaptive.control.RequestControl...) is invoked with PagedResultsControl

This method will continue to execute search operations until all paged search results have been retrieved from the server. The returned response contains the response data of the last paged result operation plus the entries and references returned by all previous search operations.

The cookie used for each request is read from the cookie manager and written to the cookie manager after a successful search, if the response contains a cookie.

Parameters:

request - search request to execute

manager - for reading and writing cookies

Returns:

search operation response of the last paged result operation

Throws:

LdapException - if the search fails

getPagedResultsCookie

protected byte[] getPagedResultsCookie(Response<SearchResult> response)

Returns the paged results cookie in the supplied response or null if no cookie exists.

Parameters:

response - of a previous paged results operation

Returns:

paged results cookie or null