java.lang.Object
- org.opends.server.core.OperationWrapper<ModifyDNOperation>
- - org.opends.server.core.ModifyDNOperationWrapper

All Implemented Interfaces:

Runnable, ModifyDNOperation, Operation, InProgressOperation, PluginOperation, SubordinateModifyDNOperation

Direct Known Subclasses:

LocalBackendModifyDNOperation
```
public abstract class ModifyDNOperationWrapper
extends OperationWrapper<ModifyDNOperation>
implements ModifyDNOperation
```
This abstract class wraps/decorates a given moddn operation. This class will be extended by sub-classes to enhance the functionality of the ModifyDNOperationBasis.

Field Summary
- Fields inherited from interface org.opends.server.types.Operation
  LOCALBACKENDOPERATIONS

Constructor Summary

Constructors
Constructor Description

ModifyDNOperationWrapper(ModifyDNOperation modifyDN)
Creates a new moddn operation based on the provided moddn operation.

Method Summary

All Methods Instance Methods Concrete Methods
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.
`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.
`Entry`	`getOriginalEntry()`	Retrieves the current entry, before it is renamed.
`ByteString`	`getRawEntryDN()`	Retrieves the raw, unprocessed entry DN as included in the client request.
`ByteString`	`getRawNewRDN()`	Retrieves the raw, unprocessed newRDN as included in the request from the client.
`ByteString`	`getRawNewSuperior()`	Retrieves the raw, unprocessed newSuperior from the client request.
`Entry`	`getUpdatedEntry()`	Retrieves the new entry, as it will appear after it is renamed.
`void`	`setDeleteOldRDN(boolean deleteOldRDN)`	Specifies whether the current RDN value should be removed from the entry.
`void`	`setRawEntryDN(ByteString rawEntryDN)`	Specifies the raw, unprocessed entry DN as included in the client request.
`void`	`setRawNewRDN(ByteString rawNewRDN)`	Specifies the raw, unprocessed newRDN as included in the request from the client.
`void`	`setRawNewSuperior(ByteString rawNewSuperior)`	Specifies the raw, unprocessed newSuperior for this modify DN operation, as provided in the request from the client.

Methods inherited from class org.opends.server.core.OperationWrapper
abort, addAdditionalLogItem, addRequestControl, addResponseControl, appendErrorMessage, appendMaskedErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, equals, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getConnectionID, getErrorMessage, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperation, getOperationID, getOperationType, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getProxiedAuthorizationDN, getReferralURLs, getRequestControl, getRequestControls, getResponseControls, getResultCode, hashCode, isInnerOperation, isInternalOperation, isSynchronizationOperation, operationCompleted, registerPostResponseCallback, removeAttachment, removeResponseControl, run, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, setMatchedDN, setProxiedAuthorizationDN, setReferralURLs, setResponseData, setResultCode, setSynchronizationOperation, toString, toString

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, addResponseControl, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, removeResponseControl, setErrorMessage, setMatchedDN, setReferralURLs, setResponseData, setResultCode

Methods inherited from interface org.opends.server.core.ModifyDNOperation
getProxiedAuthorizationDN, setProxiedAuthorizationDN

Methods inherited from interface org.opends.server.types.Operation
abort, addAdditionalLogItem, addRequestControl, addResponseControl, appendErrorMessage, appendMaskedErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getConnectionID, getErrorMessage, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperationID, getOperationType, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControl, getRequestControls, getResponseControls, getResultCode, isInnerOperation, isInternalOperation, isSynchronizationOperation, operationCompleted, registerPostResponseCallback, removeAttachment, removeResponseControl, run, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, setMatchedDN, setReferralURLs, setResponseData, setResultCode, setSynchronizationOperation, toString, toString

Methods inherited from interface org.opends.server.types.operation.PluginOperation
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getOperationType, getProcessingStartTime, getRequestControl, getRequestControls, getResponseControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString, toString

- Constructor Detail
  - ModifyDNOperationWrapper
```
public ModifyDNOperationWrapper(ModifyDNOperation modifyDN)
```
    Creates a new moddn operation based on the provided moddn operation.
    
    Parameters:
    
    modifyDN - The moddn operation to wrap
- Method Detail
  - addModification
```
public void addModification(Modification modification)
```
    Description copied from interface: ModifyDNOperation
    
    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 ModifyDNOperation
    
    Parameters:
    
    modification - The modification to add to the set of modifications to apply to the entry.
  - deleteOldRDN
```
public boolean deleteOldRDN()
```
    Description copied from interface: ModifyDNOperation
    
    Indicates whether the current RDN value should be removed from the entry.
    
    Specified by:
    
    deleteOldRDN in interface ModifyDNOperation
    
    Specified by:
    
    deleteOldRDN in interface SubordinateModifyDNOperation
    
    Returns:
    
    true if the current RDN value should be removed from the entry, or false if not.
  - getEntryDN
```
public DN getEntryDN()
```
    Description copied from interface: ModifyDNOperation
    
    Retrieves the DN of the entry to rename. This should not be called by pre-parse plugins because the processed DN will not be available yet. Instead, they should call the getRawEntryDN method.
    
    Specified by:
    
    getEntryDN in interface ModifyDNOperation
    
    Specified by:
    
    getEntryDN in interface SubordinateModifyDNOperation
    
    Returns:
    
    The DN of the entry to rename, or null if the raw entry DN has not yet been processed.
  - getModifications
```
public List<Modification> getModifications()
```
    Description copied from interface: ModifyDNOperation
    
    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 ModifyDNOperation
    
    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).
  - getNewRDN
```
public RDN getNewRDN()
```
    Description copied from interface: ModifyDNOperation
    
    Retrieves the new RDN to use for the entry. This should not be called by pre-parse plugins, because the processed newRDN will not yet be available. Pre-parse plugins should instead use the getRawNewRDN method.
    
    Specified by:
    
    getNewRDN in interface ModifyDNOperation
    
    Specified by:
    
    getNewRDN in interface SubordinateModifyDNOperation
    
    Returns:
    
    The new RDN to use for the entry, or null if the raw newRDN has not yet been processed.
  - getNewSuperior
```
public DN getNewSuperior()
```
    Description copied from interface: ModifyDNOperation
    
    Retrieves the newSuperior DN for the entry. This should not be called by pre-parse plugins, because the processed DN will not yet be available at that time. Instead, they should use the getRawNewSuperior method.
    
    Specified by:
    
    getNewSuperior in interface ModifyDNOperation
    
    Specified by:
    
    getNewSuperior in interface SubordinateModifyDNOperation
    
    Returns:
    
    The newSuperior DN for the entry, or null if there is no newSuperior DN for this request or if the raw newSuperior has not yet been processed.
  - getOriginalEntry
```
public Entry getOriginalEntry()
```
    Description copied from interface: ModifyDNOperation
    
    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 ModifyDNOperation
    
    Specified by:
    
    getOriginalEntry in interface SubordinateModifyDNOperation
    
    Returns:
    
    The current entry, or null if it is not yet available.
  - getRawEntryDN
```
public ByteString getRawEntryDN()
```
    Description copied from interface: ModifyDNOperation
    
    Retrieves the raw, unprocessed entry DN as included in the client request. The DN that is returned may or may not be a valid DN, since no validation will have been performed upon it.
    
    Specified by:
    
    getRawEntryDN in interface ModifyDNOperation
    
    Specified by:
    
    getRawEntryDN in interface SubordinateModifyDNOperation
    
    Returns:
    
    The raw, unprocessed entry DN as included in the client request.
  - getRawNewRDN
```
public ByteString getRawNewRDN()
```
    Description copied from interface: ModifyDNOperation
    
    Retrieves the raw, unprocessed newRDN as included in the request from the client. This may or may not contain a valid RDN, as no validation will have been performed on it.
    
    Specified by:
    
    getRawNewRDN in interface ModifyDNOperation
    
    Specified by:
    
    getRawNewRDN in interface SubordinateModifyDNOperation
    
    Returns:
    
    The raw, unprocessed newRDN as included in the request from the client.
  - getRawNewSuperior
```
public ByteString getRawNewSuperior()
```
    Description copied from interface: ModifyDNOperation
    
    Retrieves the raw, unprocessed newSuperior from the client request. This may or may not contain a valid DN, as no validation will have been performed on it.
    
    Specified by:
    
    getRawNewSuperior in interface ModifyDNOperation
    
    Specified by:
    
    getRawNewSuperior in interface SubordinateModifyDNOperation
    
    Returns:
    
    The raw, unprocessed newSuperior from the client request, or null if there is none.
  - getUpdatedEntry
```
public Entry getUpdatedEntry()
```
    Description copied from interface: ModifyDNOperation
    
    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 ModifyDNOperation
    
    Specified by:
    
    getUpdatedEntry in interface SubordinateModifyDNOperation
    
    Returns:
    
    The updated entry, or null if it is not yet available.
  - setDeleteOldRDN
```
public void setDeleteOldRDN(boolean deleteOldRDN)
```
    Description copied from interface: ModifyDNOperation
    
    Specifies whether the current RDN value should be removed from the entry.
    
    Specified by:
    
    setDeleteOldRDN in interface ModifyDNOperation
    
    Parameters:
    
    deleteOldRDN - Specifies whether the current RDN value should be removed from the entry.
  - setRawEntryDN
```
public void setRawEntryDN(ByteString rawEntryDN)
```
    Description copied from interface: ModifyDNOperation
    
    Specifies the raw, unprocessed entry DN as included in the client request. This should only be called by pre-parse plugins.
    
    Specified by:
    
    setRawEntryDN in interface ModifyDNOperation
    
    Parameters:
    
    rawEntryDN - The raw, unprocessed entry DN as included in the client request.
  - setRawNewRDN
```
public void setRawNewRDN(ByteString rawNewRDN)
```
    Description copied from interface: ModifyDNOperation
    
    Specifies the raw, unprocessed 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:
    
    setRawNewRDN in interface ModifyDNOperation
    
    Parameters:
    
    rawNewRDN - The raw, unprocessed newRDN as included in the request from the client.
  - setRawNewSuperior
```
public void setRawNewSuperior(ByteString rawNewSuperior)
```
    Description copied from interface: ModifyDNOperation
    
    Specifies the raw, unprocessed 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:
    
    setRawNewSuperior in interface ModifyDNOperation
    
    Parameters:
    
    rawNewSuperior - The raw, unprocessed newSuperior as provided in the request from the client.
  - getNewDN
```
public DN getNewDN()
```
    Description copied from interface: ModifyDNOperation
    
    Retrieves the new DN for the entry.
    
    Specified by:
    
    getNewDN in interface ModifyDNOperation
    
    Returns:
    
    The new DN for the entry, or null if there is neither newRDN, nor entryDN for this request.

Class ModifyDNOperationWrapper

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class org.opends.server.core.OperationWrapper

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opends.server.core.ModifyDNOperation

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

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

Constructor Detail

ModifyDNOperationWrapper

Method Detail

addModification

deleteOldRDN

getEntryDN

getModifications

getNewRDN

getNewSuperior

getOriginalEntry

getRawEntryDN

getRawNewRDN

getRawNewSuperior

getUpdatedEntry

setDeleteOldRDN

setRawEntryDN

setRawNewRDN

setRawNewSuperior

getNewDN