Class ExtendedOperation

java.lang.Object

org.opends.server.types.Operation

org.opends.server.core.ExtendedOperation

All Implemented Interfaces:

PluginOperation, PostCommitOperation, PostOperationExtendedOperation, PostOperationOperation, PostResponseExtendedOperation, PostResponseOperation, PreOperationExtendedOperation, PreOperationOperation, PreParseExtendedOperation, PreParseOperation

public final class ExtendedOperation
extends Operation
implements PreParseExtendedOperation, PreOperationExtendedOperation, PostOperationExtendedOperation, PostResponseExtendedOperation

This class defines an extended operation, which can perform virtually any kind of task.

Field Summary

Fields inherited from class Operation

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

Constructor Summary

Constructors

Constructor	Description
ExtendedOperation(RequestContext context, LocalBackend<?> backend, ExtendedRequest<?> request, Consumer<Response> out, ServerContext serverContext)	Creates a new extended operation.

Method Summary

Modifier and Type	Method	Description
ExtendedRequest<?>	getRequest()	Returns the request associated to this operation.
String	getRequestOid()	Returns the OID for the request associated with this extended operation.
ByteString	getRequestValue()	Returns the value for the request associated with this extended operation.
protected void	invokePostResponsePlugins()	Invokes any applicable post-response plugins.
protected void	invokePreParsePlugins()	Invokes any applicable pre-parse plugins.
void	onComplete(Result result)	Notifies that this extended operation has completed.
protected Result	operationToResult(Result result)	Generates a result for this operation.
protected Result	runImpl()	Performs the work of actually processing this operation.
void	setRequestOid(String requestOid)	Specifies the OID for the request associated with this extended operation.
void	setRequestValue(ByteString requestValue)	Specifies the value for the request associated with this extended operation.
void	toString(StringBuilder buffer)	Appends a string representation of this operation to the provided buffer.

Methods inherited from class Operation

addAdditionalLogItem, addPasswordPolicyWarningToLog, addPostReadResponse, addPreReadResponse, addRequestControl, addResponseControl, checkAttributeConformsToSyntax, checkIfBackendIsWritable, checkIfCanceled, createLdapException, equals, evaluateProxyAuthControls, filterNonDisclosableMatchedDn, getAccessControlHandler, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDn, getAuthorizationEntry, getClientConnection, getConnectionId, getMessageId, getOperationId, getProxiedAuthorizationDN, getRequestContext, getRequestControl, getRequestControls, getResponseControls, getResult, getResultCode, hashCode, hasPrivilege, hasRequestControl, isInternalOperation, isProxyAuthzControl, isSynchronizationOperation, mustCheckSchema, removeAllDisallowedControls, removeResponseControl, run, sendIntermediateResponse, sendResult, setAttachment, setResult, setResult, toString

Methods inherited from class Object

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

Methods inherited from interface PluginOperation

checkIfCanceled, getAttachment, getAttachments, getClientConnection, getConnectionId, getMessageId, getOperationId, getRequestControl, getRequestControl, getRequestControls, getResponseControls, hasPrivilege, isInternalOperation, isSynchronizationOperation, setAttachment, toString

Methods inherited from interface PostOperationOperation

addAdditionalLogItem, addResponseControl, getAdditionalLogItems, getAuthorizationDn, getResultCode, removeResponseControl, setResult, setResult

Methods inherited from interface PreOperationOperation

addAdditionalLogItem, addResponseControl, getAdditionalLogItems, getAuthorizationDn, removeResponseControl, sendIntermediateResponse

Methods inherited from interface PreParseOperation

addAdditionalLogItem, addRequestControl, addResponseControl, getAdditionalLogItems, removeResponseControl, sendIntermediateResponse

Constructor Details

ExtendedOperation

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

Creates a new extended 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

getRequestOid

public String getRequestOid()

Returns the OID for the request associated with this extended operation.

Specified by:

getRequestOid in interface PostOperationExtendedOperation

Specified by:

getRequestOid in interface PostResponseExtendedOperation

Specified by:

getRequestOid in interface PreOperationExtendedOperation

Specified by:

getRequestOid in interface PreParseExtendedOperation

Returns:

the OID for the request associated with this extended operation

setRequestOid

public void setRequestOid(String requestOid)

Specifies the OID for the request associated with this extended operation. This should only be called by pre-parse plugins.

Specified by:

setRequestOid in interface PreParseExtendedOperation

Parameters:

requestOid - The OID for the request associated with this extended operation.

getRequestValue

public ByteString getRequestValue()

Returns the value for the request associated with this extended operation.

Specified by:

getRequestValue in interface PostOperationExtendedOperation

Specified by:

getRequestValue in interface PostResponseExtendedOperation

Specified by:

getRequestValue in interface PreOperationExtendedOperation

Specified by:

getRequestValue in interface PreParseExtendedOperation

Returns:

the value for the request associated with this extended operation

setRequestValue

public void setRequestValue(ByteString requestValue)

Specifies the value for the request associated with this extended operation. This should only be called by pre-parse plugins.

Specified by:

setRequestValue in interface PreParseExtendedOperation

Parameters:

requestValue - The value for the request associated with this extended operation.

getRequest

public ExtendedRequest<?> 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

runImpl

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

onComplete

public void onComplete(Result result)

Notifies that this extended operation has completed.

Parameters:

result - The result.

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

operationToResult

protected Result operationToResult(Result result)

Description copied from class: Operation

Generates a result for this operation.

Overrides:

operationToResult in class Operation

Parameters:

result - The result to convert.

Returns:

The result.

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.