public class ExtendedOperationBasis extends AbstractOperation implements ExtendedOperation, PreParseExtendedOperation, PreOperationExtendedOperation, PostOperationExtendedOperation, PostResponseExtendedOperation
cancelRequest, cancelResult, clientConnection, messageID, NO_RESPONSE_CONTROLS, operationID
LOCALBACKENDOPERATIONS
Constructor and Description |
---|
ExtendedOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
org.forgerock.opendj.ldap.messages.ExtendedRequest<?> extendedRequest)
Creates a new extended operation with the provided information.
|
Modifier and Type | Method and Description |
---|---|
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.
|
org.forgerock.opendj.ldap.Dn |
getProxiedAuthorizationDN()
Retrieves the proxied authorization DN for this operation if proxied
authorization has been requested.
|
String |
getRequestOID()
Retrieves the OID for the request associated with this extended
operation.
|
org.forgerock.opendj.ldap.ByteString |
getRequestValue()
Retrieves the value for the request associated with this extended
operation.
|
List<Control> |
getResponseControls()
Retrieves the set of controls to include in the response to the
client.
|
String |
getResponseOID()
Retrieves the OID to include in the response to the client.
|
org.forgerock.opendj.ldap.ByteString |
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 |
setProxiedAuthorizationDN(org.forgerock.opendj.ldap.Dn proxiedAuthorizationDN)
Set the proxied authorization DN for this operation if proxied
authorization has been requested.
|
void |
setRequestOID(String requestOID)
Specifies the OID for the request associated with this extended operation.
|
void |
setRequestValue(org.forgerock.opendj.ldap.ByteString requestValue)
Specifies 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(org.forgerock.opendj.ldap.ByteString responseValue)
Specifies the value to include in the response to the client.
|
void |
toString(StringBuilder buffer)
Appends a string representation of this operation to the provided
buffer.
|
abort, addAdditionalLogItem, addRequestControl, appendErrorMessage, appendMaskedErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, equals, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getConnectionID, getErrorMessage, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperationID, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControl, getRequestControls, getResultCode, hashCode, invokePostResponseCallbacks, isInnerOperation, isInternalOperation, isSynchronizationOperation, operationCompleted, processOperationResult, processOperationResult, registerPostResponseCallback, removeAttachment, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, setMatchedDN, setProcessingStartTime, setProcessingStopTime, setReferralURLs, setResponseData, setResultCode, setSynchronizationOperation, toString, updateOperationErrMsgAndResCode
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
abort, addAdditionalLogItem, addRequestControl, appendErrorMessage, appendMaskedErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getConnectionID, getErrorMessage, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperationID, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControl, getRequestControls, getResultCode, isInnerOperation, isInternalOperation, isSynchronizationOperation, operationCompleted, registerPostResponseCallback, removeAttachment, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, setMatchedDN, setReferralURLs, setResponseData, setResultCode, setSynchronizationOperation, toString
addAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, setErrorMessage
addAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, setErrorMessage
addAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, setErrorMessage, setMatchedDN, setReferralURLs, setResponseData, setResultCode
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getProcessingStartTime, getRequestControl, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString
public ExtendedOperationBasis(ClientConnection clientConnection, long operationID, int messageID, org.forgerock.opendj.ldap.messages.ExtendedRequest<?> extendedRequest)
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.extendedRequest
- The extended request.public final String getRequestOID()
ExtendedOperation
getRequestOID
in interface ExtendedOperation
getRequestOID
in interface PostOperationExtendedOperation
getRequestOID
in interface PostResponseExtendedOperation
getRequestOID
in interface PreOperationExtendedOperation
getRequestOID
in interface PreParseExtendedOperation
public final void setRequestOID(String requestOID)
setRequestOID
in interface PreParseExtendedOperation
requestOID
- The OID for the request associated with this extended
operation.public org.forgerock.opendj.ldap.Dn getProxiedAuthorizationDN()
Operation
getProxiedAuthorizationDN
in interface Operation
null
if proxied
authorization has not been requested.public void setProxiedAuthorizationDN(org.forgerock.opendj.ldap.Dn proxiedAuthorizationDN)
Operation
setProxiedAuthorizationDN
in interface Operation
proxiedAuthorizationDN
- The proxied authorization DN for this operation if proxied
authorization has been requested, or null
if proxied
authorization has not been requested.public final org.forgerock.opendj.ldap.ByteString getRequestValue()
ExtendedOperation
getRequestValue
in interface ExtendedOperation
getRequestValue
in interface PostOperationExtendedOperation
getRequestValue
in interface PostResponseExtendedOperation
getRequestValue
in interface PreOperationExtendedOperation
getRequestValue
in interface PreParseExtendedOperation
public final void setRequestValue(org.forgerock.opendj.ldap.ByteString requestValue)
setRequestValue
in interface PreParseExtendedOperation
requestValue
- The value for the request associated with this
extended operation.public final String getResponseOID()
ExtendedOperation
getResponseOID
in interface ExtendedOperation
getResponseOID
in interface PostOperationExtendedOperation
getResponseOID
in interface PostResponseExtendedOperation
public final void setResponseOID(String responseOID)
ExtendedOperation
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 org.forgerock.opendj.ldap.ByteString getResponseValue()
ExtendedOperation
getResponseValue
in interface ExtendedOperation
getResponseValue
in interface PostOperationExtendedOperation
getResponseValue
in interface PostResponseExtendedOperation
public final void setResponseValue(org.forgerock.opendj.ldap.ByteString responseValue)
ExtendedOperation
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()
Operation
getOperationType
in interface Operation
getOperationType
in interface PluginOperation
public final List<Control> getResponseControls()
Operation
getResponseControls
in interface Operation
getResponseControls
in interface PluginOperation
public final void addResponseControl(Control control)
Operation
addResponseControl
in interface Operation
addResponseControl
in interface PostOperationOperation
addResponseControl
in interface PreOperationOperation
addResponseControl
in interface PreParseOperation
control
- The control to add to the set of controls to
include in the response to the client.public final void removeResponseControl(Control control)
Operation
removeResponseControl
in interface Operation
removeResponseControl
in interface PostOperationOperation
removeResponseControl
in interface PreOperationOperation
removeResponseControl
in interface PreParseOperation
control
- The control to remove from the set of controls
to include in the response to the client.public final void run()
public final void toString(StringBuilder buffer)
Operation
toString
in interface Operation
toString
in interface PluginOperation
buffer
- The buffer into which a string representation of
this operation should be appended.Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.