org.opends.server.types.operation
Interface PreParseExtendedOperation

All Superinterfaces:
PluginOperation, PreParseOperation
All Known Implementing Classes:
ExtendedOperationBasis

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public interface PreParseExtendedOperation
extends PreParseOperation

This class defines a set of methods that are available for use by pre-parse 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
 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.
 void setRequestOID(java.lang.String requestOID)
          Specifies the OID for the request associated with this extended operation.
 void setRequestValue(ASN1OctetString requestValue)
          Specifies the value for the request associated with this extended operation.
 void setResponseOID(java.lang.String responseOID)
          Specifies the OID to include in the response to the client.
 void setResponseValue(ASN1OctetString responseValue)
          Specifies the value to include in the response to the client.
 
Methods inherited from interface org.opends.server.types.operation.PreParseOperation
addRequestControl, addResponseControl, appendAdditionalLogMessage, appendErrorMessage, getAdditionalLogMessage, getErrorMessage, removeRequestControl, removeResponseControl, setAdditionalLogMessage, setErrorMessage
 
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

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.

setRequestOID

void setRequestOID(java.lang.String requestOID)
Specifies the OID for the request associated with this extended operation.

Parameters:
requestOID - 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.

setRequestValue

void setRequestValue(ASN1OctetString requestValue)
Specifies the value for the request associated with this extended operation.

Parameters:
requestValue - The value for the request associated with this extended operation.

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.

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.