Class UnsolicitedCancelResponseControl

  • All Implemented Interfaces:
    DecodeableControl, java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class UnsolicitedCancelResponseControl
    extends Control
    implements DecodeableControl
    This class provides an implementation of the unsolicited cancel response control, which may be returned by the Directory Server if an operation is canceled by the server without a cancel or abandon request from the client. This control does not have a value.
    NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
    See Also:
    Serialized Form
    • Constructor Detail

      • UnsolicitedCancelResponseControl

        public UnsolicitedCancelResponseControl​(java.lang.String oid,
                                                boolean isCritical,
                                                ASN1OctetString value)
                                         throws LDAPException
        Creates a new account usable response control with the provided information.
        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 the provided control cannot be decoded as an account usable response control.
    • Method Detail

      • decodeControl

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