|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.core.OperationWrapper
public class OperationWrapper
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 |
---|
public OperationWrapper(Operation operation)
operation
- the generic operation to wrapMethod Detail |
---|
public void addRequestControl(Control control)
addRequestControl
in interface Operation
control
- The control to add to the set of request
controls for this operation.public void addResponseControl(Control control)
addResponseControl
in interface Operation
control
- The control to add to the set of controls to
include in the response to the client.public void appendAdditionalLogMessage(Message message)
appendAdditionalLogMessage
in interface Operation
message
- The message that should be appended to thepublic void appendErrorMessage(Message message)
appendErrorMessage
in interface Operation
message
- The message to append to the error messagepublic CancelResult cancel(CancelRequest cancelRequest)
cancel
in interface Operation
cancelRequest
- Information about the way in which the
operation should be canceled.
public void abort(CancelRequest cancelRequest)
abort
in interface Operation
cancelRequest
- Information about the way in which the
operation should be canceled.public void disconnectClient(DisconnectReason disconnectReason, boolean sendNotification, Message message)
disconnectClient
in interface Operation
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.public boolean dontSynchronize()
dontSynchronize
in interface Operation
true
if this operation should not be
synchronized, or false
if it should be
synchronized.public MessageBuilder getAdditionalLogMessage()
getAdditionalLogMessage
in interface Operation
public java.lang.Object getAttachment(java.lang.String name)
getAttachment
in interface Operation
name
- The name for the attachment to retrieve. It will
be treated in a case-sensitive manner.
null
if it
does not exist.public java.util.Map<java.lang.String,java.lang.Object> getAttachments()
getAttachments
in interface Operation
public DN getAuthorizationDN()
getAuthorizationDN
in interface Operation
public Entry getAuthorizationEntry()
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.
getAuthorizationEntry
in interface Operation
null
if the authorization identity should be the
unauthenticated user.public CancelRequest getCancelRequest()
getCancelRequest
in interface Operation
null
if there has not been any
request to cancel.public CancelResult getCancelResult()
getCancelResult
in interface Operation
null
if the operation has not seen and reacted
to a cancel request.public ClientConnection getClientConnection()
getClientConnection
in interface Operation
public java.lang.String[][] getCommonLogElements()
null
if there is no value
for that field.
getCommonLogElements
in interface Operation
public long getConnectionID()
getConnectionID
in interface Operation
public MessageBuilder getErrorMessage()
getErrorMessage
in interface Operation
public DN getMatchedDN()
getMatchedDN
in interface Operation
null
if
the operation has not yet completed or does not have a
matched DN.public int getMessageID()
getMessageID
in interface Operation
public long getOperationID()
getOperationID
in interface Operation
public OperationType getOperationType()
getOperationType
in interface Operation
public long getProcessingStartTime()
getProcessingStartTime
in interface Operation
public long getProcessingStopTime()
getProcessingStopTime
in interface Operation
public long getProcessingTime()
getProcessingTime
in interface Operation
public long getProcessingNanoTime()
getProcessingNanoTime
in interface Operation
public java.util.List<java.lang.String> getReferralURLs()
getReferralURLs
in interface Operation
null
if the operation is not yet complete or
does not have a set of referral URLs.public java.util.List<Control> getRequestControls()
getRequestControls
in interface Operation
public java.lang.String[][] getRequestLogElements()
null
if there is no value for that
field.
getRequestLogElements
in interface Operation
public java.util.List<Control> getResponseControls()
getResponseControls
in interface Operation
public java.lang.String[][] getResponseLogElements()
null
if there is no value for that
field.
getResponseLogElements
in interface Operation
public ResultCode getResultCode()
getResultCode
in interface Operation
UNDEFINED
if the operation has not yet
completed.public boolean isInternalOperation()
isInternalOperation
in interface Operation
true
if this is an internal operation, or
false
if it is not.public boolean isSynchronizationOperation()
isSynchronizationOperation
in interface Operation
true
if this is a data synchronization
operation, or false
if it is not.public void operationCompleted()
operationCompleted
in interface Operation
public java.lang.Object removeAttachment(java.lang.String name)
removeAttachment
in interface Operation
name
- The name for the attachment to remove. It will be
treated in a case-sensitive manner.
null
if it
does not exist.public void removeRequestControl(Control control)
removeRequestControl
in interface Operation
control
- The control to remove from the set of request
controls for this operation.public void removeResponseControl(Control control)
removeResponseControl
in interface Operation
control
- The control to remove from the set of controls
to include in the response to the client.public void setAdditionalLogMessage(MessageBuilder additionalLogMessage)
setAdditionalLogMessage
in interface Operation
additionalLogMessage
- The additional log message for thispublic java.lang.Object setAttachment(java.lang.String name, java.lang.Object value)
setAttachment
in interface Operation
name
- The name to use for the attachment.value
- The value to use for the attachment.
null
if there was previously no such
attachment.public void setAttachments(java.util.Map<java.lang.String,java.lang.Object> attachments)
setAttachments
in interface Operation
attachments
- - Attachments to register within the
operationpublic void setAuthorizationEntry(Entry authorizationEntry)
setAuthorizationEntry
in interface Operation
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.public void setDontSynchronize(boolean dontSynchronize)
setDontSynchronize
in interface Operation
dontSynchronize
- Specifies whether this operation must be
synchronized to other copies
of the data.public void setErrorMessage(MessageBuilder errorMessage)
setErrorMessage
in interface Operation
errorMessage
- The error message for this operation.public void setInternalOperation(boolean isInternalOperation)
setInternalOperation
in interface Operation
isInternalOperation
- Specifies whether this is an
internal operation rather than one
that was requested by an external
client.public void setMatchedDN(DN matchedDN)
setMatchedDN
in interface Operation
matchedDN
- The matched DN for this operation.public void setReferralURLs(java.util.List<java.lang.String> referralURLs)
setReferralURLs
in interface Operation
referralURLs
- The set of referral URLs for this
operation.public void setResponseData(DirectoryException directoryException)
DirectoryException
object. This method may not be called by post-response plugins.
setResponseData
in interface Operation
directoryException
- The exception containing the
information to use for the response
elements.public void setResultCode(ResultCode resultCode)
setResultCode
in interface Operation
resultCode
- The result code for this operation.public void setSynchronizationOperation(boolean isSynchronizationOperation)
setSynchronizationOperation
in interface Operation
isSynchronizationOperation
- Specifies whether this is a
synchronization operation
rather than one that was
requested by an external
client.public void toString(java.lang.StringBuilder buffer)
toString
in interface Operation
buffer
- The buffer into which a string representation of
this operation should be appended.public final void checkIfCanceled(boolean signalTooLate) throws CanceledOperationException
checkIfCanceled
in interface Operation
signalTooLate
- true
to signal that any further
cancel requests will be too late after
return from this call or false
otherwise.
CanceledOperationException
- if this operation should
be cancelled.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |