Class CancelExtendedRequest
- java.lang.Object
-
- com.unboundid.ldap.sdk.LDAPRequest
-
- com.unboundid.ldap.sdk.ExtendedRequest
-
- com.unboundid.ldap.sdk.extensions.CancelExtendedRequest
-
- All Implemented Interfaces:
ProtocolOp
,ReadOnlyLDAPRequest
,java.io.Serializable
@NotMutable @ThreadSafety(level=NOT_THREADSAFE) public final class CancelExtendedRequest extends ExtendedRequest
This class provides an implementation of the LDAP cancel extended request as defined in RFC 3909. It may be used to request that the server interrupt processing on another operation in progress on the same connection. It behaves much like the abandon operation, with the exception that both the cancel request and the operation that is canceled will receive responses, whereas an abandon request never returns a response, and the operation that is abandoned will also not receive a response if the abandon is successful.
Example
The following example initiates an asynchronous modify operation and then attempts to cancel it:Modification mod = new Modification(ModificationType.REPLACE, "description", "This is the new description."); ModifyRequest modifyRequest = new ModifyRequest("dc=example,dc=com", mod); AsyncRequestID asyncRequestID = connection.asyncModify(modifyRequest, myAsyncResultListener); // Assume that we've waited a reasonable amount of time but the modify // hasn't completed yet so we'll try to cancel it. ExtendedResult cancelResult; try { cancelResult = connection.processExtendedOperation( new CancelExtendedRequest(asyncRequestID)); // This doesn't necessarily mean that the operation was successful, since // some kinds of extended operations (like cancel) return non-success // results under normal conditions. } catch (LDAPException le) { // For an extended operation, this generally means that a problem was // encountered while trying to send the request or read the result. cancelResult = new ExtendedResult(le); } switch (cancelResult.getResultCode().intValue()) { case ResultCode.CANCELED_INT_VALUE: // The modify operation was successfully canceled. break; case ResultCode.CANNOT_CANCEL_INT_VALUE: // This indicates that the server isn't capable of canceling that // type of operation. This probably won't happen for this kind of // modify operation, but it could happen for other kinds of operations. break; case ResultCode.TOO_LATE_INT_VALUE: // This indicates that the cancel request was received too late and the // server is intending to process the operation. break; case ResultCode.NO_SUCH_OPERATION_INT_VALUE: // This indicates that the server doesn't know anything about the // operation, most likely because it has already completed. break; default: // This suggests that the operation failed for some other reason. break; }
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CANCEL_REQUEST_OID
The OID (1.3.6.1.1.8) for the cancel extended request.-
Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE
-
-
Constructor Summary
Constructors Constructor Description CancelExtendedRequest(int targetMessageID)
Creates a new cancel extended request that will cancel the request with the specified message ID.CancelExtendedRequest(int targetMessageID, Control[] controls)
Creates a new cancel extended request that will cancel the request with the specified message ID.CancelExtendedRequest(AsyncRequestID requestID)
Creates a new cancel extended request that will cancel the request with the specified async request ID.CancelExtendedRequest(AsyncRequestID requestID, Control[] controls)
Creates a new cancel extended request that will cancel the request with the specified request ID.CancelExtendedRequest(ExtendedRequest extendedRequest)
Creates a new cancel extended request from the provided generic extended request.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CancelExtendedRequest
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request.CancelExtendedRequest
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request.java.lang.String
getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available.int
getTargetMessageID()
Retrieves the message ID of the request to cancel.protected ExtendedResult
process(LDAPConnection connection, int depth)
Sends this extended request to the directory server over the provided connection and returns the associated response.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer.-
Methods inherited from class com.unboundid.ldap.sdk.ExtendedRequest
encodeProtocolOp, getLastMessageID, getOID, getOperationType, getProtocolOpType, getValue, hasValue, responseReceived, toCode, writeTo
-
Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getReferralConnector, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setReferralConnector, setResponseTimeoutMillis, toString
-
-
-
-
Field Detail
-
CANCEL_REQUEST_OID
public static final java.lang.String CANCEL_REQUEST_OID
The OID (1.3.6.1.1.8) for the cancel extended request.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CancelExtendedRequest
public CancelExtendedRequest(AsyncRequestID requestID)
Creates a new cancel extended request that will cancel the request with the specified async request ID.- Parameters:
requestID
- The async request ID of the request to cancel. It must not benull
.
-
CancelExtendedRequest
public CancelExtendedRequest(int targetMessageID)
Creates a new cancel extended request that will cancel the request with the specified message ID.- Parameters:
targetMessageID
- The message ID of the request to cancel.
-
CancelExtendedRequest
public CancelExtendedRequest(AsyncRequestID requestID, Control[] controls)
Creates a new cancel extended request that will cancel the request with the specified request ID.- Parameters:
requestID
- The async request ID of the request to cancel. It must not benull
.controls
- The set of controls to include in the request.
-
CancelExtendedRequest
public CancelExtendedRequest(int targetMessageID, Control[] controls)
Creates a new cancel extended request that will cancel the request with the specified message ID.- Parameters:
targetMessageID
- The message ID of the request to cancel.controls
- The set of controls to include in the request.
-
CancelExtendedRequest
public CancelExtendedRequest(ExtendedRequest extendedRequest) throws LDAPException
Creates a new cancel extended request from the provided generic extended request.- Parameters:
extendedRequest
- The generic extended request to use to create this cancel extended request.- Throws:
LDAPException
- If a problem occurs while decoding the request.
-
-
Method Detail
-
process
protected ExtendedResult process(LDAPConnection connection, int depth) throws LDAPException
Sends this extended request to the directory server over the provided connection and returns the associated response.- Overrides:
process
in classExtendedRequest
- Parameters:
connection
- The connection to use to communicate with the directory server.depth
- The current referral depth for this request. It should always be one for the initial request, and should only be incremented when following referrals.- Returns:
- An LDAP result object that provides information about the result of the extended operation processing.
- Throws:
LDAPException
- If a problem occurs while sending the request or reading the response.
-
getTargetMessageID
public int getTargetMessageID()
Retrieves the message ID of the request to cancel.- Returns:
- The message ID of the request to cancel.
-
duplicate
public CancelExtendedRequest duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request.. Subclasses should override this method to return a duplicate of the appropriate type.- Specified by:
duplicate
in interfaceReadOnlyLDAPRequest
- Overrides:
duplicate
in classExtendedRequest
- Returns:
- A new instance of this LDAP request that may be modified without impacting this request.
-
duplicate
public CancelExtendedRequest duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. The provided controls will be used for the new request instead of duplicating the controls from this request.. Subclasses should override this method to return a duplicate of the appropriate type.- Specified by:
duplicate
in interfaceReadOnlyLDAPRequest
- Overrides:
duplicate
in classExtendedRequest
- Parameters:
controls
- The set of controls to include in the duplicate request.- Returns:
- A new instance of this LDAP request that may be modified without impacting this request.
-
getExtendedRequestName
public java.lang.String getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available. If no user-friendly name has been defined, then the OID will be returned.- Overrides:
getExtendedRequestName
in classExtendedRequest
- Returns:
- The user-friendly name for this extended request, or the OID if no user-friendly name is available.
-
toString
public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer.- Specified by:
toString
in interfaceProtocolOp
- Specified by:
toString
in interfaceReadOnlyLDAPRequest
- Overrides:
toString
in classExtendedRequest
- Parameters:
buffer
- The buffer to which to append a string representation of this request.
-
-