Interface PreParseOperation
-
- All Superinterfaces:
PluginOperation
- All Known Subinterfaces:
PreParseAbandonOperation
,PreParseAddOperation
,PreParseBindOperation
,PreParseCompareOperation
,PreParseDeleteOperation
,PreParseExtendedOperation
,PreParseModifyDNOperation
,PreParseModifyOperation
,PreParseSearchOperation
,PreParseUnbindOperation
- All Known Implementing Classes:
AbandonOperation
,AddOperation
,BindOperation
,CompareOperation
,DeleteOperation
,ExtendedOperation
,ModifyDnOperation
,ModifyOperation
,Operation
,SearchOperation
,UnbindOperation
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface PreParseOperation extends PluginOperation
This class defines a set of methods that are available for use by pre-parse 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
All Methods Instance Methods Abstract Methods Modifier and Type Method 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.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.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.-
Methods inherited from interface org.opends.server.types.operation.PluginOperation
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getOperationType, getRequestControl, getRequestControl, getRequestControls, getResponseControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString, toString
-
-
-
-
Method Detail
-
addRequestControl
void addRequestControl(Control control)
Adds the provided control to the set of request controls for this operation.- Parameters:
control
- The control to add to the set of request controls for this operation.
-
addResponseControl
void addResponseControl(Control control)
Adds the provided control to the set of controls to include in the response to the client.- Parameters:
control
- The control to add to the set of controls to include in the response to the client.
-
removeResponseControl
void removeResponseControl(Control control)
Removes the provided control from the set of controls to include in the response to the client.- Parameters:
control
- The control to remove from the set of controls to include in the response to the client.
-
getErrorMessage
LocalizableMessageBuilder getErrorMessage()
Retrieves the error message for this operation. Its contents may be altered by the caller.- Returns:
- The error message for this operation.
-
setErrorMessage
void setErrorMessage(LocalizableMessageBuilder errorMessage)
Specifies the error message for this operation.- Parameters:
errorMessage
- The error message for this operation.
-
appendErrorMessage
void appendErrorMessage(LocalizableMessage message)
Appends the provided message to the error message buffer. If the buffer has not yet been created, then this will create it first and then add the provided message.- Parameters:
message
- The message to append to the error message buffer.
-
getAdditionalLogItems
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.- Returns:
- An unmodifiable list containing the additional log items for this operation.
-
addAdditionalLogItem
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. This method may not be called by post-response plugins.- Parameters:
item
- The additional log item for this operation.
-
-