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​(@NotNull
                                                java.lang.String oid,
                                                boolean isCritical,
                                                @Nullable
                                                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

      • get

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

        @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.
      • toJSONControl

        @NotNull
        public JSONObject toJSONControl()
        Retrieves a representation of this unsolicited cancel response control as a JSON object. The JSON object uses the following fields (note that since this control does not have a value, neither the value-base64 nor value-json fields may be present):
        • oid -- A mandatory string field whose value is the object identifier for this control. For the unsolicited cancel response control, the OID is "1.3.6.1.4.1.30221.2.5.7".
        • 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.
        Overrides:
        toJSONControl in class Control
        Returns:
        A JSON object that contains a representation of this control.
      • decodeJSONControl

        @NotNull
        public static UnsolicitedCancelResponseControl decodeJSONControl​(@NotNull
                                                                         JSONObject controlObject,
                                                                         boolean strict)
                                                                  throws LDAPException
        Attempts to decode the provided object as a JSON representation of an unsolicited cancel 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 unsolicited cancel response control that was decoded from the provided JSON object.
        Throws:
        LDAPException - If the provided JSON object cannot be parsed as a valid unsolicited cancel response control.
      • 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.