Package org.opends.server.core

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 org.opends.server.types.Operation

backend, context, out, pluginConfigManager, request, serverContext

Constructor Summary

Constructors

Constructor	Description
ExtendedOperation(RequestContext context, LocalBackend<?> backend, ExtendedRequest<?> request, Consumer<ResponseStream> out)	Creates a new extended 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.
ExtendedRequest<?>	getRequest()	Returns the request associated to this operation.
String	getRequestOID()	Retrieves the OID for the request associated with this extended operation.
ByteString	getRequestValue()	Retrieves the value for the request associated with this extended operation.
List<Control>	getResponseControls()	Retrieves the set of controls to include in the response to the client.
String	getResponseOID()	Retrieves the OID to include in the response to the client.
ByteString	getResponseValue()	Retrieves the value to include in the response to the client.
protected void	invokePostResponsePlugins()	Invokes any applicable post-response plugins.
protected boolean	invokePreParsePlugins()	Invokes any applicable pre-parse plugins.
protected Result	operationToResult()	Generates a result for this operation.
void	removeResponseControl(Control control)	Removes the provided control from the set of controls to include in the response to the client.
protected boolean	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	setResponseOID(String responseOID)	Specifies the OID to include in the response to the client.
void	setResponseValue(ByteString responseValue)	Specifies the value to include in the response to the client.
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, appendErrorMessage, appendMaskedErrorMessage, checkAttributeConformsToSyntax, checkIfBackendIsWritable, checkIfCanceled, createLdapException, equals, evaluateProxyAuthControls, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getClientConnection, getConnectionID, getErrorMessage, getLargestEntrySize, getMatchedDN, getMessageID, getOperationID, getProxiedAuthorizationDN, getReferralURLs, getRequestContext, getRequestControl, getRequestControls, getResultCode, hashCode, hasPrivilege, hasRequestControl, isInternalOperation, isProxyAuthzControl, isSynchronizationOperation, mustCheckSchema, processOperationResult, removeAllDisallowedControls, run, sendResponses, sendResult, setAttachment, setErrorMessage, setMatchedDN, setReferralURLs, setResult, setResult, setResultCode, setResultCodeAndMessageNoInfoDisclosure, 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, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, setErrorMessage, setMatchedDN, setReferralURLs, setResult, setResultCode

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

addAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, sendResponses, setErrorMessage

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

addAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, sendResponses, setErrorMessage

Constructor Details

ExtendedOperation

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

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.

Method Details

getRequestOID

public String getRequestOID()

Retrieves 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()

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

getResponseOID

public String getResponseOID()

Retrieves the OID to include in the response to the client.

Specified by:

getResponseOID in interface PostOperationExtendedOperation

Specified by:

getResponseOID in interface PostResponseExtendedOperation

Returns:

The OID to include in the response to the client.

setResponseOID

public void setResponseOID(String responseOID)

Specifies the OID to include in the response to the client.

Specified by:

setResponseOID in interface PostOperationExtendedOperation

Specified by:

setResponseOID in interface PreOperationExtendedOperation

Specified by:

setResponseOID in interface PreParseExtendedOperation

Parameters:

responseOID - The OID to include in the response to the client.

getResponseValue

public ByteString getResponseValue()

Retrieves the value to include in the response to the client.

Specified by:

getResponseValue in interface PostOperationExtendedOperation

Specified by:

getResponseValue in interface PostResponseExtendedOperation

Returns:

The value to include in the response to the client.

setResponseValue

public void setResponseValue(ByteString responseValue)

Specifies the value to include in the response to the client.

Specified by:

setResponseValue in interface PostOperationExtendedOperation

Specified by:

setResponseValue in interface PreOperationExtendedOperation

Specified by:

setResponseValue in interface PreParseExtendedOperation

Parameters:

responseValue - The value to include in the response to the client.

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.

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 PreOperationOperation

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 PreOperationOperation

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.

runImpl

protected boolean runImpl()
                   throws LdapException

Description copied from class: Operation

Performs the work of actually processing this operation.

Specified by:

runImpl in class Operation

Returns:

true if the result should be sent immediately, or false if it will be sent later, e.g. as part of a persistent search.

Throws:

LdapException - If an error occurred when processing the operation.

invokePreParsePlugins

protected boolean invokePreParsePlugins()
                                 throws LdapException

Description copied from class: Operation

Invokes any applicable pre-parse plugins.

Specified by:

invokePreParsePlugins in class Operation

Returns:

true if processing should continue.

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()

Description copied from class: Operation

Generates a result for this operation.

Overrides:

operationToResult in class Operation

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.