Top Description Fields Constructors Methods
javax.naming.ldap

public final Class PagedResultsResponseControl

extends BasicControl
Class Inheritance
Imports
java.io.IOException, com.sun.jndi.ldap.Ber, .BerDecoder
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
    }
Author
Vincent Ryan
Since
1.5
See Also
PagedResultsControl

Field Summary

Modifier and TypeField and Description
private byte[]
cookie

A server-generated cookie.

public static final String
OID

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

private int
resultSize

An estimate of the number of entries in the search result.

private static final long
serialVersionUID

Hides javax.naming.ldap.BasicControl.serialVersionUID.

Inherited from javax.naming.ldap.BasicControl:
criticalityidvalue

Constructor Summary

AccessConstructor and Description
public
PagedResultsResponseControl(String
The control's object identifier string.
id, boolean
The control's criticality.
criticality, byte[]
The control's ASN.1 BER encoded value. It is not cloned - any changes to value will affect the contents of the control.
value)

Constructs a paged-results response control.

Method Summary

Modifier and TypeMethod and Description
public byte[]

Returns:

A possibly null server-generated cookie. It is not cloned - any changes to the cookie will update the control's state and thus are not recommended.
getCookie()

Retrieves the server-generated cookie.

public int

Returns:

The number of entries in the search result, or zero if unknown.
getResultSize()

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

Inherited from javax.naming.ldap.BasicControl:
getEncodedValuegetIDisCritical

Field Detail

OIDback to summary
public static final String OID

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

resultSizeback to summary
private int resultSize

An estimate of the number of entries in the search result.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.naming.ldap.BasicControl.serialVersionUID.

Constructor Detail

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

Constructs a paged-results response control.

Parameters
id:String

The control's object identifier string.

criticality:boolean

The control's criticality.

value:byte[]

The control's ASN.1 BER encoded value. It is not cloned - any changes to value will affect the contents of the control.

Exceptions
IOException:
If an error was encountered while decoding the control's value.

Method Detail

getCookieback to summary
public byte[] getCookie()

Retrieves the server-generated cookie. Null is returned when there are no more entries for the server to return.

Returns:byte[]

A possibly null server-generated cookie. It is not cloned - any changes to the cookie will update the control's state and thus are not recommended.

getResultSizeback to summary
public int getResultSize()

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

Returns:int

The number of entries in the search result, or zero if unknown.