public class ModifyOperationBasis extends AbstractOperation implements ModifyOperation, PreParseModifyOperation, PostResponseModifyOperation
cancelRequest, cancelResult, clientConnection, messageID, NO_RESPONSE_CONTROLS, operationID
LOCALBACKENDOPERATIONS
Constructor and Description |
---|
ModifyOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
List<Control> requestControls,
org.forgerock.opendj.ldap.Dn entryDN,
List<Modification> modifications)
Creates a new modify operation with the provided information.
|
ModifyOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
org.forgerock.opendj.ldap.messages.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<org.forgerock.opendj.ldap.ByteString> |
getCurrentPasswords()
Retrieves the set of clear-text current passwords for the user,
if available.
|
org.forgerock.opendj.ldap.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.
|
org.forgerock.opendj.ldap.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(org.forgerock.opendj.ldap.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, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
abort, 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, toString
addAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, setErrorMessage
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 ModifyOperationBasis(ClientConnection clientConnection, long operationID, int messageID, org.forgerock.opendj.ldap.messages.ModifyRequest modifyRequest)
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.modifyRequest
- The modify request.public ModifyOperationBasis(ClientConnection clientConnection, long operationID, int messageID, List<Control> requestControls, org.forgerock.opendj.ldap.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()
ModifyOperation
getRawEntryDN
in interface ModifyOperation
getRawEntryDN
in interface PostResponseModifyOperation
getRawEntryDN
in interface PreParseModifyOperation
public final void setRawEntryDN(org.forgerock.opendj.ldap.ByteString rawEntryDN)
ModifyOperation
setRawEntryDN
in interface ModifyOperation
setRawEntryDN
in interface PreParseModifyOperation
rawEntryDN
- The raw, unprocessed entry DN as included in the client
request.public final org.forgerock.opendj.ldap.Dn getEntryDN()
ModifyOperation
getRawEntryDN
method.getEntryDN
in interface ModifyOperation
getEntryDN
in interface PostResponseModifyOperation
null
if the raw
entry DN has not yet been processed.public final List<RawModification> getRawModifications()
ModifyOperation
getRawModifications
in interface ModifyOperation
getRawModifications
in interface PostResponseModifyOperation
getRawModifications
in interface PreParseModifyOperation
public final void addRawModification(RawModification rawModification)
ModifyOperation
addRawModification
in interface ModifyOperation
addRawModification
in interface PreParseModifyOperation
rawModification
- The modification to add to the set of raw
modifications for this modify operation.public final void setRawModifications(List<RawModification> rawModifications)
ModifyOperation
setRawModifications
in interface ModifyOperation
setRawModifications
in interface PreParseModifyOperation
rawModifications
- The raw modifications for this modify operation.public final List<Modification> getModifications()
ModifyOperation
getModifications
in interface ModifyOperation
getModifications
in interface PostResponseModifyOperation
null
if the modifications have not yet been
processed.public final void addModification(Modification modification) throws DirectoryException
ModifyOperation
addModification
in interface ModifyOperation
modification
- 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()
Operation
getOperationType
in interface Operation
getOperationType
in interface PluginOperation
public org.forgerock.opendj.ldap.Dn getProxiedAuthorizationDN()
ModifyOperation
getProxiedAuthorizationDN
in interface ModifyOperation
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 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 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(org.forgerock.opendj.ldap.Dn proxiedAuthorizationDN)
ModifyOperation
setProxiedAuthorizationDN
in interface ModifyOperation
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 getCurrentEntry()
getCurrentEntry
in interface PostResponseModifyOperation
public List<org.forgerock.opendj.ldap.ByteString> getCurrentPasswords()
getCurrentPasswords
in interface PostResponseModifyOperation
null
if
there were none.public Entry getModifiedEntry()
getModifiedEntry
in interface PostResponseModifyOperation
public List<org.forgerock.opendj.ldap.ByteString> getNewPasswords()
getNewPasswords
in interface PostResponseModifyOperation
null
if there were none.Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.