Package com.unboundid.ldap.sdk.controls

Class VirtualListViewResponseControl

java.lang.Object
com.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.controls.VirtualListViewResponseControl
All Implemented Interfaces:
DecodeableControl, 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:
  • resultCode -- A result code that indicates the result of the virtual list view processing. It may be the same as or different from the result code contained in the search result done message.
  • targetPosition -- The offset of the target entry specified by the client in the result set.
  • contentCount -- The estimated total number of entries in the entire result set.
  • contextID -- An optional cookie that the client should include in the next request as part of the virtual list view sequence.
See Also:

  • Field Details

  • Constructor Details

    • VirtualListViewResponseControl

      public VirtualListViewResponseControl(int targetPosition, int contentCount, @NotNull ResultCode resultCode, @Nullable 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(@NotNull String oid, boolean isCritical, @Nullable 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 Details

    • decodeControl

      @NotNull public VirtualListViewResponseControl decodeControl(@NotNull String oid, boolean isCritical, @Nullable 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

      @Nullable public static VirtualListViewResponseControl get(@NotNull 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

      @NotNull 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

      @Nullable 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

      @NotNull public 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.

    • toJSONControl

      @NotNull public JSONObject toJSONControl()
      Retrieves a representation of this virtual list view response control as a JSON object. The JSON object uses the following fields:
      • oid -- A mandatory string field whose value is the object identifier for this control. For the virtual list view response control, the OID is "2.16.840.1.113730.3.4.10".
      • control-name -- An optional string field whose value is a human-readable name for this control. This field is only intended for descriptive purposes, and when decoding a control, the oid field should be used to identify the type of control.
      • criticality -- A mandatory Boolean field used to indicate whether this control is considered critical.
      • value-base64 -- An optional string field whose value is a base64-encoded representation of the raw value for this virtual list view response control. Exactly one of the value-base64 and value-json fields must be present.
      • value-json -- An optional JSON object field whose value is a user-friendly representation of the value for this virtual list view response control. Exactly one of the value-base64 and value-json fields must be present, and if the value-json field is used, then it will use the following fields:
        • result-code -- An integer field whose value is the numeric representation of the result code for the virtual list view processing.
        • target-position -- An integer field whose value is the offset for the targeted entry in the entire result set. processing.
        • content-count -- An integer field whose value is the estimated total number of entries in the entire result set.
        • context-id -- An optional string field whose value represents an opaque cookie that may be used to help the server continue returning results in the series of VLV searches. The context ID value used in the JSON representation of the control will be a base64-encoded representation of the raw cookie value that would be used in the LDAP representation of the control, and it must be treated as an opaque blob by the client.
      Overrides:
      toJSONControl in class Control
      Returns:
      A JSON object that contains a representation of this control.

    • decodeJSONControl

      @NotNull public static VirtualListViewResponseControl decodeJSONControl(@NotNull JSONObject controlObject, boolean strict) throws LDAPException
      Attempts to decode the provided object as a JSON representation of a virtual list view response control.
      Parameters:
      controlObject - The JSON object to be decoded. It must not be null.
      strict - Indicates whether to use strict mode when decoding the provided JSON object. If this is true, then this method will throw an exception if the provided JSON object contains any unrecognized fields. If this is false, then unrecognized fields will be ignored.
      Returns:
      The virtual list view response control that was decoded from the provided JSON object.
      Throws:
      LDAPException - If the provided JSON object cannot be parsed as a valid virtual list view response control.

    • toString

      public void toString(@NotNull 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.