Package org.opends.server.core

Class AbandonOperation

java.lang.Object

org.opends.server.types.Operation

org.opends.server.core.AbandonOperation

All Implemented Interfaces:

PluginOperation, PostCommitOperation, PostOperationAbandonOperation, PostOperationOperation, PostResponseOperation, PreParseAbandonOperation, PreParseOperation

public final class AbandonOperation
extends Operation
implements PreParseAbandonOperation, PostOperationAbandonOperation

This class defines an operation that may be used to abandon an operation that may already be in progress in the Directory Server.

Field Summary

Fields inherited from class org.opends.server.types.Operation

backend, context, out, pluginConfigManager, request, result, serverContext

Constructor Summary

Constructors

Constructor	Description
AbandonOperation(RequestContext context, LocalBackend<?> backend, AbandonRequest request, Consumer<Response> out, ServerContext serverContext)	Creates a new abandon operation.

Method Summary

Modifier and Type	Method	Description
void	addResponseControl(Control control)	Adds the provided control to the set of controls to include in the response to the client.
int	getIDToAbandon()	Retrieves the message ID of the operation that should be abandoned.
AbandonRequest	getRequest()	Returns the request associated to this operation.
List<Control>	getResponseControls()	Retrieves the set of controls to include in the response to the client.
protected void	invokePostResponsePlugins()	Invokes any applicable post-response plugins.
protected void	invokePreParsePlugins()	Invokes any applicable pre-parse plugins.
void	removeResponseControl(Control control)	Removes the provided control from the set of controls to include in the response to the client.
Result	runImpl()	Performs the work of actually processing this operation.
void	toString(StringBuilder buffer)	Appends a string representation of this operation to the provided buffer.

Methods inherited from class org.opends.server.types.Operation

addAdditionalLogItem, addPasswordPolicyWarningToLog, addPostReadResponse, addPreReadResponse, addRequestControl, checkAttributeConformsToSyntax, checkIfBackendIsWritable, checkIfCanceled, createLdapException, equals, evaluateProxyAuthControls, filterNonDisclosableMatchedDn, getAccessControlHandler, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getClientConnection, getConnectionID, getMessageID, getOperationID, getProxiedAuthorizationDN, getRequestContext, getRequestControl, getRequestControls, getResult, getResultCode, hashCode, hasPrivilege, hasRequestControl, isInternalOperation, isProxyAuthzControl, isSynchronizationOperation, mustCheckSchema, operationToResult, removeAllDisallowedControls, run, sendIntermediateResponse, sendResult, setAttachment, setResult, setResult, toString, trySetLargestEntrySize

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opends.server.types.operation.PluginOperation

checkIfCanceled, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getRequestControl, getRequestControl, getRequestControls, hasPrivilege, isInternalOperation, isSynchronizationOperation, setAttachment, toString

Methods inherited from interface org.opends.server.types.operation.PostOperationOperation

addAdditionalLogItem, getAdditionalLogItems, getAuthorizationDN, getResultCode, setResult, setResult

Methods inherited from interface org.opends.server.types.operation.PreParseOperation

addAdditionalLogItem, addRequestControl, getAdditionalLogItems, sendIntermediateResponse

Constructor Details

AbandonOperation

public AbandonOperation(RequestContext context,
 LocalBackend<?> backend,
 AbandonRequest request,
 Consumer<Response> out,
 ServerContext serverContext)

Creates a new abandon operation.

Parameters:

context - The context.

backend - The local backend in which this request is to be processed.

request - The request.

out - A consumer responsible for sending responses to the client.

serverContext - the server context

Method Details

getIDToAbandon

public int getIDToAbandon()

Description copied from interface: PreParseAbandonOperation

Retrieves the message ID of the operation that should be abandoned.

Specified by:

getIDToAbandon in interface PostOperationAbandonOperation

Specified by:

getIDToAbandon in interface PreParseAbandonOperation

Returns:

The message ID of the operation that should be abandoned.

getRequest

public AbandonRequest getRequest()

Description copied from class: Operation

Returns the request associated to this operation.

Specified by:

getRequest in interface PluginOperation

Overrides:

getRequest in class Operation

Returns:

The request associated to this operation.

getResponseControls

public List<Control> getResponseControls()

Description copied from interface: PluginOperation

Retrieves the set of controls to include in the response to the client. The contents of this list must not be altered.

Specified by:

getResponseControls in interface PluginOperation

Overrides:

getResponseControls in class Operation

Returns:

The set of controls to include in the response to the client.

addResponseControl

public void addResponseControl(Control control)

Description copied from class: Operation

Adds the provided control to the set of controls to include in the response to the client.

This method may not be called by post-response plugins.

Specified by:

addResponseControl in interface PostOperationOperation

Specified by:

addResponseControl in interface PreParseOperation

Overrides:

addResponseControl in class Operation

Parameters:

control - The control to add to the set of controls to include in the response to the client.

removeResponseControl

public void removeResponseControl(Control control)

Description copied from class: Operation

Removes the provided control from the set of controls to include in the response to the client.

This method may not be called by post-response plugins.

Specified by:

removeResponseControl in interface PostOperationOperation

Specified by:

removeResponseControl in interface PreParseOperation

Overrides:

removeResponseControl in class Operation

Parameters:

control - The control to remove from the set of controls to include in the response to the client.

runImpl

public Result runImpl()
               throws LdapException

Description copied from class: Operation

Performs the work of actually processing this operation.

Specified by:

runImpl in class Operation

Returns:

null if the result is delayed (e.g. persistent search), Result otherwise.

Throws:

LdapException - If an error occurred when processing the operation.

invokePreParsePlugins

protected void invokePreParsePlugins()
                              throws LdapException

Description copied from class: Operation

Invokes any applicable pre-parse plugins.

Specified by:

invokePreParsePlugins in class Operation

Throws:

LdapException - If an error occurred when invoking the pre-parse plugins.

invokePostResponsePlugins

protected void invokePostResponsePlugins()

Description copied from class: Operation

Invokes any applicable post-response plugins.

Specified by:

invokePostResponsePlugins in class Operation

toString

public void toString(StringBuilder buffer)

Description copied from interface: PluginOperation

Appends a string representation of this operation to the provided buffer.

Specified by:

toString in interface PluginOperation

Specified by:

toString in class Operation

Parameters:

buffer - The buffer into which a string representation of this operation should be appended.