W
- the type of the object wrapped by this classpublic class OperationWrapper<W extends Operation> extends Object implements Operation
LOCALBACKENDOPERATIONS
Constructor and Description |
---|
OperationWrapper(W operation)
Creates a new generic operation wrapper.
|
Modifier and Type | Method and Description |
---|---|
void |
abort(CancelRequest cancelRequest)
Attempts to abort this operation before processing has
completed.
|
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.
|
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,
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.
|
boolean |
equals(Object obj) |
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.
|
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.
|
long |
getConnectionID()
Retrieves the unique identifier that is assigned to the client
connection that submitted 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.
|
protected W |
getOperation()
Returns the wrapped
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.
|
int |
hashCode() |
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 |
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.
|
public OperationWrapper(W operation)
operation
- the generic operation to wrappublic void addRequestControl(Control control)
Operation
addRequestControl
in interface Operation
control
- The control to add to the set of request
controls for this operation.public void addResponseControl(Control control)
Operation
addResponseControl
in interface Operation
control
- The control to add to the set of controls to
include in the response to the client.public void appendErrorMessage(LocalizableMessage message)
Operation
appendErrorMessage
in interface Operation
message
- The message to append to the error messagepublic void appendMaskedErrorMessage(LocalizableMessage maskedMessage)
Operation
appendMaskedErrorMessage
in interface Operation
maskedMessage
- The message to append to the real, masked error messagepublic CancelResult cancel(CancelRequest cancelRequest)
Operation
public void abort(CancelRequest cancelRequest)
Operation
public void disconnectClient(DisconnectReason disconnectReason, boolean sendNotification, LocalizableMessage message)
Operation
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()
Operation
dontSynchronize
in interface Operation
true
if this operation should not be
synchronized, or false
if it should be
synchronized.public <T> T getAttachment(String name)
Operation
getAttachment
in interface Operation
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.public Map<String,Object> getAttachments()
Operation
getAttachments
in interface Operation
public org.forgerock.opendj.ldap.Dn getAuthorizationDN()
Operation
getAuthorizationDN
in interface Operation
public Entry getAuthorizationEntry()
Operation
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 org.forgerock.opendj.ldap.Dn getProxiedAuthorizationDN()
Operation
getProxiedAuthorizationDN
in interface Operation
null
if proxied
authorization has not been requested.public void setProxiedAuthorizationDN(org.forgerock.opendj.ldap.Dn proxiedAuthorizationDN)
Operation
setProxiedAuthorizationDN
in interface Operation
proxiedAuthorizationDN
- The proxied authorization DN for this operation if proxied
authorization has been requested, or null
if proxied
authorization has not been requested.public CancelRequest getCancelRequest()
Operation
getCancelRequest
in interface Operation
null
if there has not been any
request to cancel.public CancelResult getCancelResult()
Operation
getCancelResult
in interface Operation
null
if the operation has not seen and reacted
to a cancel request.public ClientConnection getClientConnection()
Operation
getClientConnection
in interface Operation
public long getConnectionID()
Operation
getConnectionID
in interface Operation
public LocalizableMessageBuilder getErrorMessage()
Operation
getErrorMessage
in interface Operation
public LocalizableMessageBuilder getMaskedErrorMessage()
Operation
getMaskedErrorMessage
in interface Operation
public org.forgerock.opendj.ldap.ResultCode getMaskedResultCode()
Operation
getMaskedResultCode
in interface Operation
UNDEFINED
if the operation has not yet completed.public org.forgerock.opendj.ldap.Dn getMatchedDN()
Operation
getMatchedDN
in interface Operation
null
if
the operation has not yet completed or does not have a
matched DN.public int getMessageID()
Operation
getMessageID
in interface Operation
protected W getOperation()
Operation
.Operation
.public long getOperationID()
Operation
getOperationID
in interface Operation
public OperationType getOperationType()
Operation
getOperationType
in interface Operation
public long getProcessingStartTime()
Operation
getProcessingStartTime
in interface Operation
public long getProcessingStopTime()
Operation
getProcessingStopTime
in interface Operation
public long getProcessingTime()
Operation
getProcessingTime
in interface Operation
public long getProcessingNanoTime()
Operation
getProcessingNanoTime
in interface Operation
public List<String> getReferralURLs()
Operation
getReferralURLs
in interface Operation
null
if the operation is not yet complete or
does not have a set of referral URLs.public List<Control> getRequestControls()
Operation
getRequestControls
in interface Operation
public <T extends Control> T getRequestControl(ControlDecoder<T> d) throws DirectoryException
Operation
getRequestControl
in interface Operation
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.public List<Control> getResponseControls()
Operation
getResponseControls
in interface Operation
public org.forgerock.opendj.ldap.ResultCode getResultCode()
Operation
getResultCode
in interface Operation
UNDEFINED
if the operation has not yet
completed.public boolean isInnerOperation()
Operation
isInnerOperation
in interface Operation
true
if this is an inner operation, or false
if it
is not.public boolean isInternalOperation()
Operation
isInternalOperation
in interface Operation
true
if this is an internal operation, or
false
if it is not.public boolean isSynchronizationOperation()
Operation
isSynchronizationOperation
in interface Operation
true
if this is a data synchronization
operation, or false
if it is not.public void operationCompleted()
Operation
operationCompleted
in interface Operation
public <T> T removeAttachment(String name)
Operation
removeAttachment
in interface Operation
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.public void removeResponseControl(Control control)
Operation
removeResponseControl
in interface Operation
control
- The control to remove from the set of controls
to include in the response to the client.public <T> T setAttachment(String name, Object value)
Operation
setAttachment
in interface Operation
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.public void setAttachments(Map<String,Object> attachments)
Operation
setAttachments
in interface Operation
attachments
- - Attachments to register within the
operationpublic void setAuthorizationEntry(Entry authorizationEntry)
Operation
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)
Operation
setDontSynchronize
in interface Operation
dontSynchronize
- Specifies whether this operation must be
synchronized to other copies
of the data.public void setErrorMessage(LocalizableMessageBuilder errorMessage)
Operation
setErrorMessage
in interface Operation
errorMessage
- The error message for this operation.public void setInnerOperation(boolean isInnerOperation)
Operation
setInnerOperation
in interface Operation
isInnerOperation
- Specifies whether this is an inner operation rather than one that
was requested by an external client.public void setInternalOperation(boolean isInternalOperation)
Operation
setInternalOperation
in interface Operation
isInternalOperation
- Specifies whether this is an
internal operation rather than one
that was requested by an external
client.public void setMaskedErrorMessage(LocalizableMessageBuilder maskedErrorMessage)
Operation
setMaskedErrorMessage
in interface Operation
maskedErrorMessage
- The real, masked error message for this operation.public void setMaskedResultCode(org.forgerock.opendj.ldap.ResultCode maskedResultCode)
Operation
setMaskedResultCode
in interface Operation
maskedResultCode
- The real, masked result code for this operation.public void setMatchedDN(org.forgerock.opendj.ldap.Dn matchedDN)
Operation
setMatchedDN
in interface Operation
matchedDN
- The matched DN for this operation.public void setReferralURLs(List<String> referralURLs)
Operation
setReferralURLs
in interface Operation
referralURLs
- The set of referral URLs for this
operation.public void setResponseData(DirectoryException directoryException)
Operation
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(org.forgerock.opendj.ldap.ResultCode resultCode)
Operation
setResultCode
in interface Operation
resultCode
- The result code for this operation.public void setSynchronizationOperation(boolean isSynchronizationOperation)
Operation
setSynchronizationOperation
in interface Operation
isSynchronizationOperation
- Specifies whether this is a
synchronization operation
rather than one that was
requested by an external
client.public String toString()
Operation
public void toString(StringBuilder buffer)
Operation
public final void checkIfCanceled(boolean signalTooLate) throws CanceledOperationException
Operation
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.public void registerPostResponseCallback(Runnable callback)
Operation
registerPostResponseCallback
in interface Operation
callback
- The callback to be run once this operation has completed
and the response sent back to the client.public void run()
Operation
public List<AdditionalLogItem> getAdditionalLogItems()
Operation
getAdditionalLogItems
in interface Operation
public void addAdditionalLogItem(AdditionalLogItem item)
Operation
addAdditionalLogItem
in interface Operation
item
- The additional log item for this operation.Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.