PagedResultsResponseControl JDK 1.6)

Description

publicfinal class PagedResultsResponseControl

Indicates the end of a batch of search results.

Indicates the end of a batch of search results. Contains an estimate of the total number of entries in the result set and an opaque cookie. The cookie must be supplied to the next search operation in order to get the next batch of results.

The code sample in PagedResultsControl shows how this class may be used.

This class implements the LDAPv3 Response Control for paged-results as defined in RFC 2696. The control's value has the following ASN.1 definition:


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

See also: PagedResultsControl

Constructors

public PagedResultsResponseControl (String id, boolean criticality, byte[] value) throws IOException

Constructs a paged-results response control.

Methods

Hide/Show inherited methods

public byte getCookie ()

Retrieves the server-generated cookie.

public byte getEncodedValue () [Inherited From BasicControl]

Retrieves the control's ASN.1 BER encoded value.

public String getID () [Inherited From BasicControl]

Retrieves the control's object identifier string.

public int getResultSize ()

Retrieves (an estimate of) the number of entries in the search result.

public boolean isCritical () [Inherited From BasicControl]

Determines the control's criticality.

Fields

Hide/Show inherited fields

protected boolean criticality [Inherited From BasicControl]

The control's criticality.

protected String id [Inherited From BasicControl]

The control's object identifier string.

publicfinalstatic String OID = "1.2.840.113556.1.4.319"

The paged-results response control's assigned object identifier is 1.2.840.113556.1.4.319.

protected byte value [Inherited From BasicControl]

The control's ASN.1 BER encoded value.