Package org.opends.server.core
Interface ExtendedOperation
-
- All Known Implementing Classes:
ExtendedOperationBasis,ExtendedOperationWrapper
public interface ExtendedOperation extends Operation
This interface defines an extended operation, which can perform virtually any kind of task.
-
-
Field Summary
-
Fields inherited from interface org.opends.server.types.Operation
LOCALBACKENDOPERATIONS
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetRequestOID()Retrieves the OID for the request associated with this extended operation.ByteStringgetRequestValue()Retrieves the value for the request associated with this extended operation.StringgetResponseOID()Retrieves the OID to include in the response to the client.ByteStringgetResponseValue()Retrieves the value to include in the response to the client.voidsetResponseOID(String responseOID)Specifies the OID to include in the response to the client.voidsetResponseValue(ByteString responseValue)Specifies the value to include in the response to the client.-
Methods inherited from interface org.opends.server.types.Operation
abort, addAdditionalLogItem, addRequestControl, addResponseControl, appendErrorMessage, appendMaskedErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getConnectionID, getErrorMessage, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperationID, getOperationType, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getProxiedAuthorizationDN, getReferralURLs, getRequestControl, getRequestControls, getResponseControls, getResultCode, isInnerOperation, isInternalOperation, isSynchronizationOperation, operationCompleted, registerPostResponseCallback, removeAttachment, removeResponseControl, run, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, setMatchedDN, setProxiedAuthorizationDN, setReferralURLs, setResponseData, setResultCode, setSynchronizationOperation, toString, toString
-
-
-
-
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.
-
getResponseOID
String getResponseOID()
Retrieves the OID to include in the response to the client.- Returns:
- The OID to include in the response to the client.
-
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.
-
getResponseValue
ByteString getResponseValue()
Retrieves the value to include in the response to the client.- Returns:
- The value 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.
-
-