public class VLVResponseControl extends Control
VirtualListViewResponse ::= SEQUENCE { targetPosition INTEGER (0 .. maxInt), contentCount INTEGER (0 .. maxInt), virtualListViewResult ENUMERATED { success (0), operationsError (1), protocolError (3), unwillingToPerform (53), insufficientAccessRights (50), timeLimitExceeded (3), adminLimitExceeded (11), inappropriateMatching (18), sortControlMissing (60), offsetRangeError (61), other(80), ... }, contextID OCTET STRING OPTIONAL }
Modifier and Type | Field and Description |
---|---|
static ControlDecoder<VLVResponseControl> |
DECODER
The Control Decoder that can be used to decode this control.
|
Constructor and Description |
---|
VLVResponseControl(boolean isCritical,
int targetPosition,
int contentCount,
int vlvResultCode,
org.forgerock.opendj.ldap.ByteString contextID)
Creates a new VLV response control with the provided information.
|
VLVResponseControl(int targetPosition,
int contentCount,
int vlvResultCode)
Creates a new VLV response control with the provided information.
|
Modifier and Type | Method and Description |
---|---|
int |
getContentCount()
Retrieves the estimated total number of entries in the result set.
|
org.forgerock.opendj.ldap.ByteString |
getContextID()
Retrieves a context ID value that should be included in the next request
to retrieve a page of the same result set.
|
int |
getTargetPosition()
Retrieves the position of the target entry in the result set.
|
int |
getVLVResultCode()
Retrieves the result code for the VLV operation.
|
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<VLVResponseControl> DECODER
public VLVResponseControl(int targetPosition, int contentCount, int vlvResultCode)
targetPosition
- The position of the target entry in the result set.contentCount
- The content count estimating the total number of
entries in the result set.vlvResultCode
- The result code for the VLV operation.public VLVResponseControl(boolean isCritical, int targetPosition, int contentCount, int vlvResultCode, org.forgerock.opendj.ldap.ByteString contextID)
isCritical
- Indicates whether the control should be considered
critical.targetPosition
- The position of the target entry in the result set.contentCount
- The content count estimating the total number of
entries in the result set.vlvResultCode
- The result code for the VLV operation.contextID
- The context ID for this VLV response control.public int getTargetPosition()
public int getContentCount()
public int getVLVResultCode()
public org.forgerock.opendj.ldap.ByteString getContextID()
null
if there
is no context ID.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.