Interface PreOperationExtendedOperation
-
- All Superinterfaces:
PluginOperation
,PreOperationOperation
- All Known Implementing Classes:
ExtendedOperation
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface PreOperationExtendedOperation extends PreOperationOperation
This class defines a set of methods that are available for use by pre-operation plugins for extended 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 String
getRequestOID()
Retrieves the OID for the request associated with this extended operation.ByteString
getRequestValue()
Retrieves the value for the request associated with this extended operation.void
setResponseOID(String responseOID)
Specifies the OID to include in the response to the client.void
setResponseValue(ByteString responseValue)
Specifies the value to include in the response to the client.-
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
-
Methods inherited from interface org.opends.server.types.operation.PreOperationOperation
addAdditionalLogItem, addResponseControl, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, removeResponseControl, setErrorMessage
-
-
-
-
Method Detail
-
getRequestOID
String getRequestOID()
Retrieves the OID for the request associated with this extended operation.- Returns:
- The OID for the request associated with this extended operation.
-
getRequestValue
ByteString getRequestValue()
Retrieves the value for the request associated with this extended operation.- Returns:
- The value for the request associated with this extended operation.
-
setResponseOID
void setResponseOID(String responseOID)
Specifies the OID to include in the response to the client.- Parameters:
responseOID
- The OID to include in the response to the client.
-
setResponseValue
void setResponseValue(ByteString responseValue)
Specifies the value to include in the response to the client.- Parameters:
responseValue
- The value to include in the response to the client.
-
-