public class VLVRequestControl extends Control
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 }
Modifier and Type | Field and Description |
---|---|
static ControlDecoder<VLVRequestControl> |
DECODER
The Control Decoder that can be used to decode this control.
|
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 and Description |
---|
VLVRequestControl(boolean isCritical,
int beforeCount,
int afterCount,
org.forgerock.opendj.ldap.ByteString greaterThanOrEqual,
org.forgerock.opendj.ldap.ByteString contextID)
Creates a new VLV request control with the provided information.
|
VLVRequestControl(boolean isCritical,
int beforeCount,
int afterCount,
int offset,
int contentCount,
org.forgerock.opendj.ldap.ByteString contextID)
Creates a new VLV request control with the provided information.
|
VLVRequestControl(int beforeCount,
int afterCount,
org.forgerock.opendj.ldap.ByteString greaterThanOrEqual)
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.
|
Modifier and Type | Method and Description |
---|---|
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.
|
org.forgerock.opendj.ldap.ByteString |
getContextID()
Retrieves a context ID value that should be used to resume a previous VLV
results session.
|
org.forgerock.opendj.ldap.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.
|
void |
toString(StringBuilder buffer)
Appends a string representation of this VLV request control to the provided
buffer.
|
protected void |
writeValue(org.forgerock.opendj.io.Asn1Writer writer)
Writes this control's value to an ASN.1 writer.
|
getOid, isCritical, toString, write
public static final ControlDecoder<VLVRequestControl> DECODER
public static final byte TYPE_TARGET_BYOFFSET
public static final byte TYPE_TARGET_GREATERTHANOREQUAL
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(boolean isCritical, int beforeCount, int afterCount, int offset, int contentCount, org.forgerock.opendj.ldap.ByteString contextID)
isCritical
- Indicates whether the control is critical.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, org.forgerock.opendj.ldap.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(boolean isCritical, int beforeCount, int afterCount, org.forgerock.opendj.ldap.ByteString greaterThanOrEqual, org.forgerock.opendj.ldap.ByteString contextID)
isCritical
- Indicates whether the control should be
considered critical.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.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 org.forgerock.opendj.ldap.ByteString getGreaterThanOrEqualAssertion()
getTargetType
method returns
TYPE_TARGET_GREATERTHANOREQUAL
.null
if the beginning of the results
page is to be specified using an offset.public org.forgerock.opendj.ldap.ByteString getContextID()
null
if none is available.protected void writeValue(org.forgerock.opendj.io.Asn1Writer writer) throws IOException
writeValue
in class Control
writer
- The ASN.1 writer to use.IOException
- If a problem occurs while writing to the stream.public void toString(StringBuilder buffer)
Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.