org.opends.server.types
Class CanceledOperationException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by org.opends.server.types.OpenDsException
              extended by org.opends.server.types.IdentifiedException
                  extended by org.opends.server.types.CanceledOperationException
All Implemented Interfaces:
java.io.Serializable

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=true,
           mayExtend=false,
           mayInvoke=true)
public final class CanceledOperationException
extends IdentifiedException

This class defines an exception that may be thrown if the operation being processed is cancelled for some reason (e.g., an abandon or cancel request from the client).

See Also:
Serialized Form

Constructor Summary
CanceledOperationException(CancelRequest cancelRequest)
          Creates a new cancelled operation exception with the provided result and no additional message.
CanceledOperationException(CancelRequest cancelRequest, Message message)
          Creates a new cancelled operation exception with the provided information.
 
Method Summary
 CancelRequest getCancelRequest()
          Retrieves the cancel request for this cancelled operation exception.
 
Methods inherited from class org.opends.server.types.OpenDsException
getMessageObject
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CanceledOperationException

public CanceledOperationException(CancelRequest cancelRequest)
Creates a new cancelled operation exception with the provided result and no additional message.

Parameters:
cancelRequest - The result of the cancel processing.

CanceledOperationException

public CanceledOperationException(CancelRequest cancelRequest,
                                  Message message)
Creates a new cancelled operation exception with the provided information.

Parameters:
cancelRequest - The request of the cancel processing.
message - The message providing additional information about the cancel processing, or null if there is no message.
Method Detail

getCancelRequest

public CancelRequest getCancelRequest()
Retrieves the cancel request for this cancelled operation exception.

Returns:
The cancel request for this cancelled operation exception.