|
|||||||||
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.VLVResponseControl
public class VLVResponseControl
This class implements the virtual list view response controls as defined in
draft-ietf-ldapext-ldapv3-vlv. The ASN.1 description for the control value
is:
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), innapropriateMatching (18), sortControlMissing (60), offsetRangeError (61), other(80), ... }, contextID OCTET STRING OPTIONAL }
Constructor Summary | |
---|---|
VLVResponseControl(int targetPosition,
int contentCount,
int vlvResultCode)
Creates a new VLV response control with the provided information. |
|
VLVResponseControl(int targetPosition,
int contentCount,
int vlvResultCode,
ByteString contextID)
Creates a new VLV response control with the provided information. |
Method Summary | |
---|---|
static VLVResponseControl |
decodeControl(Control control)
Creates a new VLV response control from the contents of the provided control. |
int |
getContentCount()
Retrieves the estimated total number of entries in the result set. |
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. |
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 |
Constructor Detail |
---|
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(int targetPosition, int contentCount, int vlvResultCode, ByteString contextID)
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.Method Detail |
---|
public int getTargetPosition()
public int getContentCount()
public int getVLVResultCode()
public ByteString getContextID()
null
if there
is no context ID.public static VLVResponseControl decodeControl(Control control) throws LDAPException
control
- The generic control containing the information to use to
create this VLV response control. It must not be
null
.
LDAPException
- If this control cannot be decoded as a valid VLV
response 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 |