public class ModifyDNOperationBasis extends AbstractOperation implements ModifyDNOperation, PreParseModifyDNOperation, PostResponseModifyDNOperation
cancelRequest, cancelResult, clientConnection, messageID, NO_RESPONSE_CONTROLS, operationIDLOCALBACKENDOPERATIONS| Constructor and Description |
|---|
ModifyDNOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
List<Control> requestControls,
org.forgerock.opendj.ldap.ByteString rawEntryDN,
org.forgerock.opendj.ldap.ByteString rawNewRDN,
boolean deleteOldRDN,
org.forgerock.opendj.ldap.ByteString rawNewSuperior)
Creates a new modify DN operation with the provided information.
|
ModifyDNOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
List<Control> requestControls,
DN entryDN,
RDN newRDN,
boolean deleteOldRDN,
DN newSuperior)
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.
|
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(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.
|
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, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, setErrorMessage, setMatchedDN, setReferralURLs, setResponseData, setResultCodecheckIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getProcessingStartTime, getRequestControl, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toStringaddAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, setErrorMessagegetAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getProcessingStopTime, getProcessingTime, getReferralURLs, getResultCodepublic ModifyDNOperationBasis(ClientConnection clientConnection, long operationID, int messageID, List<Control> requestControls, org.forgerock.opendj.ldap.ByteString rawEntryDN, org.forgerock.opendj.ldap.ByteString rawNewRDN, boolean deleteOldRDN, org.forgerock.opendj.ldap.ByteString rawNewSuperior)
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 entry DN as included in the
client request.rawNewRDN - The raw, unprocessed newRDN as included in the
client request.deleteOldRDN - Indicates whether to delete the old RDN value
from the entry.rawNewSuperior - The raw, unprocessed newSuperior as included in
the client request.public ModifyDNOperationBasis(ClientConnection clientConnection, long operationID, int messageID, List<Control> requestControls, DN entryDN, RDN newRDN, boolean deleteOldRDN, DN newSuperior)
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 current entry DN for this modify DN
operation.newRDN - The new RDN for this modify DN operation.deleteOldRDN - Indicates whether to delete the old RDN value
from the entry.newSuperior - The newSuperior DN for this modify DN operation.public final org.forgerock.opendj.ldap.ByteString getRawEntryDN()
getRawEntryDN in interface ModifyDNOperationgetRawEntryDN in interface PostResponseModifyDNOperationgetRawEntryDN in interface PreParseModifyDNOperationgetRawEntryDN in interface SubordinateModifyDNOperationpublic final void setRawEntryDN(org.forgerock.opendj.ldap.ByteString rawEntryDN)
setRawEntryDN in interface ModifyDNOperationsetRawEntryDN in interface PreParseModifyDNOperationrawEntryDN - The raw, unprocessed entry DN as included in the client
request.public final DN getEntryDN()
getRawEntryDN method.getEntryDN in interface ModifyDNOperationgetEntryDN in interface PostResponseModifyDNOperationgetEntryDN in interface SubordinateModifyDNOperationnull if the raw
entry DN has not yet been processed.public final org.forgerock.opendj.ldap.ByteString getRawNewRDN()
getRawNewRDN in interface ModifyDNOperationgetRawNewRDN in interface PostResponseModifyDNOperationgetRawNewRDN in interface PreParseModifyDNOperationgetRawNewRDN in interface SubordinateModifyDNOperationpublic final void setRawNewRDN(org.forgerock.opendj.ldap.ByteString rawNewRDN)
setRawNewRDN in interface ModifyDNOperationsetRawNewRDN in interface PreParseModifyDNOperationrawNewRDN - The raw, unprocessed newRDN as included in the request
from the client.public final RDN getNewRDN()
getRawNewRDN method.getNewRDN in interface ModifyDNOperationgetNewRDN in interface PostResponseModifyDNOperationgetNewRDN in interface SubordinateModifyDNOperationnull if the raw
newRDN has not yet been processed.public final boolean deleteOldRDN()
deleteOldRDN in interface ModifyDNOperationdeleteOldRDN in interface PostResponseModifyDNOperationdeleteOldRDN in interface PreParseModifyDNOperationdeleteOldRDN in interface SubordinateModifyDNOperationtrue if the current RDN value should be removed from
the entry, or false if not.public final void setDeleteOldRDN(boolean deleteOldRDN)
setDeleteOldRDN in interface ModifyDNOperationsetDeleteOldRDN in interface PreParseModifyDNOperationdeleteOldRDN - Specifies whether the current RDN value should be
removed from the entry.public final org.forgerock.opendj.ldap.ByteString getRawNewSuperior()
getRawNewSuperior in interface ModifyDNOperationgetRawNewSuperior in interface PostResponseModifyDNOperationgetRawNewSuperior in interface PreParseModifyDNOperationgetRawNewSuperior in interface SubordinateModifyDNOperationnull if there is none.public final void setRawNewSuperior(org.forgerock.opendj.ldap.ByteString rawNewSuperior)
setRawNewSuperior in interface ModifyDNOperationsetRawNewSuperior in interface PreParseModifyDNOperationrawNewSuperior - The raw, unprocessed newSuperior as provided in the
request from the client.public final DN getNewSuperior()
getRawNewSuperior
method.getNewSuperior in interface ModifyDNOperationgetNewSuperior in interface PostResponseModifyDNOperationgetNewSuperior in interface SubordinateModifyDNOperationnull if there is
no newSuperior DN for this request or if the raw newSuperior has
not yet been processed.public final List<Modification> getModifications()
getModifications in interface ModifyDNOperationgetModifications in interface PostResponseModifyDNOperationnull if that
information is not yet available (e.g., during pre-parse plugins).public final void addModification(Modification modification)
addModification in interface ModifyDNOperationmodification - The modification to add to the set of modifications
to apply to the entry.public final Entry getOriginalEntry()
getOriginalEntry in interface ModifyDNOperationgetOriginalEntry in interface PostResponseModifyDNOperationgetOriginalEntry in interface SubordinateModifyDNOperationnull if it is not yet
available.public final Entry getUpdatedEntry()
getUpdatedEntry in interface ModifyDNOperationgetUpdatedEntry in interface PostResponseModifyDNOperationgetUpdatedEntry in interface SubordinateModifyDNOperationnull if it is not yet
available.public final OperationType getOperationType()
getOperationType in interface OperationgetOperationType in interface PluginOperationpublic DN getProxiedAuthorizationDN()
getProxiedAuthorizationDN in interface ModifyDNOperationgetProxiedAuthorizationDN 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 InProgressOperationaddResponseControl 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 InProgressOperationremoveResponseControl in interface PreParseOperationcontrol - The control to remove from the set of controls
to include in the response to the client.public final void run()
public void updateOperationErrMsgAndResCode()
updateOperationErrMsgAndResCode in class AbstractOperationpublic 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 dn)
setProxiedAuthorizationDN in interface ModifyDNOperationsetProxiedAuthorizationDN in interface Operationdn - 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()
getNewDN in interface ModifyDNOperationnull if there is
neither newRDN, nor entryDN for this request.Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.