public interface PagedResults extends Control
This control is included in the searchRequest and searchResultDone messages as part of the controls field of the LDAPMessage, as defined in Section 4.1.12 of [LDAPv3]. The structure of this control is as follows: pagedResultsControl ::= SEQUENCE { controlType 1.2.840.113556.1.4.319, criticality BOOLEAN DEFAULT FALSE, controlValue searchControlValue } The searchControlValue is an OCTET STRING wrapping the BER-encoded version of the following SEQUENCE: realSearchControlValue ::= SEQUENCE { size INTEGER (0..maxInt), -- requested page size from client -- result set size estimate from server cookie OCTET STRING }
Modifier and Type | Field and Description |
---|---|
static String |
OID
The Paged Search Control OID
|
Modifier and Type | Method and Description |
---|---|
byte[] |
getCookie() |
int |
getCookieValue() |
int |
getSize() |
void |
setCookie(byte[] cookie)
Set the cookie
|
void |
setSize(int size)
Set the number of entry requested or returned
|
getOid, isCritical, setCritical
static final String OID
int getSize()
void setSize(int size)
size
- The number of entriesbyte[] getCookie()
void setCookie(byte[] cookie)
cookie
- The cookie to store in this controlint getCookieValue()
Copyright © 2003–2020 The Apache Software Foundation. All rights reserved.