|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.types.AbstractOperation
org.opends.server.core.ExtendedOperationBasis
public class ExtendedOperationBasis
This class defines an extended operation, which can perform virtually any kind of task.
Field Summary |
---|
Fields inherited from class org.opends.server.types.AbstractOperation |
---|
cancelRequest, cancelResult, clientConnection, messageID, NO_RESPONSE_CONTROLS, operationID, useNanoTime |
Fields inherited from interface org.opends.server.types.Operation |
---|
LOCALBACKENDOPERATIONS |
Constructor Summary | |
---|---|
ExtendedOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
java.util.List<Control> requestControls,
java.lang.String requestOID,
ASN1OctetString requestValue)
Creates a new extended operation with the provided information. |
Method Summary | |
---|---|
void |
addResponseControl(Control control)
Adds the provided control to the set of controls to include in the response to the client. |
OperationType |
getOperationType()
Retrieves the operation type for this operation. |
java.lang.String[][] |
getRequestLogElements()
Retrieves a standard set of elements that should be logged in requests for this type of operation. |
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.util.List<Control> |
getResponseControls()
Retrieves the set of controls to include in the response to the client. |
java.lang.String[][] |
getResponseLogElements()
Retrieves a standard set of elements that should be logged in responses for this type of 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 |
removeResponseControl(Control control)
Removes the provided control from the set of controls to include in the response to the client. |
void |
run()
Performs the work of actually processing this operation. |
void |
sendExtendedResponse()
Sends an extended response to the client if none has already been sent. |
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 |
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. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this operation to the provided buffer. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.opends.server.types.operation.PreParseOperation |
---|
addRequestControl, appendAdditionalLogMessage, appendErrorMessage, getAdditionalLogMessage, getErrorMessage, removeRequestControl, setAdditionalLogMessage, setErrorMessage |
Methods inherited from interface org.opends.server.types.operation.PreOperationOperation |
---|
appendAdditionalLogMessage, appendErrorMessage, getAdditionalLogMessage, getAuthorizationDN, getErrorMessage, setAdditionalLogMessage, setErrorMessage |
Methods inherited from interface org.opends.server.types.operation.PostOperationOperation |
---|
appendAdditionalLogMessage, appendErrorMessage, getAdditionalLogMessage, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, setAdditionalLogMessage, setErrorMessage, setMatchedDN, setReferralURLs, setResponseData, setResultCode |
Methods inherited from interface org.opends.server.types.operation.PluginOperation |
---|
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getProcessingStartTime, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString |
Constructor Detail |
---|
public ExtendedOperationBasis(ClientConnection clientConnection, long operationID, int messageID, java.util.List<Control> requestControls, java.lang.String requestOID, ASN1OctetString requestValue)
clientConnection
- The client connection with which this operation
is associated.operationID
- The operation ID for this operation.messageID
- The message ID of the request with which this
operation is associated.requestControls
- The set of controls included in the request.requestOID
- The OID for the request associated with this
extended operation.requestValue
- The value for the request associated with this
extended operation.Method Detail |
---|
public final java.lang.String getRequestOID()
getRequestOID
in interface ExtendedOperation
getRequestOID
in interface PostOperationExtendedOperation
getRequestOID
in interface PostResponseExtendedOperation
getRequestOID
in interface PreOperationExtendedOperation
getRequestOID
in interface PreParseExtendedOperation
public final void setRequestOID(java.lang.String requestOID)
setRequestOID
in interface PreParseExtendedOperation
requestOID
- The OID for the request associated with this extended
operation.public final ASN1OctetString getRequestValue()
getRequestValue
in interface ExtendedOperation
getRequestValue
in interface PostOperationExtendedOperation
getRequestValue
in interface PostResponseExtendedOperation
getRequestValue
in interface PreOperationExtendedOperation
getRequestValue
in interface PreParseExtendedOperation
public final void setRequestValue(ASN1OctetString requestValue)
setRequestValue
in interface PreParseExtendedOperation
requestValue
- The value for the request associated with this
extended operation.public final java.lang.String getResponseOID()
getResponseOID
in interface ExtendedOperation
getResponseOID
in interface PostOperationExtendedOperation
getResponseOID
in interface PostResponseExtendedOperation
public final void setResponseOID(java.lang.String responseOID)
setResponseOID
in interface ExtendedOperation
setResponseOID
in interface PostOperationExtendedOperation
setResponseOID
in interface PreOperationExtendedOperation
setResponseOID
in interface PreParseExtendedOperation
responseOID
- The OID to include in the response to the
client.public final ASN1OctetString getResponseValue()
getResponseValue
in interface ExtendedOperation
getResponseValue
in interface PostOperationExtendedOperation
getResponseValue
in interface PostResponseExtendedOperation
public final void setResponseValue(ASN1OctetString responseValue)
setResponseValue
in interface ExtendedOperation
setResponseValue
in interface PostOperationExtendedOperation
setResponseValue
in interface PreOperationExtendedOperation
setResponseValue
in interface PreParseExtendedOperation
responseValue
- The value to include in the response to
the client.public final OperationType getOperationType()
getOperationType
in interface Operation
getOperationType
in interface PluginOperation
getOperationType
in class AbstractOperation
public final java.lang.String[][] getRequestLogElements()
null
if there is no value for that
field.
getRequestLogElements
in interface Operation
getRequestLogElements
in class AbstractOperation
public final java.lang.String[][] getResponseLogElements()
null
if there is no value for that
field.
getResponseLogElements
in interface Operation
getResponseLogElements
in class AbstractOperation
public final java.util.List<Control> getResponseControls()
getResponseControls
in interface Operation
getResponseControls
in interface PluginOperation
getResponseControls
in class AbstractOperation
public final void addResponseControl(Control control)
addResponseControl
in interface Operation
addResponseControl
in interface PostOperationOperation
addResponseControl
in interface PreOperationOperation
addResponseControl
in interface PreParseOperation
addResponseControl
in class AbstractOperation
control
- The control to add to the set of controls to
include in the response to the client.public final void removeResponseControl(Control control)
removeResponseControl
in interface Operation
removeResponseControl
in interface PostOperationOperation
removeResponseControl
in interface PreOperationOperation
removeResponseControl
in interface PreParseOperation
removeResponseControl
in class AbstractOperation
control
- The control to remove from the set of controls
to include in the response to the client.public final void run()
run
in interface java.lang.Runnable
run
in class AbstractOperation
public final void sendExtendedResponse()
public final void setResponseSent()
setResponseSent
in interface ExtendedOperation
public final void toString(java.lang.StringBuilder buffer)
toString
in interface Operation
toString
in interface PluginOperation
toString
in class AbstractOperation
buffer
- The buffer into which a string representation of
this operation should be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |