public final class PagedResultsResponseControl extends BasicControl
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 }
PagedResultsControl
, Serialized Formpublic static final String OID
The paged-results response control's assigned object identifier is 1.2.840.113556.1.4.319.
public PagedResultsResponseControl(String id, boolean criticality, byte[] value) throws IOException
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.public int getResultSize()
Retrieves (an estimate of) the number of entries in the search result.
public byte[] getCookie()
Retrieves the server-generated cookie. Null is returned when there are no more entries for the server to return.
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.