public class ExtendedOperationBasis extends AbstractOperation implements ExtendedOperation, PreParseExtendedOperation, PreOperationExtendedOperation, PostOperationExtendedOperation, PostResponseExtendedOperation
cancelRequest, cancelResult, clientConnection, messageID, NO_RESPONSE_CONTROLS, operationIDLOCALBACKENDOPERATIONS| Constructor and Description |
|---|
ExtendedOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
List<Control> requestControls,
String requestOID,
org.forgerock.opendj.ldap.ByteString requestValue)
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.
|
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(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, updateOperationErrMsgAndResCodeclone, finalize, getClass, notify, notifyAll, wait, wait, waitabort, 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, toStringaddAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, setErrorMessageaddAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, setErrorMessageaddAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, setErrorMessage, setMatchedDN, setReferralURLs, setResponseData, setResultCodecheckIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getProcessingStartTime, getRequestControl, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toStringpublic ExtendedOperationBasis(ClientConnection clientConnection, long operationID, int messageID, List<Control> requestControls, String requestOID, org.forgerock.opendj.ldap.ByteString 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.public final String getRequestOID()
getRequestOID in interface ExtendedOperationgetRequestOID in interface PostOperationExtendedOperationgetRequestOID in interface PostResponseExtendedOperationgetRequestOID in interface PreOperationExtendedOperationgetRequestOID in interface PreParseExtendedOperationpublic final void setRequestOID(String requestOID)
setRequestOID in interface PreParseExtendedOperationrequestOID - The OID for the request associated with this extended
operation.public DN getProxiedAuthorizationDN()
getProxiedAuthorizationDN in interface Operationnull if proxied
authorization has not been requested.public void setProxiedAuthorizationDN(DN proxiedAuthorizationDN)
setProxiedAuthorizationDN in interface OperationproxiedAuthorizationDN - 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()
getRequestValue in interface ExtendedOperationgetRequestValue in interface PostOperationExtendedOperationgetRequestValue in interface PostResponseExtendedOperationgetRequestValue in interface PreOperationExtendedOperationgetRequestValue in interface PreParseExtendedOperationpublic final void setRequestValue(org.forgerock.opendj.ldap.ByteString requestValue)
setRequestValue in interface PreParseExtendedOperationrequestValue - The value for the request associated with this
extended operation.public final String getResponseOID()
getResponseOID in interface ExtendedOperationgetResponseOID in interface PostOperationExtendedOperationgetResponseOID in interface PostResponseExtendedOperationpublic final void setResponseOID(String responseOID)
setResponseOID in interface ExtendedOperationsetResponseOID in interface PostOperationExtendedOperationsetResponseOID in interface PreOperationExtendedOperationsetResponseOID in interface PreParseExtendedOperationresponseOID - The OID to include in the response to the
client.public final org.forgerock.opendj.ldap.ByteString getResponseValue()
getResponseValue in interface ExtendedOperationgetResponseValue in interface PostOperationExtendedOperationgetResponseValue in interface PostResponseExtendedOperationpublic final void setResponseValue(org.forgerock.opendj.ldap.ByteString responseValue)
setResponseValue in interface ExtendedOperationsetResponseValue in interface PostOperationExtendedOperationsetResponseValue in interface PreOperationExtendedOperationsetResponseValue in interface PreParseExtendedOperationresponseValue - The value to include in the response to
the client.public final OperationType getOperationType()
getOperationType in interface OperationgetOperationType in interface PluginOperationpublic final List<Control> getResponseControls()
getResponseControls in interface OperationgetResponseControls in interface PluginOperationpublic final void addResponseControl(Control control)
addResponseControl in interface OperationaddResponseControl in interface PostOperationOperationaddResponseControl in interface PreOperationOperationaddResponseControl in interface PreParseOperationcontrol - 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 OperationremoveResponseControl in interface PostOperationOperationremoveResponseControl in interface PreOperationOperationremoveResponseControl in interface PreParseOperationcontrol - 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)
toString in interface OperationtoString in interface PluginOperationbuffer - The buffer into which a string representation of
this operation should be appended.Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.