org.opends.server.extensions
Class CancelExtendedOperation

java.lang.Object
  extended by org.opends.server.api.ExtendedOperationHandler<CancelExtendedOperationHandlerCfg>
      extended by org.opends.server.extensions.CancelExtendedOperation

public class CancelExtendedOperation
extends ExtendedOperationHandler<CancelExtendedOperationHandlerCfg>

This class implements the LDAP cancel extended operation defined in RFC 3909. It is similar to the LDAP abandon operation, with the exception that it requires a response for both the operation that is cancelled and the cancel request (whereas an abandon request never has a response, and if it is successful the abandoned operation won't get one either).


Constructor Summary
CancelExtendedOperation()
          Create an instance of this cancel extended operation.
 
Method Summary
 void finalizeExtendedOperationHandler()
          Performs any finalization that may be necessary for this extended operation handler.
 void initializeExtendedOperationHandler(CancelExtendedOperationHandlerCfg config)
          Initializes this extended operation handler based on the information in the provided configuration entry.
 void processExtendedOperation(ExtendedOperation operation)
          Processes the provided extended operation.
 
Methods inherited from class org.opends.server.api.ExtendedOperationHandler
deregisterControlsAndFeatures, getSupportedControls, getSupportedFeatures, isConfigurationAcceptable, registerControlsAndFeatures, supportsControl, supportsFeature
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CancelExtendedOperation

public CancelExtendedOperation()
Create an instance of this cancel extended operation. All initialization should be performed in the initializeExtendedOperationHandler method.

Method Detail

initializeExtendedOperationHandler

public void initializeExtendedOperationHandler(CancelExtendedOperationHandlerCfg config)
                                        throws ConfigException,
                                               InitializationException
Initializes this extended operation handler based on the information in the provided configuration entry. It should also register itself with the Directory Server for the particular kinds of extended operations that it will process.

Specified by:
initializeExtendedOperationHandler in class ExtendedOperationHandler<CancelExtendedOperationHandlerCfg>
Parameters:
config - The configuration that contains the information to use to initialize this extended operation handler.
Throws:
ConfigException - If an unrecoverable problem arises in the process of performing the initialization.
InitializationException - If a problem occurs during initialization that is not related to the server configuration.

finalizeExtendedOperationHandler

public void finalizeExtendedOperationHandler()
Performs any finalization that may be necessary for this extended operation handler. By default, no finalization is performed.

Overrides:
finalizeExtendedOperationHandler in class ExtendedOperationHandler<CancelExtendedOperationHandlerCfg>

processExtendedOperation

public void processExtendedOperation(ExtendedOperation operation)
Processes the provided extended operation.

Specified by:
processExtendedOperation in class ExtendedOperationHandler<CancelExtendedOperationHandlerCfg>
Parameters:
operation - The extended operation to be processed.