Package org.opends.server.workflowelement.localbackend

Class LocalBackendModifyDNOperation

java.lang.Object

org.opends.server.core.OperationWrapper<ModifyDNOperation>

org.opends.server.core.ModifyDNOperationWrapper

org.opends.server.workflowelement.localbackend.LocalBackendModifyDNOperation

All Implemented Interfaces:

Runnable, ModifyDNOperation, Operation, InProgressOperation, PluginOperation, PostOperationModifyDNOperation, PostOperationOperation, PostResponseModifyDNOperation, PostResponseOperation, PostSynchronizationModifyDNOperation, PostSynchronizationOperation, PreOperationModifyDNOperation, PreOperationOperation, RollbackOperation, SubordinateModifyDNOperation

public class LocalBackendModifyDNOperation
extends ModifyDNOperationWrapper
implements PreOperationModifyDNOperation, PostOperationModifyDNOperation, PostResponseModifyDNOperation, PostSynchronizationModifyDNOperation, RollbackOperation

This class defines an operation used to move an entry in a local backend of the Directory Server.

Field Summary

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

LOCALBACKENDOPERATIONS

Constructor Summary

Constructors

Constructor	Description
LocalBackendModifyDNOperation(ModifyDNOperation operation)	Creates a new operation that may be used to move an entry in a local backend of the Directory Server.

Method Summary

Modifier and Type	Method	Description
Entry	getOriginalEntry()	Retrieves the current entry, before it is renamed.
Entry	getUpdatedEntry()	Retrieves the new entry, as it will appear after it is renamed.
void	processLocalModifyDN(LocalBackend<?> backend)	Process this modify DN operation in a local backend.
void	rollback()

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

addModification, deleteOldRDN, getEntryDN, getModifications, getNewDN, getNewRDN, getNewSuperior, getRawEntryDN, getRawNewRDN, getRawNewSuperior, setDeleteOldRDN, setRawEntryDN, setRawNewRDN, setRawNewSuperior

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

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

deleteOldRDN, getEntryDN, getModifications, getNewRDN, getNewSuperior, getRawEntryDN, getRawNewRDN, getRawNewSuperior

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

addAdditionalLogItem, addResponseControl, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, removeResponseControl, setErrorMessage, setMatchedDN, setReferralURLs, setResponseData, setResultCode

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

deleteOldRDN, getEntryDN, getModifications, getNewRDN, getNewSuperior, getRawEntryDN, getRawNewRDN, getRawNewSuperior

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

getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getProcessingStopTime, getProcessingTime, getReferralURLs, getResultCode

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

deleteOldRDN, getEntryDN, getModifications, getNewRDN, getNewSuperior, getRawEntryDN, getRawNewRDN, getRawNewSuperior

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

getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getProcessingStopTime, getProcessingTime, getReferralURLs, getResultCode

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

addModification, deleteOldRDN, getEntryDN, getModifications, getNewRDN, getNewSuperior, getRawEntryDN, getRawNewRDN, getRawNewSuperior

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

addAdditionalLogItem, addResponseControl, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, removeResponseControl, setErrorMessage

Constructor Detail

LocalBackendModifyDNOperation

public LocalBackendModifyDNOperation(ModifyDNOperation operation)

Creates a new operation that may be used to move an entry in a local backend of the Directory Server.

Parameters:

operation - The operation to enhance.

Method Detail

getOriginalEntry

public final Entry getOriginalEntry()

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 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

Overrides:

getOriginalEntry in class ModifyDNOperationWrapper

Returns:

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

getUpdatedEntry

public final Entry getUpdatedEntry()

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 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

Overrides:

getUpdatedEntry in class ModifyDNOperationWrapper

Returns:

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

processLocalModifyDN

public void processLocalModifyDN(LocalBackend<?> backend)
                          throws CanceledOperationException

Process this modify DN operation in a local backend.

Parameters:

backend - The backend on which operation is performed.

Throws:

CanceledOperationException - if this operation should be cancelled

rollback

public void rollback()
              throws CanceledOperationException,
                     DirectoryException

Specified by:

rollback in interface RollbackOperation

Throws:

CanceledOperationException

DirectoryException