|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface PreOperationOperation
This class defines a set of methods that are available for use by pre-operation plugins for all types of operations. Note that this interface is intended only to define an API for use by plugins and is not intended to be implemented by any custom classes.
Method Summary | |
---|---|
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. |
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. |
DN |
getAuthorizationDN()
Retrieves the authorization DN for this operation. |
MessageBuilder |
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 |
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. |
void |
setErrorMessage(MessageBuilder errorMessage)
Specifies the error message for this operation. |
Methods inherited from interface org.opends.server.types.operation.PluginOperation |
---|
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getOperationType, getProcessingStartTime, getRequestControls, getResponseControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString, toString |
Method Detail |
---|
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.MessageBuilder getErrorMessage()
void setErrorMessage(MessageBuilder errorMessage)
errorMessage
- The error message for this operation.void appendErrorMessage(Message message)
message
- The message to append to the error message
buffer.MessageBuilder getAdditionalLogMessage()
void setAdditionalLogMessage(MessageBuilder additionalLogMessage)
additionalLogMessage
- The additional log message for thisvoid appendAdditionalLogMessage(Message message)
message
- The message that should be appended to the
additional log information for this operation.DN getAuthorizationDN()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |