Package org.springframework.ldap.control

Class PagedResultsControlExchange

java.lang.Object

org.springframework.ldap.control.PagedResultsControlExchange

All Implemented Interfaces:

ControlExchange<PagedResultsControl,PagedResultsResponseControl>

public class PagedResultsControlExchange
extends Object
implements ControlExchange<PagedResultsControl,PagedResultsResponseControl>

A ControlExchange implementation for managing LDAP paged results request and response controls.

This class pairs a PagedResultsControl request with its corresponding PagedResultsResponseControl response. The paged results control allows clients to retrieve search results in pages of a specified size, with the response control providing a cookie for retrieving subsequent pages.

Instances of this class are immutable. The withResponse(PagedResultsResponseControl) method returns a new instance with an updated request control that includes the cookie from the response, ready for the next page request.

Since:

4.1

See Also:

• PagedResultsControl
• PagedResultsResponseControl
• ControlExchange
• RFC 2696 - LDAP Control Extension for Simple Paged Results Manipulation

Constructor Summary

Constructors

Constructor	Description
PagedResultsControlExchange(int pageSize)	Constructs a new paged results control exchange with the specified page size

Method Summary

Modifier and Type	Method	Description
PagedResultsControl	getRequest()	Returns the request control.
@Nullable PagedResultsResponseControl	getResponse()	Returns the response control, if one has been received.
PagedResultsControlExchange	withResponse(PagedResultsResponseControl response)	Creates a new exchange with an updated request control that includes the cookie from the response control.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PagedResultsControlExchange

public PagedResultsControlExchange(int pageSize)

Constructs a new paged results control exchange with the specified page size

Parameters:

pageSize - the number of entries to return in each page

Method Details

getRequest

public PagedResultsControl getRequest()

Returns the request control.

Specified by:

getRequest in interface ControlExchange<PagedResultsControl,PagedResultsResponseControl>

Returns:

the request control

getResponse

public @Nullable PagedResultsResponseControl getResponse()

Returns the response control, if one has been received.

Specified by:

getResponse in interface ControlExchange<PagedResultsControl,PagedResultsResponseControl>

Returns:

the response control, or null if no response has been received

withResponse

public PagedResultsControlExchange withResponse(PagedResultsResponseControl response)

Creates a new exchange with an updated request control that includes the cookie from the response control.

This method creates a new PagedResultsControlExchange.SpringLdapPagedResultsControl with the same page size and criticality as the current request, but with the cookie from the provided response. This prepares the control for requesting the next page of results.

Specified by:

withResponse in interface ControlExchange<PagedResultsControl,PagedResultsResponseControl>

Parameters:

response - the response control containing the cookie for the next page

Returns:

a new PagedResultsControlExchange with the updated request and the provided response