public class ExtendedOperation extends Operation implements PreParseExtendedOperation, PreOperationExtendedOperation, PostOperationExtendedOperation, PostResponseExtendedOperation
NO_RESPONSE_CONTROLS, requestContext
Constructor and Description |
---|
ExtendedOperation(org.forgerock.services.context.Context context,
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.
|
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.
|
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.
|
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(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(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.
|
addAdditionalLogItem, addPostReadResponse, addPreReadResponse, addRequestControl, appendErrorMessage, appendMaskedErrorMessage, checkAttributeConformsToSyntax, checkIfBackendIsWritable, checkIfCanceled, createLdapException, disconnectClient, dontSynchronize, equals, evaluateProxyAuthControls, filterNonDisclosableMatchedDN, findMatchedDN, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getClientConnection, getConnectionID, getContext, getErrorMessage, getLocalBackend, getMatchedDN, getMessageID, getOperationID, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControl, getRequestControls, getResultCode, hashCode, hasPrivilege, invokePostResponseCallbacks, isHumanReadable, isInnerOperation, isInternalOperation, isProxyAuthzControl, isSynchronizationOperation, mustCheckSchema, operationCompleted, processOperationResult, processOperationResult, registerPostResponseCallback, removeAllDisallowedControls, removeAttachment, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMatchedDN, setProcessingStartTime, setProcessingStopTime, setReferralURLs, setResponseData, setResult, setResultCode, setResultCodeAndMessageNoInfoDisclosure, setSynchronizationOperation, toString, updateOperationErrMsgAndResCode
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
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, getRequestControl, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString
public ExtendedOperation(org.forgerock.services.context.Context context, ExtendedRequest<?> extendedRequest)
context
- The request context with which this operation is associated.extendedRequest
- The extended request.public final String getRequestOID()
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 Dn getProxiedAuthorizationDN()
Operation
getProxiedAuthorizationDN
in class Operation
null
if proxied authorization has not been requested.public void setProxiedAuthorizationDN(Dn proxiedAuthorizationDN)
Operation
setProxiedAuthorizationDN
in class 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 ByteString getRequestValue()
getRequestValue
in interface PostOperationExtendedOperation
getRequestValue
in interface PostResponseExtendedOperation
getRequestValue
in interface PreOperationExtendedOperation
getRequestValue
in interface PreParseExtendedOperation
public final void setRequestValue(ByteString requestValue)
setRequestValue
in interface PreParseExtendedOperation
requestValue
- The value for the request associated with this extended operation.public final String getResponseOID()
getResponseOID
in interface PostOperationExtendedOperation
getResponseOID
in interface PostResponseExtendedOperation
public final void setResponseOID(String responseOID)
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 ByteString getResponseValue()
getResponseValue
in interface PostOperationExtendedOperation
getResponseValue
in interface PostResponseExtendedOperation
public final void setResponseValue(ByteString responseValue)
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()
PluginOperation
getOperationType
in interface PluginOperation
public final List<Control> getResponseControls()
PluginOperation
getResponseControls
in interface PluginOperation
public final void addResponseControl(Control control)
Operation
addResponseControl
in interface PostOperationOperation
addResponseControl
in interface PreOperationOperation
addResponseControl
in interface PreParseOperation
addResponseControl
in class Operation
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 PostOperationOperation
removeResponseControl
in interface PreOperationOperation
removeResponseControl
in interface PreParseOperation
removeResponseControl
in class Operation
control
- The control to remove from the set of controls to include in the response to the client.public final void run()
Operation
public final void toString(StringBuilder buffer)
Operation
toString
in interface PluginOperation
toString
in class Operation
buffer
- The buffer into which a string representation of this operation should be appended.Copyright 2010-2022 ForgeRock AS.