public final class ModifyDNOperationBasis extends AbstractOperation implements ModifyDNOperation, PreOperationModifyDNOperation, PreParseModifyDNOperation, PostOperationModifyDNOperation, PostResponseModifyDNOperation, PostSynchronizationModifyDNOperation
NO_RESPONSE_CONTROLS, requestContext
Constructor and Description |
---|
ModifyDNOperationBasis(org.forgerock.services.context.Context context,
org.forgerock.opendj.ldap.messages.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.
|
org.forgerock.opendj.ldap.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.
|
org.forgerock.opendj.ldap.Dn |
getNewDN()
Retrieves the new DN for the entry.
|
org.forgerock.opendj.ldap.Rdn |
getNewRDN()
Retrieves the new RDN to use for the entry.
|
org.forgerock.opendj.ldap.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.
|
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.
|
org.forgerock.opendj.ldap.ByteString |
getRawNewRDN()
Retrieves the raw, unprocessed newRDN as included in the request from the client.
|
org.forgerock.opendj.ldap.ByteString |
getRawNewSuperior()
Retrieves the raw, unprocessed newSuperior from the client request.
|
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 |
setProxiedAuthorizationDN(org.forgerock.opendj.ldap.Dn dn)
Sets 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 |
setRawNewRDN(org.forgerock.opendj.ldap.ByteString rawNewRDN)
Specifies the raw, unprocessed newRDN as included in the request from the client.
|
void |
setRawNewSuperior(org.forgerock.opendj.ldap.ByteString rawNewSuperior)
Specifies the raw, unprocessed newSuperior for this modify DN operation, as provided in the request from the
client.
|
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, 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, isInnerOperation, isInternalOperation, isProxyAuthzControl, isSynchronizationOperation, 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, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, setErrorMessage, setMatchedDN, setReferralURLs, setResponseData, setResultCode
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getProcessingStartTime, getRequestControl, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString
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
public ModifyDNOperationBasis(org.forgerock.services.context.Context context, org.forgerock.opendj.ldap.messages.ModifyDnRequest modifyDNRequest)
context
- The context with which this operation is associated.modifyDNRequest
- The modifyDN request.public final org.forgerock.opendj.ldap.ByteString getRawEntryDN()
ModifyDNOperation
getRawEntryDN
in interface ModifyDNOperation
getRawEntryDN
in interface PostOperationModifyDNOperation
getRawEntryDN
in interface PostResponseModifyDNOperation
getRawEntryDN
in interface PostSynchronizationModifyDNOperation
getRawEntryDN
in interface PreOperationModifyDNOperation
getRawEntryDN
in interface PreParseModifyDNOperation
getRawEntryDN
in interface SubordinateModifyDNOperation
public final void setRawEntryDN(org.forgerock.opendj.ldap.ByteString rawEntryDN)
ModifyDNOperation
setRawEntryDN
in interface ModifyDNOperation
setRawEntryDN
in interface PreParseModifyDNOperation
rawEntryDN
- The raw, unprocessed entry DN as included in the client request.public final org.forgerock.opendj.ldap.Dn getEntryDN()
ModifyDNOperation
getRawEntryDN
method.getEntryDN
in interface ModifyDNOperation
getEntryDN
in interface PostOperationModifyDNOperation
getEntryDN
in interface PostResponseModifyDNOperation
getEntryDN
in interface PostSynchronizationModifyDNOperation
getEntryDN
in interface PreOperationModifyDNOperation
getEntryDN
in interface SubordinateModifyDNOperation
null
if the raw entry DN has not yet been processed.public final org.forgerock.opendj.ldap.ByteString getRawNewRDN()
ModifyDNOperation
getRawNewRDN
in interface ModifyDNOperation
getRawNewRDN
in interface PostOperationModifyDNOperation
getRawNewRDN
in interface PostResponseModifyDNOperation
getRawNewRDN
in interface PostSynchronizationModifyDNOperation
getRawNewRDN
in interface PreOperationModifyDNOperation
getRawNewRDN
in interface PreParseModifyDNOperation
getRawNewRDN
in interface SubordinateModifyDNOperation
public final void setRawNewRDN(org.forgerock.opendj.ldap.ByteString rawNewRDN)
ModifyDNOperation
setRawNewRDN
in interface ModifyDNOperation
setRawNewRDN
in interface PreParseModifyDNOperation
rawNewRDN
- The raw, unprocessed newRDN as included in the request from the client.public final org.forgerock.opendj.ldap.Rdn getNewRDN()
ModifyDNOperation
getRawNewRDN
method.getNewRDN
in interface ModifyDNOperation
getNewRDN
in interface PostOperationModifyDNOperation
getNewRDN
in interface PostResponseModifyDNOperation
getNewRDN
in interface PostSynchronizationModifyDNOperation
getNewRDN
in interface PreOperationModifyDNOperation
getNewRDN
in interface SubordinateModifyDNOperation
null
if the raw newRDN has not yet been processed.public final boolean deleteOldRDN()
ModifyDNOperation
deleteOldRDN
in interface ModifyDNOperation
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 final void setDeleteOldRDN(boolean deleteOldRDN)
ModifyDNOperation
setDeleteOldRDN
in interface ModifyDNOperation
setDeleteOldRDN
in interface PreParseModifyDNOperation
deleteOldRDN
- Specifies whether the current RDN value should be removed from the entry.public final org.forgerock.opendj.ldap.ByteString getRawNewSuperior()
ModifyDNOperation
getRawNewSuperior
in interface ModifyDNOperation
getRawNewSuperior
in interface PostOperationModifyDNOperation
getRawNewSuperior
in interface PostResponseModifyDNOperation
getRawNewSuperior
in interface PostSynchronizationModifyDNOperation
getRawNewSuperior
in interface PreOperationModifyDNOperation
getRawNewSuperior
in interface PreParseModifyDNOperation
getRawNewSuperior
in interface SubordinateModifyDNOperation
null
if there is none.public final void setRawNewSuperior(org.forgerock.opendj.ldap.ByteString rawNewSuperior)
ModifyDNOperation
setRawNewSuperior
in interface ModifyDNOperation
setRawNewSuperior
in interface PreParseModifyDNOperation
rawNewSuperior
- The raw, unprocessed newSuperior as provided in the request from the client.public final org.forgerock.opendj.ldap.Dn getNewSuperior()
ModifyDNOperation
getRawNewSuperior
method.getNewSuperior
in interface ModifyDNOperation
getNewSuperior
in interface PostOperationModifyDNOperation
getNewSuperior
in interface PostResponseModifyDNOperation
getNewSuperior
in interface PostSynchronizationModifyDNOperation
getNewSuperior
in interface PreOperationModifyDNOperation
getNewSuperior
in interface SubordinateModifyDNOperation
null
if there is no newSuperior DN for this request or
if the raw newSuperior has not yet been processed.public final List<Modification> getModifications()
ModifyDNOperation
getModifications
in interface ModifyDNOperation
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 final void addModification(Modification modification)
ModifyDNOperation
addModification
in interface ModifyDNOperation
addModification
in interface PreOperationModifyDNOperation
modification
- The modification to add to the set of modifications to apply to the entry.public final OperationType getOperationType()
Operation
getOperationType
in interface Operation
getOperationType
in interface PluginOperation
public org.forgerock.opendj.ldap.Dn getProxiedAuthorizationDN()
ModifyDNOperation
getProxiedAuthorizationDN
in interface ModifyDNOperation
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 InProgressOperation
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 InProgressOperation
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 run()
Operation
public void updateOperationErrMsgAndResCode()
AbstractOperation
updateOperationErrMsgAndResCode
in class AbstractOperation
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 dn)
ModifyDNOperation
setProxiedAuthorizationDN
in interface ModifyDNOperation
setProxiedAuthorizationDN
in interface 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 org.forgerock.opendj.ldap.Dn getNewDN()
ModifyDNOperation
getNewDN
in interface ModifyDNOperation
null
if there is neither newRDN, nor entryDN for this request.public final Entry getOriginalEntry()
getOriginalEntry
in interface ModifyDNOperation
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 final Entry getUpdatedEntry()
getUpdatedEntry
in interface ModifyDNOperation
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–2017 ForgeRock AS. All rights reserved.