org.opends.server.core

Class AbandonOperation

java.lang.Object

org.opends.server.types.Operation

org.opends.server.core.AbandonOperation

All Implemented Interfaces:

Runnable, PluginOperation, 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

NO_RESPONSE_CONTROLS, requestContext

Constructor Summary

Constructors

Constructor and Description
AbandonOperation(org.forgerock.services.context.Context context, AbandonRequest request) Creates a new abandon operation with the provided information.

Method Summary

Modifier and Type	Method and 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.Operation

addAdditionalLogItem, addPostReadResponse, addPreReadResponse, addRequestControl, appendErrorMessage, appendMaskedErrorMessage, checkAttributeConformsToSyntax, checkIfBackendIsWritable, checkIfCanceled, createLdapException, disconnectClient, dontSynchronize, equals, evaluateProxyAuthControls, filterNonDisclosableMatchedDN, findMatchedDN, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getClientConnection, getConnectionID, getContext, getErrorMessage, getLocalBackend, getMatchedDN, getMessageID, getOperationID, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControl, getRequestControls, getResultCode, hashCode, hasPrivilege, invokePostResponseCallbacks, isHumanReadable, isInnerOperation, isInternalOperation, isProxyAuthzControl, isSynchronizationOperation, mustCheckSchema, operationCompleted, processOperationResult, processOperationResult, registerPostResponseCallback, removeAllDisallowedControls, removeAttachment, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMatchedDN, setProcessingStartTime, setProcessingStopTime, setReferralURLs, setResponseData, setResult, setResultCode, setResultCodeAndMessageNoInfoDisclosure, 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.PreParseOperation

addAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, setErrorMessage

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.PluginOperation

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

Constructor Detail

AbandonOperation

public AbandonOperation(org.forgerock.services.context.Context context,
                        AbandonRequest request)

Creates a new abandon operation with the provided information.

Parameters:

context - The context with which this operation is associated.

request - The abandon request.

Method Detail

getIDToAbandon

public int getIDToAbandon()

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.

getProxiedAuthorizationDN

public Dn getProxiedAuthorizationDN()

Description copied from class: Operation

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

Specified by:

getProxiedAuthorizationDN in class 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 class: Operation

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

Specified by:

setProxiedAuthorizationDN in class 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 OperationType getOperationType()

Description copied from interface: PluginOperation

Retrieves the operation type for this operation.

Specified by:

getOperationType in interface PluginOperation

Returns:

The operation type for 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

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

Specified by:

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

Specified by:

removeResponseControl in class Operation

Parameters:

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

run

public void run()

Description copied from class: Operation

Performs the work of actually processing this operation. This should include all processing for the operation, including invoking pre-parse and post-response plugins, logging messages and any other work that might need to be done in the course of processing.

Specified by:

run in interface Runnable

Specified by:

run in class Operation

toString

public void toString(StringBuilder buffer)

Description copied from class: Operation

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.