Package org.ldaptive.control
Class PagedResultsControl
java.lang.Object
org.ldaptive.control.AbstractControl
org.ldaptive.control.PagedResultsControl
- All Implemented Interfaces:
Control
,RequestControl
,ResponseControl
Request/response control for PagedResults. See RFC 2696. Control is defined as:
realSearchControlValue ::= SEQUENCE { size INTEGER (0..maxInt), -- requested page size from client -- result set size estimate from server cookie OCTET STRING }
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
Parse handler implementation for the cookie.private static class
Parse handler implementation for the size. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate byte[]
server generated cookie.private static final byte[]
Empty byte array used for null cookies.private static final int
hash code seed.static final String
OID of this control.private int
paged results size.Fields inherited from class org.ldaptive.control.AbstractControl
logger
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.PagedResultsControl
(boolean critical) Creates a new paged results control.PagedResultsControl
(int size) Creates a new paged results control.PagedResultsControl
(int size, boolean critical) Creates a new paged results control.PagedResultsControl
(int size, byte[] value, boolean critical) Creates a new paged results control. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Initializes this response control with the supplied BER encoded data.byte[]
encode()
Provides the BER encoding of this control.boolean
byte[]
Returns the paged results cookie.int
getSize()
Returns the paged results size.int
hashCode()
Returns the hash code for this object.boolean
hasValue()
Returns whether the control has a value associated with it.void
setCookie
(byte[] value) Sets the paged results cookie.void
setSize
(int size) Sets the paged results size.toString()
Methods inherited from class org.ldaptive.control.AbstractControl
getCriticality, getOID
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.ldaptive.control.Control
getCriticality, getOID
-
Field Details
-
OID
OID of this control.- See Also:
-
HASH_CODE_SEED
private static final int HASH_CODE_SEEDhash code seed.- See Also:
-
EMPTY_COOKIE
private static final byte[] EMPTY_COOKIEEmpty byte array used for null cookies. -
resultSize
private int resultSizepaged results size. -
cookie
private byte[] cookieserver generated cookie.
-
-
Constructor Details
-
PagedResultsControl
public PagedResultsControl()Default constructor. -
PagedResultsControl
public PagedResultsControl(boolean critical) Creates a new paged results control.- Parameters:
critical
- whether this control is critical
-
PagedResultsControl
public PagedResultsControl(int size) Creates a new paged results control.- Parameters:
size
- paged results size
-
PagedResultsControl
public PagedResultsControl(int size, boolean critical) Creates a new paged results control.- Parameters:
size
- paged results sizecritical
- whether this control is critical
-
PagedResultsControl
public PagedResultsControl(int size, byte[] value, boolean critical) Creates a new paged results control.- Parameters:
size
- paged results sizevalue
- paged results cookiecritical
- whether this control is critical
-
-
Method Details
-
hasValue
public boolean hasValue()Description copied from interface:RequestControl
Returns whether the control has a value associated with it.- Specified by:
hasValue
in interfaceRequestControl
- Returns:
- whether the control has a value
-
getSize
public int getSize()Returns the paged results size. For requests this is the requested page size. For responses this is the result size estimate from the server.- Returns:
- paged results size
-
setSize
public void setSize(int size) Sets the paged results size. For requests this is the requested page size. For responses this is the result size estimate from the server.- Parameters:
size
- paged results size
-
getCookie
public byte[] getCookie()Returns the paged results cookie.- Returns:
- paged results cookie
-
setCookie
public void setCookie(byte[] value) Sets the paged results cookie.- Parameters:
value
- paged results cookie
-
equals
- Overrides:
equals
in classAbstractControl
-
hashCode
public int hashCode()Description copied from class:AbstractControl
Returns the hash code for this object.- Specified by:
hashCode
in classAbstractControl
- Returns:
- hash code
-
toString
- Overrides:
toString
in classAbstractControl
-
encode
public byte[] encode()Description copied from interface:RequestControl
Provides the BER encoding of this control.- Specified by:
encode
in interfaceRequestControl
- Returns:
- BER encoded request control
-
decode
Description copied from interface:ResponseControl
Initializes this response control with the supplied BER encoded data.- Specified by:
decode
in interfaceResponseControl
- Parameters:
encoded
- BER encoded response control
-