Package org.opends.server.core

Class AbandonOperationBasis

java.lang.Object

org.opends.server.types.AbstractOperation

org.opends.server.core.AbandonOperationBasis

All Implemented Interfaces:

Runnable, AbandonOperation, Operation, PluginOperation, PostOperationAbandonOperation, PostOperationOperation, PostResponseOperation, PreParseAbandonOperation, PreParseOperation

public class AbandonOperationBasis
extends AbstractOperation
implements AbandonOperation, 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.AbstractOperation

cancelRequest, cancelResult, clientConnection, messageID, NO_RESPONSE_CONTROLS, operationID

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

LOCALBACKENDOPERATIONS

Constructor Summary

Constructors

Constructor	Description
AbandonOperationBasis(ClientConnection clientConnection, long operationID, int messageID, List<Control> requestControls, int idToAbandon)	Creates a new abandon operation with the provided information.

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.
OperationType	getOperationType()	Retrieves the operation type for this operation.
DN	getProxiedAuthorizationDN()	Retrieves the proxied authorization DN for this operation if proxied authorization has been requested.
List<Control>	getResponseControls()	Retrieves the set of controls to include in the response to the client.
void	removeResponseControl(Control control)	Removes the provided control from the set of controls to include in the response to the client.
void	run()	Performs the work of actually processing this operation.
void	setProxiedAuthorizationDN(DN proxiedAuthorizationDN)	Set the proxied authorization DN for this operation if proxied authorization has been requested.
void	toString(StringBuilder buffer)	Appends a string representation of this operation to the provided buffer.

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

abort, addAdditionalLogItem, addRequestControl, appendErrorMessage, appendMaskedErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, equals, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getConnectionID, getErrorMessage, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperationID, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControl, getRequestControls, getResultCode, getTransactionId, hashCode, invokePostResponseCallbacks, isInnerOperation, isInternalOperation, isSynchronizationOperation, operationCompleted, processOperationResult, processOperationResult, registerPostResponseCallback, removeAttachment, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, setMatchedDN, setProcessingStartTime, setProcessingStopTime, setReferralURLs, setResponseData, setResultCode, setSynchronizationOperation, toString, updateOperationErrMsgAndResCode

Methods inherited from class java.lang.Object

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

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

abort, addAdditionalLogItem, addRequestControl, appendErrorMessage, appendMaskedErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getConnectionID, getErrorMessage, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperationID, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControl, getRequestControls, getResultCode, isInnerOperation, isInternalOperation, isSynchronizationOperation, operationCompleted, registerPostResponseCallback, removeAttachment, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, setMatchedDN, setReferralURLs, setResponseData, setResultCode, setSynchronizationOperation, toString

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

checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getProcessingStartTime, getRequestControl, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString

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

addAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, setErrorMessage, setMatchedDN, setReferralURLs, setResponseData, setResultCode

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

addAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, setErrorMessage

Constructor Detail

AbandonOperationBasis

public AbandonOperationBasis(ClientConnection clientConnection,
                             long operationID,
                             int messageID,
                             List<Control> requestControls,
                             int idToAbandon)

Creates a new abandon operation with the provided information.

Parameters:

clientConnection - The client connection with which this operation is associated.

operationID - The operation ID for this operation.

messageID - The message ID of the request with which this operation is associated.

requestControls - The set of controls included in the request.

idToAbandon - The message ID of the operation that should be abandoned.

Method Detail

getIDToAbandon

public final int getIDToAbandon()

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

Specified by:

getIDToAbandon in interface AbandonOperation

Specified by:

getIDToAbandon in interface PostOperationAbandonOperation

Specified by:

getIDToAbandon in interface PreParseAbandonOperation

Returns:

The message ID of the operation that should be abandoned.

getProxiedAuthorizationDN

public DN getProxiedAuthorizationDN()

Description copied from interface: Operation

Retrieves the proxied authorization DN for this operation if proxied authorization has been requested.

Specified by:

getProxiedAuthorizationDN in interface Operation

Returns:

The proxied authorization DN for this operation if proxied authorization has been requested, or null if proxied authorization has not been requested.

setProxiedAuthorizationDN

public void setProxiedAuthorizationDN(DN proxiedAuthorizationDN)

Description copied from interface: Operation

Set the proxied authorization DN for this operation if proxied authorization has been requested.

Specified by:

setProxiedAuthorizationDN in interface Operation

Parameters:

proxiedAuthorizationDN - The proxied authorization DN for this operation if proxied authorization has been requested, or null if proxied authorization has not been requested.

getOperationType

public final OperationType getOperationType()

Description copied from interface: Operation

Retrieves the operation type for this operation.

Specified by:

getOperationType in interface Operation

Specified by:

getOperationType in interface PluginOperation

Returns:

The operation type for this operation.

getResponseControls

public final List<Control> getResponseControls()

Description copied from interface: Operation

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 Operation

Specified by:

getResponseControls in interface PluginOperation

Returns:

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

addResponseControl

public final void addResponseControl(Control control)

Description copied from interface: 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 Operation

Specified by:

addResponseControl in interface PostOperationOperation

Specified by:

addResponseControl in interface PreParseOperation

Parameters:

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

removeResponseControl

public final void removeResponseControl(Control control)

Description copied from interface: 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 Operation

Specified by:

removeResponseControl in interface PostOperationOperation

Specified by:

removeResponseControl in interface PreParseOperation

Parameters:

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

run

public final void run()

Performs the work of actually processing this operation. This should include all processing for the operation, including invoking plugins, logging messages, performing access control, managing synchronization, and any other work that might need to be done in the course of processing.

Specified by:

run in interface Operation

Specified by:

run in interface Runnable

toString

public final void toString(StringBuilder buffer)

Description copied from interface: Operation

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

Specified by:

toString in interface Operation

Specified by:

toString in interface PluginOperation

Parameters:

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