|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.unboundidds.controls.UnsolicitedCancelResponseControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class UnsolicitedCancelResponseControl
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.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.
Field Summary | |
---|---|
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 | |
---|---|
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 | |
---|---|
UnsolicitedCancelResponseControl |
decodeControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new instance of this decodeable control from the provided information. |
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. |
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, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, toString, writeTo |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String UNSOLICITED_CANCEL_RESPONSE_OID
Constructor Detail |
---|
public UnsolicitedCancelResponseControl()
public UnsolicitedCancelResponseControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
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.
LDAPException
- If the provided control cannot be decoded as an
account usable response control.Method Detail |
---|
public UnsolicitedCancelResponseControl decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
decodeControl
in interface DecodeableControl
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.
LDAPException
- If the provided information cannot be decoded as a
valid instance of this decodeable control.public static UnsolicitedCancelResponseControl get(LDAPResult result) throws LDAPException
result
- The result from which to retrieve the unsolicited cancel
response control.
null
if the result did not contain an
unsolicited cancel response control.
LDAPException
- If a problem is encountered while attempting to
decode the unsolicited cancel response control
contained in the provided result.public java.lang.String getControlName()
getControlName
in class Control
public void toString(java.lang.StringBuilder buffer)
toString
in class Control
buffer
- The buffer to which to append the string representation of
this buffer.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |