Class 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:
    • 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:
    Serialized Form
    • Constructor Detail

      • 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
                                              java.lang.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 Detail

      • decodeControl

        @NotNull
        public VirtualListViewResponseControl decodeControl​(@NotNull
                                                            java.lang.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 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​(@NotNull
                             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.