public final class ModifyDnOperation extends Operation implements SubordinateModifyDNOperation, PreOperationModifyDNOperation, PreParseModifyDNOperation, PostOperationModifyDNOperation, PostResponseModifyDNOperation, PostSynchronizationModifyDNOperation
NO_RESPONSE_CONTROLS, requestContext
Constructor and Description |
---|
ModifyDnOperation(org.forgerock.services.context.Context context,
ModifyDnRequest modifyDNRequest)
Creates a new modify DN 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 be applied as part of the update.
|
void |
addResponseControl(Control control)
Adds the provided control to the set of controls to include in the response to the client.
|
boolean |
deleteOldRDN()
Indicates whether the current RDN value should be removed from the entry.
|
Dn |
getEntryDN()
Retrieves the DN of the entry to rename.
|
List<Modification> |
getModifications()
Retrieves the set of modifications applied to attributes of the target entry in the course of processing this
modify DN operation.
|
Dn |
getNewDN()
Retrieves the new DN for the entry.
|
Rdn |
getNewRDN()
Retrieves the new RDN to use for the entry.
|
Dn |
getNewSuperior()
Retrieves the newSuperior DN for the entry.
|
OperationType |
getOperationType()
Retrieves the operation type for this operation.
|
Entry |
getOriginalEntry()
Retrieves the current entry, before it is renamed.
|
Dn |
getProxiedAuthorizationDN()
Retrieves the proxied authorization DN for this operation if proxied authorization has been requested.
|
List<Control> |
getResponseControls()
Retrieves the set of controls to include in the response to the client.
|
Entry |
getUpdatedEntry()
Retrieves the new entry, as it will appear after it is renamed.
|
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 |
setDeleteOldRDN(boolean deleteOldRDN)
Specifies whether the current RDN value should be removed from the entry.
|
void |
setEntryDN(Dn entryDN)
Specifies the entry DN as included in the client request.
|
void |
setNewRDN(Rdn newRDN)
Specifies the newRDN as included in the request from the client.
|
void |
setNewSuperior(Dn newSuperior)
Specifies the newSuperior for this modify DN operation, as provided in the request from the client.
|
void |
setProxiedAuthorizationDN(Dn dn)
Set the proxied authorization DN for this operation if proxied authorization has been requested.
|
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, 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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
addAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, setErrorMessage, setMatchedDN, setReferralURLs, setResponseData, setResultCode
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, getRequestControl, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString
public ModifyDnOperation(org.forgerock.services.context.Context context, ModifyDnRequest modifyDNRequest)
context
- The context with which this operation is associated.modifyDNRequest
- The modifyDN request.public void setEntryDN(Dn entryDN)
PreParseModifyDNOperation
setEntryDN
in interface PreParseModifyDNOperation
entryDN
- The entry DN as included in the client request.public Dn getEntryDN()
SubordinateModifyDNOperation
getEntryDN
in interface PostOperationModifyDNOperation
getEntryDN
in interface PostResponseModifyDNOperation
getEntryDN
in interface PostSynchronizationModifyDNOperation
getEntryDN
in interface PreOperationModifyDNOperation
getEntryDN
in interface PreParseModifyDNOperation
getEntryDN
in interface SubordinateModifyDNOperation
public void setNewRDN(Rdn newRDN)
setNewRDN
in interface PreParseModifyDNOperation
newRDN
- The newRDN as included in the request from the client.public Rdn getNewRDN()
SubordinateModifyDNOperation
getNewRDN
in interface PostOperationModifyDNOperation
getNewRDN
in interface PostResponseModifyDNOperation
getNewRDN
in interface PostSynchronizationModifyDNOperation
getNewRDN
in interface PreOperationModifyDNOperation
getNewRDN
in interface PreParseModifyDNOperation
getNewRDN
in interface SubordinateModifyDNOperation
public boolean deleteOldRDN()
SubordinateModifyDNOperation
deleteOldRDN
in interface PostOperationModifyDNOperation
deleteOldRDN
in interface PostResponseModifyDNOperation
deleteOldRDN
in interface PostSynchronizationModifyDNOperation
deleteOldRDN
in interface PreOperationModifyDNOperation
deleteOldRDN
in interface PreParseModifyDNOperation
deleteOldRDN
in interface SubordinateModifyDNOperation
true
if the current RDN value should be removed from the entry, or false
if not.public void setDeleteOldRDN(boolean deleteOldRDN)
setDeleteOldRDN
in interface PreParseModifyDNOperation
deleteOldRDN
- Specifies whether the current RDN value should be removed from the entry.public void setNewSuperior(Dn newSuperior)
setNewSuperior
in interface PreParseModifyDNOperation
newSuperior
- The newSuperior as provided in the request from the client.public Dn getNewSuperior()
SubordinateModifyDNOperation
getNewSuperior
in interface PostOperationModifyDNOperation
getNewSuperior
in interface PostResponseModifyDNOperation
getNewSuperior
in interface PostSynchronizationModifyDNOperation
getNewSuperior
in interface PreOperationModifyDNOperation
getNewSuperior
in interface PreParseModifyDNOperation
getNewSuperior
in interface SubordinateModifyDNOperation
null
if there is no newSuperior DN for this request.public List<Modification> getModifications()
getModifications
in interface PostOperationModifyDNOperation
getModifications
in interface PostResponseModifyDNOperation
getModifications
in interface PostSynchronizationModifyDNOperation
getModifications
in interface PreOperationModifyDNOperation
null
if that information is not yet available (e.g., during pre-parse plugins).public void addModification(Modification modification)
addModification
in interface PreOperationModifyDNOperation
modification
- The modification to add to the set of modifications to apply 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 InProgressOperation
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 InProgressOperation
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 run()
Operation
public void updateOperationErrMsgAndResCode()
Operation
updateOperationErrMsgAndResCode
in class Operation
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 dn)
Operation
setProxiedAuthorizationDN
in class Operation
dn
- The proxied authorization DN for this operation if proxied authorization has been requested, or
null
if proxied authorization has not been requested.public Dn getNewDN()
null
if there is neither newRDN, nor entryDN for this request.public Entry getOriginalEntry()
getOriginalEntry
in interface PostOperationModifyDNOperation
getOriginalEntry
in interface PostResponseModifyDNOperation
getOriginalEntry
in interface PostSynchronizationModifyDNOperation
getOriginalEntry
in interface PreOperationModifyDNOperation
getOriginalEntry
in interface SubordinateModifyDNOperation
null
if it is not yet available.public Entry getUpdatedEntry()
getUpdatedEntry
in interface PostOperationModifyDNOperation
getUpdatedEntry
in interface PostResponseModifyDNOperation
getUpdatedEntry
in interface PostSynchronizationModifyDNOperation
getUpdatedEntry
in interface PreOperationModifyDNOperation
getUpdatedEntry
in interface SubordinateModifyDNOperation
null
if it is not yet available.Copyright 2010-2022 ForgeRock AS.