@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface PreOperationOperation extends PluginOperation
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 |
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.
|
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.
|
org.forgerock.opendj.ldap.Dn |
getAuthorizationDN()
Retrieves the authorization DN for this operation.
|
LocalizableMessageBuilder |
getErrorMessage()
Retrieves the error message 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 |
setErrorMessage(LocalizableMessageBuilder errorMessage)
Specifies the error message for this operation.
|
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getOperationType, getProcessingStartTime, getRequestControl, getRequestControls, getResponseControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString, toString
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.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 message
buffer.org.forgerock.opendj.ldap.Dn getAuthorizationDN()
List<AdditionalLogItem> getAdditionalLogItems()
void addAdditionalLogItem(AdditionalLogItem item)
item
- The additional log item for this operation.Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.