public final class ModifyOperation extends Operation implements PreOperationModifyOperation, PreParseModifyOperation, PostOperationModifyOperation, PostResponseModifyOperation, PostSynchronizationModifyOperation
NO_RESPONSE_CONTROLS, requestContext
Constructor and Description |
---|
ModifyOperation(org.forgerock.services.context.Context context,
ModifyRequest modifyRequest)
Creates a new modify operation with the provided information.
|
Modifier and Type | Method and Description |
---|---|
void |
addModification(Modification modification)
Adds the provided modification to the set of modifications to this modify operation.
|
void |
addRawModification(RawModification rawModification)
Adds the provided modification to the set of raw modifications for this modify operation.
|
void |
addResponseControl(Control control)
Adds the provided control to the set of controls to include in the response to the client.
|
Entry |
getCurrentEntry()
Retrieves the current entry before any modifications are applied.
|
List<ByteString> |
getCurrentPasswords()
Retrieves the set of clear-text current passwords for the user, if available.
|
Dn |
getEntryDN()
Retrieves the DN of the entry to modify.
|
List<Modification> |
getModifications()
Retrieves the set of modifications for this modify operation.
|
Entry |
getModifiedEntry()
Retrieves the modified entry that is to be written to the backend.
|
List<ByteString> |
getNewPasswords()
Retrieves the set of clear-text new passwords for the user, if available.
|
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<RawModification> |
getRawModifications()
Retrieves the set of raw, unprocessed modifications 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 |
setRawModifications(List<RawModification> rawModifications)
Specifies the raw modifications for this modify operation.
|
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, 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, 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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
addAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, setErrorMessage
addAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, 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 ModifyOperation(org.forgerock.services.context.Context context, ModifyRequest modifyRequest)
context
- The context with which this operation is associated.modifyRequest
- The modify request.public ByteString getRawEntryDN()
getRawEntryDN
in interface PostOperationModifyOperation
getRawEntryDN
in interface PostResponseModifyOperation
getRawEntryDN
in interface PostSynchronizationModifyOperation
getRawEntryDN
in interface PreOperationModifyOperation
getRawEntryDN
in interface PreParseModifyOperation
public void setRawEntryDN(ByteString rawEntryDN)
setRawEntryDN
in interface PreParseModifyOperation
rawEntryDN
- The raw, unprocessed entry DN as included in the client request.public Dn getEntryDN()
getRawEntryDN()
method.getEntryDN
in interface PostOperationModifyOperation
getEntryDN
in interface PostResponseModifyOperation
getEntryDN
in interface PostSynchronizationModifyOperation
getEntryDN
in interface PreOperationModifyOperation
null
if the raw entry DN has not yet been processed.public List<RawModification> getRawModifications()
getRawModifications
in interface PostOperationModifyOperation
getRawModifications
in interface PostResponseModifyOperation
getRawModifications
in interface PostSynchronizationModifyOperation
getRawModifications
in interface PreOperationModifyOperation
getRawModifications
in interface PreParseModifyOperation
public void addRawModification(RawModification rawModification)
addRawModification
in interface PreParseModifyOperation
rawModification
- The modification to add to the set of raw modifications for this modify operation.public void setRawModifications(List<RawModification> rawModifications)
setRawModifications
in interface PreParseModifyOperation
rawModifications
- The raw modifications for this modify operation.public List<Modification> getModifications()
getModifications
in interface PostOperationModifyOperation
getModifications
in interface PostResponseModifyOperation
getModifications
in interface PostSynchronizationModifyOperation
getModifications
in interface PreOperationModifyOperation
null
if the modifications have not yet
been processed.public void addModification(Modification modification) throws LdapException
addModification
in interface PreOperationModifyOperation
modification
- The modification to add to the set of changes for this modify operation.LdapException
- If an unexpected problem occurs while applying the modification to the entry.public OperationType getOperationType()
PluginOperation
getOperationType
in interface PluginOperation
public Dn getProxiedAuthorizationDN()
Operation
getProxiedAuthorizationDN
in class Operation
null
if proxied authorization has not been requested.public List<Control> getResponseControls()
PluginOperation
getResponseControls
in interface PluginOperation
public 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 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 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.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 void run()
Operation
public void updateOperationErrMsgAndResCode()
Operation
updateOperationErrMsgAndResCode
in class Operation
public Entry getCurrentEntry()
getCurrentEntry
in interface PostOperationModifyOperation
getCurrentEntry
in interface PostResponseModifyOperation
getCurrentEntry
in interface PostSynchronizationModifyOperation
getCurrentEntry
in interface PreOperationModifyOperation
null
if it is not yet available.public List<ByteString> getCurrentPasswords()
getCurrentPasswords
in interface PostOperationModifyOperation
getCurrentPasswords
in interface PostResponseModifyOperation
getCurrentPasswords
in interface PostSynchronizationModifyOperation
getCurrentPasswords
in interface PreOperationModifyOperation
null
if there
were none or this information is not yet available.public Entry getModifiedEntry()
getModifiedEntry
in interface PostOperationModifyOperation
getModifiedEntry
in interface PostResponseModifyOperation
getModifiedEntry
in interface PostSynchronizationModifyOperation
getModifiedEntry
in interface PreOperationModifyOperation
null
if it is not yet available.public List<ByteString> getNewPasswords()
getNewPasswords
in interface PostOperationModifyOperation
getNewPasswords
in interface PostResponseModifyOperation
getNewPasswords
in interface PostSynchronizationModifyOperation
getNewPasswords
in interface PreOperationModifyOperation
null
if there were none
or this information is not yet available.Copyright 2010-2018 ForgeRock AS.