@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface Operation extends Runnable
org.opends.server.core
package.Modifier and Type | Method and Description |
---|---|
void |
addAdditionalLogItem(AdditionalLogItem item)
Adds an additional log item to this operation, which should be written to the log but not included in the
response to the client.
|
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 |
appendErrorMessage(LocalizableMessage message)
Appends the provided message to the error message buffer.
|
void |
appendMaskedErrorMessage(LocalizableMessage maskedMessage)
Appends the provided message to the real, masked error message buffer.
|
void |
disconnectClient(DisconnectReason disconnectReason,
boolean sendNotification,
LocalizableMessage 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.
|
List<AdditionalLogItem> |
getAdditionalLogItems()
Returns an unmodifiable list containing the additional log items for this operation, which should be written to
the log but not included in the response to the client.
|
<T> T |
getAttachment(String name)
Retrieves the attachment with the specified name.
|
Map<String,Object> |
getAttachments()
Retrieves the set of attachments defined for this operation, as a mapping between the attachment name and the
associated object.
|
org.forgerock.opendj.ldap.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.
|
ClientConnection |
getClientConnection()
Retrieves the client connection with which this operation is associated.
|
long |
getConnectionID()
Retrieves the unique identifier that is assigned to the client connection that submitted this operation.
|
org.forgerock.services.context.Context |
getContext()
Returns the context associated to this operation.
|
LocalizableMessageBuilder |
getErrorMessage()
Retrieves the error message for this operation.
|
LocalizableMessageBuilder |
getMaskedErrorMessage()
Retrieves the real, masked error message for this operation.
|
org.forgerock.opendj.ldap.ResultCode |
getMaskedResultCode()
Retrieves the real, masked result code for this operation.
|
org.forgerock.opendj.ldap.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.
|
org.forgerock.opendj.ldap.Dn |
getProxiedAuthorizationDN()
Retrieves the proxied authorization DN for this operation if proxied authorization has been requested.
|
List<String> |
getReferralURLs()
Retrieves the set of referral URLs for this operation.
|
<T extends Control> |
getRequestControl(ControlDecoder<T> d)
Retrieves a control included in the request from the client.
|
List<Control> |
getRequestControls()
Retrieves the set of controls included in the request from the client.
|
List<Control> |
getResponseControls()
Retrieves the set of controls to include in the response to the client.
|
org.forgerock.opendj.ldap.ResultCode |
getResultCode()
Retrieves the result code for this operation.
|
boolean |
isInnerOperation()
Indicates whether this is an inner operation rather than one that was directly requested by an external client.
|
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.
|
void |
registerPostResponseCallback(Runnable callback)
Registers a callback which should be run once this operation has completed and the response sent back to the
client.
|
<T> T |
removeAttachment(String name)
Removes the attachment with the specified name.
|
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.
|
<T> T |
setAttachment(String name,
Object value)
Sets the value of the specified attachment.
|
void |
setAttachments(Map<String,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(LocalizableMessageBuilder errorMessage)
Specifies the error message for this operation.
|
void |
setInnerOperation(boolean isInnerOperation)
Specifies whether this is an inner operation rather than one that was directly requested by an external client.
|
void |
setInternalOperation(boolean isInternalOperation)
Specifies whether this is an internal operation rather than one that was requested by an external client.
|
void |
setMaskedErrorMessage(LocalizableMessageBuilder maskedErrorMessage)
Specifies the real, masked error message for this operation.
|
void |
setMaskedResultCode(org.forgerock.opendj.ldap.ResultCode maskedResultCode)
Specifies the real, masked result code for this operation.
|
void |
setMatchedDN(org.forgerock.opendj.ldap.Dn matchedDN)
Specifies the matched DN for this operation.
|
void |
setProxiedAuthorizationDN(org.forgerock.opendj.ldap.Dn proxiedAuthorizationDN)
Set the proxied authorization DN for this operation if proxied authorization has been requested.
|
void |
setReferralURLs(List<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 |
setResult(org.forgerock.opendj.ldap.messages.Result result)
Specifies the result for this operation.
|
void |
setResultCode(org.forgerock.opendj.ldap.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.
|
String |
toString()
Retrieves a string representation of this operation.
|
void |
toString(StringBuilder buffer)
Appends a string representation of this operation to the provided buffer.
|
OperationType getOperationType()
void disconnectClient(DisconnectReason disconnectReason, boolean sendNotification, LocalizableMessage message)
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.ClientConnection getClientConnection()
long getConnectionID()
long getOperationID()
int getMessageID()
List<Control> getRequestControls()
<T extends Control> T getRequestControl(ControlDecoder<T> d) throws DirectoryException
T
- The type of control requested.d
- The requested control's decoder.null
if
the control was not found.DirectoryException
- if an error occurs while decoding the control.void addRequestControl(Control control)
control
- The control to add to the set of request controls for this operation.List<Control> getResponseControls()
void addResponseControl(Control control)
control
- The control to add to the set of controls to include in the response to the client.void removeResponseControl(Control control)
control
- The control to remove from the set of controls to include in the response to the client.void setResult(org.forgerock.opendj.ldap.messages.Result result)
result
- The result for this operation.org.forgerock.opendj.ldap.ResultCode getResultCode()
UNDEFINED
if the operation has not yet
completed.void setResultCode(org.forgerock.opendj.ldap.ResultCode resultCode)
resultCode
- The result code for this operation.org.forgerock.opendj.ldap.ResultCode getMaskedResultCode()
UNDEFINED
if the operation has not
yet completed.void setMaskedResultCode(org.forgerock.opendj.ldap.ResultCode maskedResultCode)
maskedResultCode
- The real, masked result code for this operation.LocalizableMessageBuilder getErrorMessage()
void setErrorMessage(LocalizableMessageBuilder errorMessage)
errorMessage
- The error message for this operation.void appendErrorMessage(LocalizableMessage message)
message
- The message to append to the error messageLocalizableMessageBuilder getMaskedErrorMessage()
void setMaskedErrorMessage(LocalizableMessageBuilder maskedErrorMessage)
maskedErrorMessage
- The real, masked error message for this operation.void appendMaskedErrorMessage(LocalizableMessage maskedMessage)
maskedMessage
- The message to append to the real, masked error messageList<AdditionalLogItem> getAdditionalLogItems()
void addAdditionalLogItem(AdditionalLogItem item)
item
- The additional log item for this operation.org.forgerock.opendj.ldap.Dn getMatchedDN()
null
if the operation has not yet completed or does not
have a matched DN.void setMatchedDN(org.forgerock.opendj.ldap.Dn matchedDN)
matchedDN
- The matched DN for this operation.List<String> getReferralURLs()
null
if the operation is not yet complete or does
not have a set of referral URLs.void setReferralURLs(List<String> referralURLs)
referralURLs
- The set of referral URLs for this operation.void setResponseData(DirectoryException directoryException)
DirectoryException
object. This method may not be called by post-response plugins.directoryException
- The exception containing the information to use for the response elements.boolean isInternalOperation()
true
if this is an internal operation, or false
if it is not.void setInternalOperation(boolean isInternalOperation)
isInternalOperation
- Specifies whether this is an internal operation rather than one that was requested by an external
client.boolean isInnerOperation()
true
if this is an inner operation, or false
if it is not.void setInnerOperation(boolean isInnerOperation)
isInnerOperation
- Specifies whether this is an inner operation rather than one that was requested by an external client.boolean isSynchronizationOperation()
true
if this is a data synchronization operation, or false
if it is not.void setSynchronizationOperation(boolean isSynchronizationOperation)
isSynchronizationOperation
- Specifies whether this is a synchronization operation rather than one that was requested by an
external client.void setDontSynchronize(boolean dontSynchronize)
dontSynchronize
- Specifies whether this operation must be synchronized to other copies of the data.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.null
if the authorization identity should be the unauthenticated user.void setAuthorizationEntry(Entry authorizationEntry)
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.org.forgerock.opendj.ldap.Dn getAuthorizationDN()
org.forgerock.opendj.ldap.Dn getProxiedAuthorizationDN()
null
if proxied authorization has not been requested.void setProxiedAuthorizationDN(org.forgerock.opendj.ldap.Dn proxiedAuthorizationDN)
proxiedAuthorizationDN
- The proxied authorization DN for this operation if proxied authorization has been requested, or
null
if proxied authorization has not been requested.Map<String,Object> getAttachments()
<T> T getAttachment(String name)
T
- the type of the attached objectname
- The name for the attachment to retrieve. It will be treated in a case-sensitive manner.null
if it does not exist.<T> T removeAttachment(String name)
T
- the type of the attached objectname
- The name for the attachment to remove. It will be treated in a case-sensitive manner.null
if it does not exist.<T> T setAttachment(String name, Object value)
T
- the type of the attached objectname
- The name to use for the attachment.value
- The value to use for the attachment.null
if there was previously no
such attachment.long getProcessingStartTime()
long getProcessingStopTime()
long getProcessingTime()
long getProcessingNanoTime()
void operationCompleted()
org.forgerock.services.context.Context getContext()
String toString()
void toString(StringBuilder buffer)
buffer
- The buffer into which a string representation of this operation should be appended.boolean dontSynchronize()
true
if this operation should not be synchronized, or false
if it should be synchronized.void setAttachments(Map<String,Object> attachments)
attachments
- - Attachments to register within the operationvoid registerPostResponseCallback(Runnable callback)
callback
- The callback to be run once this operation has completed and the response sent back to the client.void run()
Copyright © 2010–2017 ForgeRock AS. All rights reserved.