Serializable
, Control
public final class PagedResultsResponseControl extends BasicControl
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 }
Modifier and Type | Field | Description |
---|---|---|
static final String |
OID |
The paged-results response control's assigned object identifier is 1.2.840.113556.1.4.319. |
criticality, id, value
CRITICAL, NONCRITICAL
Constructor | Description |
---|---|
PagedResultsResponseControl |
Constructs a paged-results response control. |
Modifier and Type | Method | Description |
---|---|---|
byte[] |
getCookie() |
Retrieves the server-generated cookie. |
int |
getResultSize() |
Retrieves (an estimate of) the number of entries in the search result. |
getEncodedValue, getID, isCritical
public static final String OID
public PagedResultsResponseControl(String id, boolean criticality, byte[] value) throws IOException
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()
public byte[] getCookie()
© 1993, 2023, 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.
https://docs.oracle.com/en/java/javase/21/docs/api/java.naming/javax/naming/ldap/PagedResultsResponseControl.html