Package org.opends.server.core

Class ModifyDnOperation

java.lang.Object

org.opends.server.types.Operation

org.opends.server.core.ModifyDnOperation

All Implemented Interfaces:

InProgressOperation, PluginOperation, PostCommitModifyDNOperation, PostCommitOperation, PostOperationModifyDNOperation, PostOperationOperation, PostResponseModifyDNOperation, PostResponseOperation, PostSynchronizationModifyDNOperation, PostSynchronizationOperation, PreOperationModifyDNOperation, PreOperationOperation, PreParseModifyDNOperation, PreParseOperation, SubordinateModifyDNOperation

public final class ModifyDnOperation
extends Operation
implements SubordinateModifyDNOperation, PreOperationModifyDNOperation, PreParseModifyDNOperation, PostOperationModifyDNOperation, PostResponseModifyDNOperation, PostCommitModifyDNOperation, PostSynchronizationModifyDNOperation

This class defines an operation used to move an entry (alter the DN of an entry) in the Directory Server.

Field Summary

Fields inherited from class org.opends.server.types.Operation

backend, context, out, pluginConfigManager, request, serverContext

Constructor Summary

Constructors

Constructor	Description
ModifyDnOperation(RequestContext context, LocalBackend<?> backend, ModifyDnRequest request, Consumer<ResponseStream> out)	Creates a new modify DN operation.

Method Summary

Modifier and Type	Method	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.
Rdn	getNewRDN()	Retrieves the new RDN to use for the entry.
Dn	getNewSuperior()	Retrieves the newSuperior DN for the entry.
Entry	getOriginalEntry()	Retrieves the current entry, before it is renamed.
ModifyDnRequest	getRequest()	Returns the request associated to this operation.
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.
protected void	invokePostResponsePlugins()	Invokes any applicable post-response plugins.
protected boolean	invokePreParsePlugins()	Invokes any applicable pre-parse plugins.
void	removeResponseControl(Control control)	Removes the provided control from the set of controls to include in the response to the client.
protected boolean	runImpl()	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	toString(StringBuilder buffer)	Appends a string representation of this operation to the provided buffer.

Methods inherited from class org.opends.server.types.Operation

addAdditionalLogItem, addPasswordPolicyWarningToLog, addPostReadResponse, addPreReadResponse, addRequestControl, appendErrorMessage, appendMaskedErrorMessage, checkAttributeConformsToSyntax, checkIfBackendIsWritable, checkIfCanceled, createLdapException, equals, evaluateProxyAuthControls, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getClientConnection, getConnectionID, getErrorMessage, getLargestEntrySize, getMatchedDN, getMessageID, getOperationID, getProxiedAuthorizationDN, getReferralURLs, getRequestContext, getRequestControl, getRequestControls, getResultCode, hashCode, hasPrivilege, hasRequestControl, isInternalOperation, isProxyAuthzControl, isSynchronizationOperation, mustCheckSchema, operationToResult, processOperationResult, removeAllDisallowedControls, run, sendResponses, sendResult, setAttachment, setErrorMessage, setMatchedDN, setReferralURLs, setResult, setResult, setResultCode, setResultCodeAndMessageNoInfoDisclosure, toString, trySetLargestEntrySize

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opends.server.types.operation.InProgressOperation

addAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, setErrorMessage, setMatchedDN, setReferralURLs, setResult, setResultCode

Methods inherited from interface org.opends.server.types.operation.PluginOperation

checkIfCanceled, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getRequestControl, getRequestControl, getRequestControls, hasPrivilege, isInternalOperation, isSynchronizationOperation, setAttachment, toString

Methods inherited from interface org.opends.server.types.operation.PostCommitOperation

getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode

Methods inherited from interface org.opends.server.types.operation.PostOperationOperation

addAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, setErrorMessage, setMatchedDN, setReferralURLs, setResult, setResultCode

Methods inherited from interface org.opends.server.types.operation.PostResponseOperation

getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode

Methods inherited from interface org.opends.server.types.operation.PostSynchronizationOperation

getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode

Methods inherited from interface org.opends.server.types.operation.PreOperationOperation

addAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, sendResponses, setErrorMessage

Methods inherited from interface org.opends.server.types.operation.PreParseOperation

addAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, sendResponses, setErrorMessage

Constructor Details

ModifyDnOperation

public ModifyDnOperation(RequestContext context,
 LocalBackend<?> backend,
 ModifyDnRequest request,
 Consumer<ResponseStream> out)

Creates a new modify DN operation.

Parameters:

context - The context.

backend - The local backend in which this request is to be processed.

request - The request.

out - A consumer responsible for sending responses to the client.

Method Details

setEntryDN

public void setEntryDN(Dn entryDN)

Description copied from interface: PreParseModifyDNOperation

Specifies the entry DN as included in the client request. This should only be called by pre-parse plugins.

Specified by:

setEntryDN in interface PreParseModifyDNOperation

Parameters:

entryDN - The entry DN as included in the client request.

getEntryDN

public Dn getEntryDN()

Description copied from interface: SubordinateModifyDNOperation

Retrieves the DN of the entry to rename.

Specified by:

getEntryDN in interface PostCommitModifyDNOperation

Specified by:

getEntryDN in interface PostOperationModifyDNOperation

Specified by:

getEntryDN in interface PostResponseModifyDNOperation

Specified by:

getEntryDN in interface PostSynchronizationModifyDNOperation

Specified by:

getEntryDN in interface PreOperationModifyDNOperation

Specified by:

getEntryDN in interface PreParseModifyDNOperation

Specified by:

getEntryDN in interface SubordinateModifyDNOperation

Returns:

The DN of the entry to rename.

setNewRDN

public void setNewRDN(Rdn newRDN)

Description copied from interface: PreParseModifyDNOperation

Specifies the newRDN as included in the request from the client. This should only be called by pre-parse plugins and should not be used in later stages of processing.

Specified by:

setNewRDN in interface PreParseModifyDNOperation

Parameters:

newRDN - The newRDN as included in the request from the client.

getNewRDN

public Rdn getNewRDN()

Description copied from interface: SubordinateModifyDNOperation

Retrieves the new RDN to use for the entry.

Specified by:

getNewRDN in interface PostCommitModifyDNOperation

Specified by:

getNewRDN in interface PostOperationModifyDNOperation

Specified by:

getNewRDN in interface PostResponseModifyDNOperation

Specified by:

getNewRDN in interface PostSynchronizationModifyDNOperation

Specified by:

getNewRDN in interface PreOperationModifyDNOperation

Specified by:

getNewRDN in interface PreParseModifyDNOperation

Specified by:

getNewRDN in interface SubordinateModifyDNOperation

Returns:

The new RDN to use for the entry.

deleteOldRDN

public boolean deleteOldRDN()

Description copied from interface: SubordinateModifyDNOperation

Indicates whether the current RDN value should be removed from the entry.

Specified by:

deleteOldRDN in interface PostCommitModifyDNOperation

Specified by:

deleteOldRDN in interface PostOperationModifyDNOperation

Specified by:

deleteOldRDN in interface PostResponseModifyDNOperation

Specified by:

deleteOldRDN in interface PostSynchronizationModifyDNOperation

Specified by:

deleteOldRDN in interface PreOperationModifyDNOperation

Specified by:

deleteOldRDN in interface PreParseModifyDNOperation

Specified by:

deleteOldRDN in interface SubordinateModifyDNOperation

Returns:

true if the current RDN value should be removed from the entry, or false if not.

setDeleteOldRDN

public void setDeleteOldRDN(boolean deleteOldRDN)

Description copied from interface: PreParseModifyDNOperation

Specifies whether the current RDN value should be removed from the entry.

Specified by:

setDeleteOldRDN in interface PreParseModifyDNOperation

Parameters:

deleteOldRDN - Specifies whether the current RDN value should be removed from the entry.

setNewSuperior

public void setNewSuperior(Dn newSuperior)

Description copied from interface: PreParseModifyDNOperation

Specifies the newSuperior for this modify DN operation, as provided in the request from the client. This method should only be called by pre-parse plugins.

Specified by:

setNewSuperior in interface PreParseModifyDNOperation

Parameters:

newSuperior - The newSuperior as provided in the request from the client.

getNewSuperior

public Dn getNewSuperior()

Description copied from interface: SubordinateModifyDNOperation

Retrieves the newSuperior DN for the entry.

Specified by:

getNewSuperior in interface PostCommitModifyDNOperation

Specified by:

getNewSuperior in interface PostOperationModifyDNOperation

Specified by:

getNewSuperior in interface PostResponseModifyDNOperation

Specified by:

getNewSuperior in interface PostSynchronizationModifyDNOperation

Specified by:

getNewSuperior in interface PreOperationModifyDNOperation

Specified by:

getNewSuperior in interface PreParseModifyDNOperation

Specified by:

getNewSuperior in interface SubordinateModifyDNOperation

Returns:

The newSuperior DN for the entry, or null if there is no newSuperior DN for this request.

getModifications

public List<Modification> getModifications()

Retrieves the set of modifications applied to attributes of the target entry in the course of processing this modify DN operation. This will include attribute-level changes from the modify DN itself (e.g., removing old RDN values if deleteOldRDN is set, or adding new RDN values that don't already exist), but it may also be used by pre-operation plugins to cause additional changes in the entry. In this case, those plugins may add modifications to this list (they may not remove existing modifications) if any changes should be processed in addition to the core modify DN processing. Backends may read this list to identify which attribute-level changes were applied in order to more easily apply updates to attribute indexes.

Specified by:

getModifications in interface PostCommitModifyDNOperation

Specified by:

getModifications in interface PostOperationModifyDNOperation

Specified by:

getModifications in interface PostResponseModifyDNOperation

Specified by:

getModifications in interface PostSynchronizationModifyDNOperation

Specified by:

getModifications in interface PreOperationModifyDNOperation

Returns:

The set of modifications applied to attributes during the course of the modify DN processing, or null if that information is not yet available (e.g., during pre-parse plugins).

addModification

public void addModification(Modification modification)

Description copied from interface: PreOperationModifyDNOperation

Adds the provided modification to the set of modifications to be applied as part of the update. This should only be called by pre-operation plugins.

Specified by:

addModification in interface PreOperationModifyDNOperation

Parameters:

modification - The modification to add to the set of modifications to apply to the entry.

getRequest

public ModifyDnRequest getRequest()

Description copied from class: Operation

Returns the request associated to this operation.

Specified by:

getRequest in interface PluginOperation

Overrides:

getRequest in class Operation

Returns:

The request associated to this operation.

getResponseControls

public List<Control> getResponseControls()

Description copied from interface: PluginOperation

Retrieves the set of controls to include in the response to the client. The contents of this list must not be altered.

Specified by:

getResponseControls in interface PluginOperation

Returns:

The set of controls to include in the response to the client.

addResponseControl

public void addResponseControl(Control control)

Description copied from class: Operation

Adds the provided control to the set of controls to include in the response to the client.

This method may not be called by post-response plugins.

Specified by:

addResponseControl in interface InProgressOperation

Specified by:

addResponseControl in interface PostOperationOperation

Specified by:

addResponseControl in interface PreOperationOperation

Specified by:

addResponseControl in interface PreParseOperation

Specified by:

addResponseControl in class Operation

Parameters:

control - The control to add to the set of controls to include in the response to the client.

removeResponseControl

public void removeResponseControl(Control control)

Description copied from class: Operation

Removes the provided control from the set of controls to include in the response to the client.

This method may not be called by post-response plugins.

Specified by:

removeResponseControl in interface InProgressOperation

Specified by:

removeResponseControl in interface PostOperationOperation

Specified by:

removeResponseControl in interface PreOperationOperation

Specified by:

removeResponseControl in interface PreParseOperation

Specified by:

removeResponseControl in class Operation

Parameters:

control - The control to remove from the set of controls to include in the response to the client.

runImpl

protected boolean runImpl()
                   throws LdapException

Description copied from class: Operation

Performs the work of actually processing this operation.

Specified by:

runImpl in class Operation

Returns:

true if the result should be sent immediately, or false if it will be sent later, e.g. as part of a persistent search.

Throws:

LdapException - If an error occurred when processing the operation.

invokePreParsePlugins

protected boolean invokePreParsePlugins()
                                 throws LdapException

Description copied from class: Operation

Invokes any applicable pre-parse plugins.

Specified by:

invokePreParsePlugins in class Operation

Returns:

true if processing should continue.

Throws:

LdapException - If an error occurred when invoking the pre-parse plugins.

invokePostResponsePlugins

protected void invokePostResponsePlugins()

Description copied from class: Operation

Invokes any applicable post-response plugins.

Specified by:

invokePostResponsePlugins in class Operation

toString

public void toString(StringBuilder buffer)

Description copied from interface: PluginOperation

Appends a string representation of this operation to the provided buffer.

Specified by:

toString in interface PluginOperation

Specified by:

toString in class Operation

Parameters:

buffer - The buffer into which a string representation of this operation should be appended.

getOriginalEntry

public Entry getOriginalEntry()

Description copied from interface: SubordinateModifyDNOperation

Retrieves the current entry, before it is renamed. This will not be available to pre-parse plugins or during the conflict resolution portion of the synchronization processing.

Specified by:

getOriginalEntry in interface PostCommitModifyDNOperation

Specified by:

getOriginalEntry in interface PostOperationModifyDNOperation

Specified by:

getOriginalEntry in interface PostResponseModifyDNOperation

Specified by:

getOriginalEntry in interface PostSynchronizationModifyDNOperation

Specified by:

getOriginalEntry in interface PreOperationModifyDNOperation

Specified by:

getOriginalEntry in interface SubordinateModifyDNOperation

Returns:

The current entry, or null if it is not yet available.

getUpdatedEntry

public Entry getUpdatedEntry()

Description copied from interface: SubordinateModifyDNOperation

Retrieves the new entry, as it will appear after it is renamed. This will not be available to pre-parse plugins or during the conflict resolution portion of the synchronization processing.

Specified by:

getUpdatedEntry in interface PostCommitModifyDNOperation

Specified by:

getUpdatedEntry in interface PostOperationModifyDNOperation

Specified by:

getUpdatedEntry in interface PostResponseModifyDNOperation

Specified by:

getUpdatedEntry in interface PostSynchronizationModifyDNOperation

Specified by:

getUpdatedEntry in interface PreOperationModifyDNOperation

Specified by:

getUpdatedEntry in interface SubordinateModifyDNOperation

Returns:

The updated entry, or null if it is not yet available.