com.unboundid.ldap.sdk.controls
Class VirtualListViewResponseControl

java.lang.Object
  extended by com.unboundid.ldap.sdk.Control
      extended by com.unboundid.ldap.sdk.controls.VirtualListViewResponseControl
All Implemented Interfaces:
DecodeableControl, java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class VirtualListViewResponseControl
extends Control
implements DecodeableControl

This class provides an implementation of the virtual list view (VLV) response control, as defined in draft-ietf-ldapext-ldapv3-vlv. It may be used to provide information about the result of virtual list view processing for a search containing the VirtualListViewRequestControl.

The virtual list view response control may include the following elements:

See Also:
Serialized Form

Field Summary
static java.lang.String VIRTUAL_LIST_VIEW_RESPONSE_OID
          The OID (2.16.840.1.113730.3.4.10) for the virtual list view response control.
 
Constructor Summary
VirtualListViewResponseControl(int targetPosition, int contentCount, ResultCode resultCode, ASN1OctetString contextID)
          Creates a new virtual list view response control with the provided information.
VirtualListViewResponseControl(java.lang.String oid, boolean isCritical, ASN1OctetString value)
          Creates a new virtual list view response control from the information contained in the provided control.
 
Method Summary
 VirtualListViewResponseControl decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value)
          Creates a new instance of this decodeable control from the provided information.
static VirtualListViewResponseControl get(SearchResult result)
          Extracts a virtual list view response control from the provided result.
 int getContentCount()
          Retrieves the estimated total number of entries in the result set.
 ASN1OctetString getContextID()
          Retrieves the context ID for this virtual list view response control, if available.
 java.lang.String getControlName()
          Retrieves the user-friendly name for this control, if available.
 ResultCode getResultCode()
          Retrieves the result code for this virtual list view response control.
 int getTargetPosition()
          Retrieves the offset of the target entry for this virtual list view response control.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this LDAP control to the provided buffer.
 
Methods inherited from class com.unboundid.ldap.sdk.Control
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, toString, writeTo
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

VIRTUAL_LIST_VIEW_RESPONSE_OID

public static final java.lang.String VIRTUAL_LIST_VIEW_RESPONSE_OID
The OID (2.16.840.1.113730.3.4.10) for the virtual list view response control.

See Also:
Constant Field Values
Constructor Detail

VirtualListViewResponseControl

public VirtualListViewResponseControl(int targetPosition,
                                      int contentCount,
                                      ResultCode resultCode,
                                      ASN1OctetString contextID)
Creates a new virtual list view response control with the provided information. It will not be marked critical.

Parameters:
targetPosition - The offset of the target entry for this VLV response control.
contentCount - The estimated total number of entries in the result set.
resultCode - The result code for this VLV response control.
contextID - The context ID for this VLV response control. It may be null if no context ID is available.

VirtualListViewResponseControl

public VirtualListViewResponseControl(java.lang.String oid,
                                      boolean isCritical,
                                      ASN1OctetString value)
                               throws LDAPException
Creates a new virtual list view response control from the information contained in the provided control.

Parameters:
oid - The OID for the control.
isCritical - Indicates whether the control should be marked critical.
value - The encoded value for the control. This may be null if no value was provided.
Throws:
LDAPException - If a problem occurs while attempting to decode the provided control as a virtual list view response control.
Method Detail

decodeControl

public VirtualListViewResponseControl decodeControl(java.lang.String oid,
                                                    boolean isCritical,
                                                    ASN1OctetString value)
                                             throws LDAPException
Creates a new instance of this decodeable control from the provided information.

Specified by:
decodeControl in interface DecodeableControl
Parameters:
oid - The OID for the control.
isCritical - Indicates whether the control should be marked critical.
value - The encoded value for the control. This may be null if no value was provided.
Returns:
The decoded representation of this control.
Throws:
LDAPException - If the provided information cannot be decoded as a valid instance of this decodeable control.

get

public static VirtualListViewResponseControl get(SearchResult result)
                                          throws LDAPException
Extracts a virtual list view response control from the provided result.

Parameters:
result - The result from which to retrieve the virtual list view response control.
Returns:
The virtual list view response control contained in the provided result, or null if the result did not contain a virtual list view response control.
Throws:
LDAPException - If a problem is encountered while attempting to decode the virtual list view response control contained in the provided result.

getTargetPosition

public int getTargetPosition()
Retrieves the offset of the target entry for this virtual list view response control.

Returns:
The offset of the target entry for this virtual list view response control.

getContentCount

public int getContentCount()
Retrieves the estimated total number of entries in the result set.

Returns:
The estimated total number of entries in the result set.

getResultCode

public ResultCode getResultCode()
Retrieves the result code for this virtual list view response control.

Returns:
The result code for this virtual list view response control.

getContextID

public ASN1OctetString getContextID()
Retrieves the context ID for this virtual list view response control, if available.

Returns:
The context ID for this virtual list view response control, or null if none was provided.

getControlName

public java.lang.String getControlName()
Retrieves the user-friendly name for this control, if available. If no user-friendly name has been defined, then the OID will be returned.

Overrides:
getControlName in class Control
Returns:
The user-friendly name for this control, or the OID if no user-friendly name is available.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP control to the provided buffer.

Overrides:
toString in class Control
Parameters:
buffer - The buffer to which to append the string representation of this buffer.