org.opends.server.core
Interface ExtendedOperation
- All Superinterfaces:
- Operation
- All Known Implementing Classes:
- ExtendedOperationBasis
public interface ExtendedOperation
- extends Operation
This interface defines an extended operation, which can perform virtually any
kind of task.
Method Summary |
java.lang.String |
getRequestOID()
Retrieves the OID for the request associated with this extended
operation. |
ASN1OctetString |
getRequestValue()
Retrieves the value for the request associated with this extended
operation. |
java.lang.String |
getResponseOID()
Retrieves the OID to include in the response to the client. |
ASN1OctetString |
getResponseValue()
Retrieves the value to include in the response to the client. |
void |
setResponseOID(java.lang.String responseOID)
Specifies the OID to include in the response to the client. |
void |
setResponseSent()
Indicates that the response for this extended operation has been sent from
somewhere outside of this class. |
void |
setResponseValue(ASN1OctetString responseValue)
Specifies the value to include in the response to the client. |
Methods inherited from interface org.opends.server.types.Operation |
abort, addRequestControl, addResponseControl, appendAdditionalLogMessage, appendErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, getAdditionalLogMessage, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getCommonLogElements, getConnectionID, getErrorMessage, getMatchedDN, getMessageID, getOperationID, getOperationType, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControls, getRequestLogElements, getResponseControls, getResponseLogElements, getResultCode, isInternalOperation, isSynchronizationOperation, operationCompleted, removeAttachment, removeRequestControl, removeResponseControl, setAdditionalLogMessage, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInternalOperation, setMatchedDN, setReferralURLs, setResponseData, setResultCode, setSynchronizationOperation, toString, toString |
getRequestOID
java.lang.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
ASN1OctetString getRequestValue()
- Retrieves the value for the request associated with this extended
operation.
- Returns:
- The value for the request associated with this extended
operation.
getResponseOID
java.lang.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(java.lang.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
ASN1OctetString 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(ASN1OctetString responseValue)
- Specifies the value to include in the response to the client.
- Parameters:
responseValue
- The value to include in the response to
the client.
setResponseSent
void setResponseSent()
- Indicates that the response for this extended operation has been sent from
somewhere outside of this class. This should only be used by the StartTLS
extended operation for the case in which it needs to send a response in the
clear after TLS negotiation has already started on the connection.