public class PagedResultsControl extends Control
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 ControlDecoder<PagedResultsControl> |
DECODER
The Control Decoder that can be used to decode this control.
|
Constructor and Description |
---|
PagedResultsControl(boolean isCritical,
int size,
ByteString cookie)
Creates a new paged results control with the specified information.
|
Modifier and Type | Method and Description |
---|---|
ByteString |
getCookie()
Get the control value cookie element.
|
int |
getSize()
Get the control value size element, which is either the requested page size from the client, or the result set
size estimate from the server.
|
ByteString |
getValue()
Returns the value, if any, associated with this control.
|
boolean |
hasValue()
Returns
true if this control has a value. |
void |
writeValue(Asn1Writer writer)
Writes this control's value to an ASN.1 writer.
|
getOid, getValueAdapter, isCritical, toString, toString, write
public static final ControlDecoder<PagedResultsControl> DECODER
public PagedResultsControl(boolean isCritical, int size, ByteString cookie)
isCritical
- Indicates whether this control should be considered critical in processing the request.size
- The size element.cookie
- The cookie element.public boolean hasValue()
Control
true
if this control has a value. In some circumstances
it may be useful to determine if a control has a value, without actually
calculating the value and incurring any performance costs.true
if this control has a value, or false
if
there is no value.public ByteString getValue()
Control
public void writeValue(Asn1Writer writer) throws IOException
Control
writeValue
in class Control
writer
- The ASN.1 writer to use.IOException
- If a problem occurs while writing to the stream.public int getSize()
public ByteString getCookie()
Copyright 2010-2020 ForgeRock AS.