Class UnsolicitedCancelResponseControl
- java.lang.Object
-
- com.unboundid.ldap.sdk.Control
-
- com.unboundid.ldap.sdk.unboundidds.controls.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
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
UNSOLICITED_CANCEL_RESPONSE_OID
The OID (1.3.6.1.4.1.30221.2.5.7) for the unsolicited cancel response control.
-
Constructor Summary
Constructors Constructor Description UnsolicitedCancelResponseControl()
Creates a new unsolicited cancel response control.UnsolicitedCancelResponseControl(java.lang.String oid, boolean isCritical, ASN1OctetString value)
Creates a new account usable response control with the provided information.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description UnsolicitedCancelResponseControl
decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value)
Creates a new instance of this decodeable control from the provided information.static UnsolicitedCancelResponseControl
decodeJSONControl(JSONObject controlObject, boolean strict)
Attempts to decode the provided object as a JSON representation of an unsolicited cancel response control.static UnsolicitedCancelResponseControl
get(LDAPResult result)
Extracts an unsolicited cancel response control from the provided result.java.lang.String
getControlName()
Retrieves the user-friendly name for this control, if available.JSONObject
toJSONControl()
Retrieves a representation of this unsolicited cancel response control as a JSON object.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP control to the provided buffer.-
Methods inherited from class com.unboundid.ldap.sdk.Control
decode, decode, decodeControls, decodeJSONControl, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo
-
-
-
-
Field Detail
-
UNSOLICITED_CANCEL_RESPONSE_OID
@NotNull public static final java.lang.String UNSOLICITED_CANCEL_RESPONSE_OID
The OID (1.3.6.1.4.1.30221.2.5.7) for the unsolicited cancel response control.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
UnsolicitedCancelResponseControl
public UnsolicitedCancelResponseControl()
Creates a new unsolicited cancel response control.
-
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 benull
if no value was provided.- Throws:
LDAPException
- If the provided control cannot be decoded as an account usable response control.
-
-
Method Detail
-
decodeControl
@NotNull public UnsolicitedCancelResponseControl 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 interfaceDecodeableControl
- 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 benull
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 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 classControl
- 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 thevalue-base64
norvalue-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, theoid
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 classControl
- 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 benull
.strict
- Indicates whether to use strict mode when decoding the provided JSON object. If this istrue
, then this method will throw an exception if the provided JSON object contains any unrecognized fields. If this isfalse
, 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.
-
-