|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.types.Control
org.opends.server.controls.VLVRequestControl
public class VLVRequestControl
This class implements the virtual list view request controls as defined in
draft-ietf-ldapext-ldapv3-vlv. The ASN.1 description for the control value
is:
VirtualListViewRequest ::= SEQUENCE { beforeCount INTEGER (0..maxInt), afterCount INTEGER (0..maxInt), target CHOICE { byOffset [0] SEQUENCE { offset INTEGER (1 .. maxInt), contentCount INTEGER (0 .. maxInt) }, greaterThanOrEqual [1] AssertionValue }, contextID OCTET STRING OPTIONAL }
Field Summary | |
---|---|
static byte |
TYPE_TARGET_BYOFFSET
The BER type to use when encoding the byOffset target element. |
static byte |
TYPE_TARGET_GREATERTHANOREQUAL
The BER type to use when encoding the greaterThanOrEqual target element. |
Constructor Summary | |
---|---|
VLVRequestControl(int beforeCount,
int afterCount,
ByteString greaterThanOrEqual)
Creates a new VLV request control with the provided information. |
|
VLVRequestControl(int beforeCount,
int afterCount,
ByteString greaterThanOrEqual,
ByteString contextID)
Creates a new VLV request control with the provided information. |
|
VLVRequestControl(int beforeCount,
int afterCount,
int offset,
int contentCount)
Creates a new VLV request control with the provided information. |
|
VLVRequestControl(int beforeCount,
int afterCount,
int offset,
int contentCount,
ByteString contextID)
Creates a new VLV request control with the provided information. |
Method Summary | |
---|---|
static VLVRequestControl |
decodeControl(Control control)
Creates a new VLV request control from the contents of the provided control. |
int |
getAfterCount()
Retrieves the number of entries after the target offset or assertion value to include in the results page. |
int |
getBeforeCount()
Retrieves the number of entries before the target offset or assertion value to include in the results page. |
int |
getContentCount()
Retrieves the content count indicating the estimated number of entries in the complete result set. |
ByteString |
getContextID()
Retrieves a context ID value that should be used to resume a previous VLV results session. |
ByteString |
getGreaterThanOrEqualAssertion()
Retrieves the assertion value that will be used to locate the beginning of the results page. |
int |
getOffset()
Retrieves the offset that indicates the beginning of the results page. |
byte |
getTargetType()
Retrieves the BER type for the target that specifies the beginning of the results page. |
java.lang.String |
toString()
Retrieves a string representation of this VLV request control. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this VLV request control to the provided buffer. |
Methods inherited from class org.opends.server.types.Control |
---|
getOID, getValue, hasValue, isCritical, setCritical, setOID, setValue |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final byte TYPE_TARGET_BYOFFSET
public static final byte TYPE_TARGET_GREATERTHANOREQUAL
Constructor Detail |
---|
public VLVRequestControl(int beforeCount, int afterCount, int offset, int contentCount)
beforeCount
- The number of entries before the target offset to
retrieve in the results page.afterCount
- The number of entries after the target offset to
retrieve in the results page.offset
- The offset in the result set to target for the
beginning of the page of results.contentCount
- The content count returned by the server in the last
phase of the VLV request, or zero for a new VLV
request session.public VLVRequestControl(int beforeCount, int afterCount, int offset, int contentCount, ByteString contextID)
beforeCount
- The number of entries before the target offset to
retrieve in the results page.afterCount
- The number of entries after the target offset to
retrieve in the results page.offset
- The offset in the result set to target for the
beginning of the page of results.contentCount
- The content count returned by the server in the last
phase of the VLV request, or zero for a new VLV
request session.contextID
- The context ID provided by the server in the last
VLV response for the same set of criteria, or
null
if there was no previous VLV response or
the server did not include a context ID in the
last response.public VLVRequestControl(int beforeCount, int afterCount, ByteString greaterThanOrEqual)
beforeCount
- The number of entries before the target offset
to retrieve in the results page.afterCount
- The number of entries after the target offset
to retrieve in the results page.greaterThanOrEqual
- The greaterThanOrEqual target assertion value
that indicates where to start the page of
results.public VLVRequestControl(int beforeCount, int afterCount, ByteString greaterThanOrEqual, ByteString contextID)
beforeCount
- The number of entries before the target
assertion value.afterCount
- The number of entries after the target
assertion value.greaterThanOrEqual
- The greaterThanOrEqual target assertion value
that indicates where to start the page of
results.contextID
- The context ID provided by the server in the
last VLV response for the same set of criteria,
or null
if there was no previous VLV
response or the server did not include a
context ID in the last response.Method Detail |
---|
public int getBeforeCount()
public int getAfterCount()
public byte getTargetType()
TYPE_TARGET_BYOFFSET
if the beginning of the results page
should be specified as a nuemric offset, or
TYPE_TARGET_GREATERTHANOREQUAL
if it should be specified
by an assertion value.public int getOffset()
getTargetType
method
returns TYPE_TARGET_BYOFFSET
.
public int getContentCount()
getTargetType
method returns TYPE_TARGET_BYOFFSET
.
public ByteString getGreaterThanOrEqualAssertion()
getTargetType
method returns
TYPE_TARGET_GREATERTHANOREQUAL
.
null
if the beginning of the results
page is to be specified using an offset.public ByteString getContextID()
null
if none is available.public static VLVRequestControl decodeControl(Control control) throws LDAPException
control
- The generic control containing the information to use to
create this VLV request control. It must not be
null
.
LDAPException
- If this control cannot be decoded as a valid VLV
request control.public java.lang.String toString()
toString
in class Control
public void toString(java.lang.StringBuilder buffer)
toString
in class Control
buffer
- The buffer to which the information should be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |