oracle.oud.controls

Interface SimplePagedResultsControl

All Superinterfaces:

Control

public interface SimplePagedResultsControl
extends Control

The simple paged results request and response control as defined in RFC 2696. This control allows a client to control the rate at which an LDAP server returns the results of an LDAP search operation. This control may be useful when the LDAP client has limited resources and may not be able to process the entire result set from a given LDAP query, or when the LDAP client is connected over a low-bandwidth connection.

This control is included in the searchRequest and searchResultDone messages and has the following structure:

 realSearchControlValue ::= SEQUENCE {
         size            INTEGER (0..maxInt),
                                 -- requested page size from client
                                 -- result set size estimate from server
         cookie          OCTET STRING
 }
 

See Also:

RFC 2696 - LDAP Control Extension for Simple Paged Results Manipulation

Field Summary

Fields

Modifier and Type	Field and Description
static ControlDecoder<SimplePagedResultsControl>	DECODER A decoder which can be used for decoding the simple paged results request and response control.

Method Summary

Modifier and Type	Method and Description
ByteString	getCookie() Returns the opaque cookie which is used by the server to track its position in the set of search results.
int	getSize() Returns the requested page size when used in a request control from the client, or an estimate of the result set size when used in a response control from the server (may be 0, indicating that the server does not know).

Methods inherited from interface oracle.oud.controls.Control

getAPIValue, getOID, hasValue, isCritical

Field Detail

DECODER

static final ControlDecoder<SimplePagedResultsControl> DECODER

A decoder which can be used for decoding the simple paged results request and response control.

Method Detail

getCookie

ByteString getCookie()

Returns the opaque cookie which is used by the server to track its position in the set of search results. The cookie must be empty in the initial search request sent by the client. For subsequent search requests the client must include the cookie returned with the previous search result, until the server returns an empty cookie indicating that the final page of results has been returned.

Returns:

The opaque cookie which is used by the server to track its position in the set of search results.

getSize

int getSize()

Returns the requested page size when used in a request control from the client, or an estimate of the result set size when used in a response control from the server (may be 0, indicating that the server does not know).

Returns:

The requested page size when used in a request control from the client, or an estimate of the result set size when used in a response control from the server.