Class ServerSideSortResponseControl

    • Constructor Detail

      • ServerSideSortResponseControl

        public ServerSideSortResponseControl​(ResultCode resultCode,
                                             java.lang.String attributeName)
        Creates a new server-side sort response control with the provided information.
        Parameters:
        resultCode - The result code for this server-side sort response.
        attributeName - The name of the attribute associated with this result. It may be null if there is no associated attribute name.
      • ServerSideSortResponseControl

        public ServerSideSortResponseControl​(ResultCode resultCode,
                                             java.lang.String attributeName,
                                             boolean isCritical)
        Creates a new server-side sort response control with the provided information.
        Parameters:
        resultCode - The result code for this server-side sort response.
        attributeName - The name of the attribute associated with this result. It may be null if there is no associated attribute name.
        isCritical - Indicates whether this control should be marked critical. Response controls should generally not be critical.
      • ServerSideSortResponseControl

        public ServerSideSortResponseControl​(java.lang.String oid,
                                             boolean isCritical,
                                             ASN1OctetString value)
                                      throws LDAPException
        Creates a new server-side sort 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 server-side sort response control.
    • Method Detail

      • decodeControl

        public ServerSideSortResponseControl 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 ServerSideSortResponseControl get​(SearchResult result)
                                                 throws LDAPException
        Extracts a server-side sort response control from the provided result.
        Parameters:
        result - The result from which to retrieve the server-side sort response control.
        Returns:
        The server-side sort response control contained in the provided result, or null if the result did not contain a server-side sort response control.
        Throws:
        LDAPException - If a problem is encountered while attempting to decode the server-side sort response control contained in the provided result.
      • getResultCode

        public ResultCode getResultCode()
        Retrieves the result code for this server-side sort response control.
        Returns:
        The result code for this server-side sort response control.
      • getAttributeName

        public java.lang.String getAttributeName()
        Retrieves the attribute name for this server-side sort response control, if available.
        Returns:
        The attribute name for this server-side sort 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.