public class ModifyOperationBasis extends AbstractOperation implements ModifyOperation, PreParseModifyOperation, PostResponseModifyOperation
cancelRequest, cancelResult, clientConnection, messageID, NO_RESPONSE_CONTROLS, operationIDLOCALBACKENDOPERATIONS| Constructor and Description |
|---|
ModifyOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
List<Control> requestControls,
org.forgerock.opendj.ldap.ByteString rawEntryDN,
List<RawModification> rawModifications)
Creates a new modify operation with the provided information.
|
ModifyOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
List<Control> requestControls,
DN entryDN,
List<Modification> modifications)
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<org.forgerock.opendj.ldap.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<org.forgerock.opendj.ldap.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.
|
org.forgerock.opendj.ldap.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(org.forgerock.opendj.ldap.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.
|
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, toStringclone, 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, setErrorMessagegetAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getProcessingStopTime, getProcessingTime, getReferralURLs, getResultCodecheckIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getProcessingStartTime, getRequestControl, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toStringpublic ModifyOperationBasis(ClientConnection clientConnection, long operationID, int messageID, List<Control> requestControls, org.forgerock.opendj.ldap.ByteString rawEntryDN, List<RawModification> rawModifications)
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.rawEntryDN - The raw, unprocessed DN of the entry to modify,
as included in the client request.rawModifications - The raw, unprocessed set of modifications for
this modify operation as included in the client
request.public ModifyOperationBasis(ClientConnection clientConnection, long operationID, int messageID, List<Control> requestControls, DN entryDN, List<Modification> modifications)
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.entryDN - The entry DN for the modify operation.modifications - The set of modifications for this modify
operation.public final org.forgerock.opendj.ldap.ByteString getRawEntryDN()
getRawEntryDN in interface ModifyOperationgetRawEntryDN in interface PostResponseModifyOperationgetRawEntryDN in interface PreParseModifyOperationpublic final void setRawEntryDN(org.forgerock.opendj.ldap.ByteString rawEntryDN)
setRawEntryDN in interface ModifyOperationsetRawEntryDN in interface PreParseModifyOperationrawEntryDN - The raw, unprocessed entry DN as included in the client
request.public final DN getEntryDN()
getRawEntryDN method.getEntryDN in interface ModifyOperationgetEntryDN in interface PostResponseModifyOperationnull if the raw
entry DN has not yet been processed.public final List<RawModification> getRawModifications()
getRawModifications in interface ModifyOperationgetRawModifications in interface PostResponseModifyOperationgetRawModifications in interface PreParseModifyOperationpublic final void addRawModification(RawModification rawModification)
addRawModification in interface ModifyOperationaddRawModification in interface PreParseModifyOperationrawModification - The modification to add to the set of raw
modifications for this modify operation.public final void setRawModifications(List<RawModification> rawModifications)
setRawModifications in interface ModifyOperationsetRawModifications in interface PreParseModifyOperationrawModifications - The raw modifications for this modify operation.public final List<Modification> getModifications()
getModifications in interface ModifyOperationgetModifications in interface PostResponseModifyOperationnull if the modifications have not yet been
processed.public final void addModification(Modification modification) throws DirectoryException
addModification in interface ModifyOperationmodification - The modification to add to the set of changes for
this modify operation.DirectoryException - If an unexpected problem occurs while applying
the modification to the entry.public final OperationType getOperationType()
getOperationType in interface OperationgetOperationType in interface PluginOperationpublic DN getProxiedAuthorizationDN()
getProxiedAuthorizationDN in interface ModifyOperationgetProxiedAuthorizationDN in interface Operationnull if proxied
authorization has not been requested.public final List<Control> getResponseControls()
getResponseControls in interface OperationgetResponseControls in interface PluginOperationpublic final void addResponseControl(Control control)
addResponseControl in interface OperationaddResponseControl 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 PreParseOperationcontrol - The control to remove from the set of controls
to include in the response to the client.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.public void setProxiedAuthorizationDN(DN proxiedAuthorizationDN)
setProxiedAuthorizationDN in interface ModifyOperationsetProxiedAuthorizationDN 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 void run()
public void updateOperationErrMsgAndResCode()
updateOperationErrMsgAndResCode in class AbstractOperationpublic Entry getCurrentEntry()
getCurrentEntry in interface PostResponseModifyOperationpublic List<org.forgerock.opendj.ldap.ByteString> getCurrentPasswords()
getCurrentPasswords in interface PostResponseModifyOperationnull if
there were none.public Entry getModifiedEntry()
getModifiedEntry in interface PostResponseModifyOperationpublic List<org.forgerock.opendj.ldap.ByteString> getNewPasswords()
getNewPasswords in interface PostResponseModifyOperationnull if there were none.Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.