public final class DeleteOperationBasis extends AbstractOperation implements DeleteOperation, PreParseDeleteOperation, PreOperationDeleteOperation, PostOperationDeleteOperation, PostResponseDeleteOperation, PostSynchronizationDeleteOperation
NO_RESPONSE_CONTROLS, requestContext
Constructor and Description |
---|
DeleteOperationBasis(org.forgerock.services.context.Context context,
DeleteRequest deleteRequest)
Creates a new delete 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.
|
Dn |
getEntryDN()
Retrieves the DN of the entry to delete.
|
Entry |
getEntryToDelete()
Retrieves the entry to be deleted.
|
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.
|
ByteString |
getRawEntryDN()
Retrieves the raw, unprocessed entry DN as included in the client request.
|
List<Control> |
getResponseControls()
Retrieves the set of controls 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 |
setRawEntryDN(ByteString rawEntryDN)
Specifies the raw, unprocessed entry DN as included in the client request.
|
void |
toString(StringBuilder buffer)
Appends a string representation of this operation to the provided buffer.
|
void |
updateOperationErrMsgAndResCode()
Updates the error message and the result code of the operation.
|
addAdditionalLogItem, addPostReadResponse, addPreReadResponse, addRequestControl, appendErrorMessage, appendMaskedErrorMessage, checkAttributeConformsToSyntax, checkIfBackendIsWritable, checkIfCanceled, disconnectClient, dontSynchronize, equals, evaluateProxyAuthControls, filterNonDisclosableMatchedDN, findMatchedDN, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getClientConnection, getConnectionID, getContext, getErrorMessage, getLocalBackend, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperationID, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControl, getRequestControls, getResultCode, hashCode, invokePostResponseCallbacks, isHumanReadable, isInnerOperation, isInternalOperation, isProxyAuthzControl, isSynchronizationOperation, mustCheckSchema, newDirectoryException, operationCompleted, processOperationResult, processOperationResult, registerPostResponseCallback, removeAllDisallowedControls, removeAttachment, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, setMatchedDN, setProcessingStartTime, setProcessingStopTime, setReferralURLs, setResponseData, setResult, setResultCode, setResultCodeAndMessageNoInfoDisclosure, setSynchronizationOperation, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
addAdditionalLogItem, addRequestControl, appendErrorMessage, appendMaskedErrorMessage, disconnectClient, dontSynchronize, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getClientConnection, getConnectionID, getContext, 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, setResult, 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
getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getProcessingStopTime, getProcessingTime, getReferralURLs, getResultCode
getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getProcessingStopTime, getProcessingTime, getReferralURLs, getResultCode
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getProcessingStartTime, getRequestControl, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString
public DeleteOperationBasis(org.forgerock.services.context.Context context, DeleteRequest deleteRequest)
context
- The context with which this operation is associated.deleteRequest
- The delete request.public final ByteString getRawEntryDN()
DeleteOperation
getRawEntryDN
in interface DeleteOperation
getRawEntryDN
in interface PostOperationDeleteOperation
getRawEntryDN
in interface PostResponseDeleteOperation
getRawEntryDN
in interface PostSynchronizationDeleteOperation
getRawEntryDN
in interface PreOperationDeleteOperation
getRawEntryDN
in interface PreParseDeleteOperation
public final void setRawEntryDN(ByteString rawEntryDN)
DeleteOperation
setEntryDN
method.setRawEntryDN
in interface DeleteOperation
setRawEntryDN
in interface PreParseDeleteOperation
rawEntryDN
- The raw, unprocessed entry DN as included in the client request.public final Dn getEntryDN()
DeleteOperation
getRawEntryDN
method.getEntryDN
in interface DeleteOperation
getEntryDN
in interface PostOperationDeleteOperation
getEntryDN
in interface PostResponseDeleteOperation
getEntryDN
in interface PostSynchronizationDeleteOperation
getEntryDN
in interface PreOperationDeleteOperation
null
if the raw entry DN has not yet been processed.public final OperationType getOperationType()
Operation
getOperationType
in interface Operation
getOperationType
in interface PluginOperation
public Dn getProxiedAuthorizationDN()
DeleteOperation
getProxiedAuthorizationDN
in interface DeleteOperation
getProxiedAuthorizationDN
in interface Operation
null
if proxied authorization has not been requested.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 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.public void setProxiedAuthorizationDN(Dn proxiedAuthorizationDN)
DeleteOperation
setProxiedAuthorizationDN
in interface DeleteOperation
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 void run()
Operation
public void updateOperationErrMsgAndResCode()
AbstractOperation
updateOperationErrMsgAndResCode
in class AbstractOperation
public Entry getEntryToDelete()
getEntryToDelete
in interface PostOperationDeleteOperation
getEntryToDelete
in interface PostResponseDeleteOperation
getEntryToDelete
in interface PostSynchronizationDeleteOperation
getEntryToDelete
in interface PreOperationDeleteOperation
null
if the entry is not yet available.Copyright 2010-2020 ForgeRock AS.