java.lang.Object | ||
↳ | javax.naming.ldap.BasicControl | |
↳ | javax.naming.ldap.PagedResultsResponseControl |
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 }
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | OID | The paged-results response control's assigned object identifier is 1.2.840.113556.1.4.319. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface
javax.naming.ldap.Control
|
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
javax.naming.ldap.BasicControl
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a paged-results response control.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Retrieves the server-generated cookie.
| |||||||||||
Retrieves (an estimate of) the number of entries in the search result.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
javax.naming.ldap.BasicControl
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
javax.naming.ldap.Control
|
The paged-results response control's assigned object identifier is 1.2.840.113556.1.4.319.
Constructs a paged-results response control.
id | The control's object identifier string. |
---|---|
criticality | The control's criticality. |
value | The control's ASN.1 BER encoded value. It is not cloned - any changes to value will affect the contents of the control. |
IOException | If an error was encountered while decoding the control's value. |
---|
Retrieves the server-generated cookie. Null is returned when there are no more entries for the server to return.
Retrieves (an estimate of) the number of entries in the search result.