org.opends.server.core
Class OperationWrapper

java.lang.Object
  org.opends.server.core.OperationWrapper

All Implemented Interfaces:

Operation

Direct Known Subclasses:

AddOperationWrapper, BindOperationWrapper, CompareOperationWrapper, DeleteOperationWrapper, ModifyDNOperationWrapper, ModifyOperationWrapper, SearchOperationWrapper

public class OperationWrapper
extends java.lang.Object
implements Operation

This abstract class is a generic operation wrapper intended to be subclassed by a specific operation wrapper.

Field Summary

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

LOCALBACKENDOPERATIONS

Constructor Summary

OperationWrapper(Operation operation)
Creates a new generic operation wrapper.

Method Summary

void	abort(CancelRequest cancelRequest) Attempts to abort this operation before processing has completed.
void	addRequestControl(Control control) Adds the provided control to the set of request controls for this operation.
void	addResponseControl(Control control) Adds the provided control to the set of controls to include in the response to the client.
void	appendAdditionalLogMessage(Message message) Appends the provided message to the additional log information for this operation.
void	appendErrorMessage(Message message) Appends the provided message to the error message buffer.
CancelResult	cancel(CancelRequest cancelRequest) Attempts to cancel this operation before processing has completed.
void	checkIfCanceled(boolean signalTooLate) Checks to see if this operation requested to cancel in which case CanceledOperationException will be thrown.
void	disconnectClient(DisconnectReason disconnectReason, boolean sendNotification, Message message) Terminates the client connection being used to process this operation.
boolean	dontSynchronize() Indicates whether this operation needs to be synchronized to other copies of the data.
MessageBuilder	getAdditionalLogMessage() Retrieves the additional log message for this operation, which should be written to the log but not included in the response to the client.
java.lang.Object	getAttachment(java.lang.String name) Retrieves the attachment with the specified name.
java.util.Map<java.lang.String,java.lang.Object>	getAttachments() Retrieves the set of attachments defined for this operation, as a mapping between the attachment name and the associated object.
DN	getAuthorizationDN() Retrieves the authorization DN for this operation.
Entry	getAuthorizationEntry() Retrieves the entry for the user that should be considered the authorization identity for this operation.
CancelRequest	getCancelRequest() Retrieves the cancel request that has been issued for this operation, if there is one.
CancelResult	getCancelResult() Retrieves the cancel result for this operation.
ClientConnection	getClientConnection() Retrieves the client connection with which this operation is associated.
java.lang.String[][]	getCommonLogElements() Retrieves a set of standard elements that should be logged in all requests and responses for all types of operations.
long	getConnectionID() Retrieves the unique identifier that is assigned to the client connection that submitted this operation.
MessageBuilder	getErrorMessage() Retrieves the error message for this operation.
DN	getMatchedDN() Retrieves the matched DN for this operation.
int	getMessageID() Retrieves the message ID assigned to this operation.
long	getOperationID() Retrieves the operation ID for this operation.
OperationType	getOperationType() Retrieves the operation type for this operation.
long	getProcessingNanoTime() Retrieves the length of time in nanoseconds that the server spent processing this operation if available.
long	getProcessingStartTime() Retrieves the time that processing started for this operation.
long	getProcessingStopTime() Retrieves the time that processing stopped for this operation.
long	getProcessingTime() Retrieves the length of time in milliseconds that the server spent processing this operation.
java.util.List<java.lang.String>	getReferralURLs() Retrieves the set of referral URLs for this operation.
java.util.List<Control>	getRequestControls() Retrieves the set of controls included in the request from the client.
java.lang.String[][]	getRequestLogElements() Retrieves a standard set of elements that should be logged in requests for this type of operation.
java.util.List<Control>	getResponseControls() Retrieves the set of controls to include in the response to the client.
java.lang.String[][]	getResponseLogElements() Retrieves a standard set of elements that should be logged in responses for this type of operation.
ResultCode	getResultCode() Retrieves the result code for this operation.
boolean	isInternalOperation() Indicates whether this is an internal operation rather than one that was requested by an external client.
boolean	isSynchronizationOperation() Indicates whether this is a synchronization operation rather than one that was requested by an external client.
void	operationCompleted() Indicates that processing on this operation has completed successfully and that the client should perform any associated cleanup work.
java.lang.Object	removeAttachment(java.lang.String name) Removes the attachment with the specified name.
void	removeRequestControl(Control control) Removes the provided control from the set of request controls for this operation.
void	removeResponseControl(Control control) Removes the provided control from the set of controls to include in the response to the client.
void	setAdditionalLogMessage(MessageBuilder additionalLogMessage) Specifies the additional log message for this operation, which should be written to the log but not included in the response to the client.
java.lang.Object	setAttachment(java.lang.String name, java.lang.Object value) Sets the value of the specified attachment.
void	setAttachments(java.util.Map<java.lang.String,java.lang.Object> attachments) Set the attachments to the operation.
void	setAuthorizationEntry(Entry authorizationEntry) Provides the entry for the user that should be considered the authorization identity for this operation.
void	setDontSynchronize(boolean dontSynchronize) Specifies whether this operation must be synchronized to other copies of the data.
void	setErrorMessage(MessageBuilder errorMessage) Specifies the error message for this operation.
void	setInternalOperation(boolean isInternalOperation) Specifies whether this is an internal operation rather than one that was requested by an external client.
void	setMatchedDN(DN matchedDN) Specifies the matched DN for this operation.
void	setReferralURLs(java.util.List<java.lang.String> referralURLs) Specifies the set of referral URLs for this operation.
void	setResponseData(DirectoryException directoryException) Sets the response elements for this operation based on the information contained in the provided DirectoryException object.
void	setResultCode(ResultCode resultCode) Specifies the result code for this operation.
void	setSynchronizationOperation(boolean isSynchronizationOperation) Specifies whether this is a synchronization operation rather than one that was requested by an external client.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this operation to the provided buffer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

toString

Constructor Detail

OperationWrapper

public OperationWrapper(Operation operation)

Creates a new generic operation wrapper.

Parameters:

operation - the generic operation to wrap

Method Detail

addRequestControl

public void addRequestControl(Control control)

Adds the provided control to the set of request controls for this operation. This method may only be called by pre-parse plugins.

Specified by:

addRequestControl in interface Operation

Parameters:

control - The control to add to the set of request controls for this operation.

addResponseControl

public void addResponseControl(Control control)

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

Parameters:

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

appendAdditionalLogMessage

public void appendAdditionalLogMessage(Message message)

Appends the provided message to the additional log information for this operation. This method may not be called by post-response plugins.

Specified by:

appendAdditionalLogMessage in interface Operation

Parameters:

message - The message that should be appended to the

appendErrorMessage

public void appendErrorMessage(Message message)

Appends the provided message to the error message buffer. If the buffer has not yet been created, then this will create it first and then add the provided message. This method may not be called by post-response plugins.

Specified by:

appendErrorMessage in interface Operation

Parameters:

message - The message to append to the error message

cancel

public CancelResult cancel(CancelRequest cancelRequest)

Attempts to cancel this operation before processing has completed.

Specified by:

cancel in interface Operation

Parameters:

cancelRequest - Information about the way in which the operation should be canceled.

Returns:

A code providing information on the result of the cancellation.

abort

public void abort(CancelRequest cancelRequest)

Attempts to abort this operation before processing has completed.

Specified by:

abort in interface Operation

Parameters:

cancelRequest - Information about the way in which the operation should be canceled.

disconnectClient

public void disconnectClient(DisconnectReason disconnectReason,
                             boolean sendNotification,
                             Message message)

Terminates the client connection being used to process this operation. If this is called by a plugin, then that plugin must return a result indicating that the client connection has been teriminated.

Specified by:

disconnectClient in interface Operation

Parameters:

disconnectReason - The disconnect reason that provides the generic cause for the disconnect.

sendNotification - Indicates whether to try to provide notification to the client that the connection will be closed.

message - The message to send to the client. It may be null if no notification is to be sent.

dontSynchronize

public boolean dontSynchronize()

Indicates whether this operation needs to be synchronized to other copies of the data.

Specified by:

dontSynchronize in interface Operation

Returns:

true if this operation should not be synchronized, or false if it should be synchronized.

getAdditionalLogMessage

public MessageBuilder getAdditionalLogMessage()

Retrieves the additional log message for this operation, which should be written to the log but not included in the response to the client. The contents of this buffer may be altered by pre-parse, pre-operation, and post-operation plugins, but not by post-response plugins.

Specified by:

getAdditionalLogMessage in interface Operation

Returns:

The additional log message for this operation.

getAttachment

public java.lang.Object getAttachment(java.lang.String name)

Retrieves the attachment with the specified name.

Specified by:

getAttachment in interface Operation

Parameters:

name - The name for the attachment to retrieve. It will be treated in a case-sensitive manner.

Returns:

The requested attachment object, or null if it does not exist.

getAttachments

public java.util.Map<java.lang.String,java.lang.Object> getAttachments()

Retrieves the set of attachments defined for this operation, as a mapping between the attachment name and the associated object.

Specified by:

getAttachments in interface Operation

Returns:

The set of attachments defined for this operation.

getAuthorizationDN

public DN getAuthorizationDN()

Retrieves the authorization DN for this operation. In many cases, it will be the same as the DN of the authenticated user for the underlying connection, or the null DN if no authentication has been performed on that connection. However, it may be some other value if special processing has been requested (e.g., the operation included a proxied authorization control). This method should not be called by pre-parse plugins because the correct value may not have yet been determined.

Specified by:

getAuthorizationDN in interface Operation

Returns:

The authorization DN for this operation, or the null DN if it should be the unauthenticated user..

getAuthorizationEntry

public Entry getAuthorizationEntry()

Retrieves the entry for the user that should be considered the authorization identity for this operation. In many cases, it will be the same as the authorization entry for the underlying client connection, or null if no authentication has been performed on that connection. However, it may be some other value if special processing has been requested (e.g., the operation included a proxied authorization control). This method should not be called by pre-parse plugins because the correct value may not yet have been determined.

Specified by:

getAuthorizationEntry in interface Operation

Returns:

The entry for the user that should be considered the authorization identity for this operation, or null if the authorization identity should be the unauthenticated user.

getCancelRequest

public CancelRequest getCancelRequest()

Retrieves the cancel request that has been issued for this operation, if there is one. This method should not be called by post-operation or post-response plugins.

Specified by:

getCancelRequest in interface Operation

Returns:

The cancel request that has been issued for this operation, or null if there has not been any request to cancel.

getCancelResult

public CancelResult getCancelResult()

Retrieves the cancel result for this operation.

Specified by:

getCancelResult in interface Operation

Returns:

The cancel result for this operation. It will be null if the operation has not seen and reacted to a cancel request.

getClientConnection

public ClientConnection getClientConnection()

Retrieves the client connection with which this operation is associated.

Specified by:

getClientConnection in interface Operation

Returns:

The client connection with which this operation is associated.

getCommonLogElements

public java.lang.String[][] getCommonLogElements()

Retrieves a set of standard elements that should be logged in all requests and responses for all types of operations. Each element in the array will itself be a two-element array in which the first element is the name of the field and the second is a string representation of the value, or null if there is no value for that field.

Specified by:

getCommonLogElements in interface Operation

Returns:

A standard set of elements that should be logged in requests and responses for all types of operations.

getConnectionID

public long getConnectionID()

Retrieves the unique identifier that is assigned to the client connection that submitted this operation.

Specified by:

getConnectionID in interface Operation

Returns:

The unique identifier that is assigned to the client connection that submitted this operation.

getErrorMessage

public MessageBuilder getErrorMessage()

Retrieves the error message for this operation. Its contents may be altered by pre-parse, pre-operation, and post-operation plugins, but not by post-response plugins.

Specified by:

getErrorMessage in interface Operation

Returns:

The error message for this operation.

getMatchedDN

public DN getMatchedDN()

Retrieves the matched DN for this operation.

Specified by:

getMatchedDN in interface Operation

Returns:

The matched DN for this operation, or null if the operation has not yet completed or does not have a matched DN.

getMessageID

public int getMessageID()

Retrieves the message ID assigned to this operation.

Specified by:

getMessageID in interface Operation

Returns:

The message ID assigned to this operation.

getOperationID

public long getOperationID()

Retrieves the operation ID for this operation.

Specified by:

getOperationID in interface Operation

Returns:

The operation ID for this operation.

getOperationType

public OperationType getOperationType()

Retrieves the operation type for this operation.

Specified by:

getOperationType in interface Operation

Returns:

The operation type for this operation.

getProcessingStartTime

public long getProcessingStartTime()

Retrieves the time that processing started for this operation.

Specified by:

getProcessingStartTime in interface Operation

Returns:

The time that processing started for this operation.

getProcessingStopTime

public long getProcessingStopTime()

Retrieves the time that processing stopped for this operation. This will actually hold a time immediately before the response was sent to the client.

Specified by:

getProcessingStopTime in interface Operation

Returns:

The time that processing stopped for this operation.

getProcessingTime

public long getProcessingTime()

Retrieves the length of time in milliseconds that the server spent processing this operation. This should not be called until after the server has sent the response to the client.

Specified by:

getProcessingTime in interface Operation

Returns:

The length of time in milliseconds that the server spent processing this operation.

getProcessingNanoTime

public long getProcessingNanoTime()

Retrieves the length of time in nanoseconds that the server spent processing this operation if available. This should not be called until after the server has sent the response to the client.

Specified by:

getProcessingNanoTime in interface Operation

Returns:

The length of time in nanoseconds that the server spent processing this operation or -1 if its not available.

getReferralURLs

public java.util.List<java.lang.String> getReferralURLs()

Retrieves the set of referral URLs for this operation. Its contents must not be altered by the caller.

Specified by:

getReferralURLs in interface Operation

Returns:

The set of referral URLs for this operation, or null if the operation is not yet complete or does not have a set of referral URLs.

getRequestControls

public java.util.List<Control> getRequestControls()

Retrieves the set of controls included in the request from the client. The returned list must not be altered.

Specified by:

getRequestControls in interface Operation

Returns:

The set of controls included in the request from the client.

getRequestLogElements

public java.lang.String[][] getRequestLogElements()

Retrieves a standard set of elements that should be logged in requests for this type of operation. Each element in the array will itself be a two-element array in which the first element is the name of the field and the second is a string representation of the value, or null if there is no value for that field.

Specified by:

getRequestLogElements in interface Operation

Returns:

A standard set of elements that should be logged in requests for this type of operation.

getResponseControls

public java.util.List<Control> getResponseControls()

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

Returns:

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

getResponseLogElements

public java.lang.String[][] getResponseLogElements()

Retrieves a standard set of elements that should be logged in responses for this type of operation. Each element in the array will itself be a two-element array in which the first element is the name of the field and the second is a string representation of the value, or null if there is no value for that field.

Specified by:

getResponseLogElements in interface Operation

Returns:

A standard set of elements that should be logged in responses for this type of operation.

getResultCode

public ResultCode getResultCode()

Retrieves the result code for this operation.

Specified by:

getResultCode in interface Operation

Returns:

The result code associated for this operation, or UNDEFINED if the operation has not yet completed.

isInternalOperation

public boolean isInternalOperation()

Indicates whether this is an internal operation rather than one that was requested by an external client.

Specified by:

isInternalOperation in interface Operation

Returns:

true if this is an internal operation, or false if it is not.

isSynchronizationOperation

public boolean isSynchronizationOperation()

Indicates whether this is a synchronization operation rather than one that was requested by an external client.

Specified by:

isSynchronizationOperation in interface Operation

Returns:

true if this is a data synchronization operation, or false if it is not.

operationCompleted

public void operationCompleted()

Indicates that processing on this operation has completed successfully and that the client should perform any associated cleanup work.

Specified by:

operationCompleted in interface Operation

removeAttachment

public java.lang.Object removeAttachment(java.lang.String name)

Removes the attachment with the specified name.

Specified by:

removeAttachment in interface Operation

Parameters:

name - The name for the attachment to remove. It will be treated in a case-sensitive manner.

Returns:

The attachment that was removed, or null if it does not exist.

removeRequestControl

public void removeRequestControl(Control control)

Removes the provided control from the set of request controls for this operation. This method may only be called by pre-parse plugins.

Specified by:

removeRequestControl in interface Operation

Parameters:

control - The control to remove from the set of request controls for this operation.

removeResponseControl

public void removeResponseControl(Control control)

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

Parameters:

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

setAdditionalLogMessage

public void setAdditionalLogMessage(MessageBuilder additionalLogMessage)

Specifies the additional log message for this operation, which should be written to the log but not included in the response to the client. This method may not be called by post-response plugins.

Specified by:

setAdditionalLogMessage in interface Operation

Parameters:

additionalLogMessage - The additional log message for this

setAttachment

public java.lang.Object setAttachment(java.lang.String name,
                                      java.lang.Object value)

Sets the value of the specified attachment. If an attachment already exists with the same name, it will be replaced. Otherwise, a new attachment will be added.

Specified by:

setAttachment in interface Operation

Parameters:

name - The name to use for the attachment.

value - The value to use for the attachment.

Returns:

The former value held by the attachment with the given name, or null if there was previously no such attachment.

setAttachments

public void setAttachments(java.util.Map<java.lang.String,java.lang.Object> attachments)

Set the attachments to the operation.

Specified by:

setAttachments in interface Operation

Parameters:

attachments - - Attachments to register within the operation

setAuthorizationEntry

public void setAuthorizationEntry(Entry authorizationEntry)

Provides the entry for the user that should be considered the authorization identity for this operation. This must not be called from within a plugin.

Specified by:

setAuthorizationEntry in interface Operation

Parameters:

authorizationEntry - The entry for the user that should be considered the authorization identity for this operation, or null if it should be the unauthenticated user.

setDontSynchronize

public void setDontSynchronize(boolean dontSynchronize)

Specifies whether this operation must be synchronized to other copies of the data.

Specified by:

setDontSynchronize in interface Operation

Parameters:

dontSynchronize - Specifies whether this operation must be synchronized to other copies of the data.

setErrorMessage

public void setErrorMessage(MessageBuilder errorMessage)

Specifies the error message for this operation. This method may not be called by post-response plugins.

Specified by:

setErrorMessage in interface Operation

Parameters:

errorMessage - The error message for this operation.

setInternalOperation

public void setInternalOperation(boolean isInternalOperation)

Specifies whether this is an internal operation rather than one that was requested by an external client. This may not be called from within a plugin.

Specified by:

setInternalOperation in interface Operation

Parameters:

isInternalOperation - Specifies whether this is an internal operation rather than one that was requested by an external client.

setMatchedDN

public void setMatchedDN(DN matchedDN)

Specifies the matched DN for this operation. This may not be called by post-response plugins.

Specified by:

setMatchedDN in interface Operation

Parameters:

matchedDN - The matched DN for this operation.

setReferralURLs

public void setReferralURLs(java.util.List<java.lang.String> referralURLs)

Specifies the set of referral URLs for this operation. This may not be called by post-response plugins.

Specified by:

setReferralURLs in interface Operation

Parameters:

referralURLs - The set of referral URLs for this operation.

setResponseData

public void setResponseData(DirectoryException directoryException)

Sets the response elements for this operation based on the information contained in the provided DirectoryException object. This method may not be called by post-response plugins.

Specified by:

setResponseData in interface Operation

Parameters:

directoryException - The exception containing the information to use for the response elements.

setResultCode

public void setResultCode(ResultCode resultCode)

Specifies the result code for this operation. This method may not be called by post-response plugins.

Specified by:

setResultCode in interface Operation

Parameters:

resultCode - The result code for this operation.

setSynchronizationOperation

public void setSynchronizationOperation(boolean isSynchronizationOperation)

Specifies whether this is a synchronization operation rather than one that was requested by an external client. This method may not be called from within a plugin.

Specified by:

setSynchronizationOperation in interface Operation

Parameters:

isSynchronizationOperation - Specifies whether this is a synchronization operation rather than one that was requested by an external client.

toString

public void toString(java.lang.StringBuilder buffer)

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

Specified by:

toString in interface Operation

Parameters:

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

checkIfCanceled

public final void checkIfCanceled(boolean signalTooLate)
                           throws CanceledOperationException

Checks to see if this operation requested to cancel in which case CanceledOperationException will be thrown.

Specified by:

checkIfCanceled in interface Operation

Parameters:

signalTooLate - true to signal that any further cancel requests will be too late after return from this call or false otherwise.

Throws:

CanceledOperationException - if this operation should be cancelled.