Package org.opends.server.workflowelement.localbackend

Class LocalBackendDeleteOperation

java.lang.Object

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

org.opends.server.core.DeleteOperationWrapper

org.opends.server.workflowelement.localbackend.LocalBackendDeleteOperation

All Implemented Interfaces:

Runnable, DeleteOperation, Operation, PluginOperation, PostOperationDeleteOperation, PostOperationOperation, PostResponseDeleteOperation, PostResponseOperation, PostSynchronizationDeleteOperation, PostSynchronizationOperation, PreOperationDeleteOperation, PreOperationOperation, RollbackOperation

public class LocalBackendDeleteOperation
extends DeleteOperationWrapper
implements PreOperationDeleteOperation, PostOperationDeleteOperation, PostResponseDeleteOperation, PostSynchronizationDeleteOperation, RollbackOperation

This class defines an operation used to delete 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
LocalBackendDeleteOperation(DeleteOperation delete)	Creates a new operation that may be used to delete an entry from a local backend of the Directory Server.

Method Summary

Modifier and Type	Method	Description
Entry	getEntryToDelete()	Retrieves the entry to be deleted.
void	processLocalDelete(LocalBackend<?> backend)	Process this delete operation in a local backend.
void	rollback()

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

getEntryDN, getRawEntryDN, setRawEntryDN, toString

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

Methods inherited from class java.lang.Object

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

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

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

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

getEntryDN, getRawEntryDN

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

getEntryDN, getRawEntryDN

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

getEntryDN, getRawEntryDN

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

getEntryDN, getRawEntryDN

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

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

Constructor Detail

LocalBackendDeleteOperation

public LocalBackendDeleteOperation(DeleteOperation delete)

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

Parameters:

delete - The operation to enhance.

Method Detail

getEntryToDelete

public Entry getEntryToDelete()

Retrieves the entry to be deleted.

Specified by:

getEntryToDelete in interface PostOperationDeleteOperation

Specified by:

getEntryToDelete in interface PostResponseDeleteOperation

Specified by:

getEntryToDelete in interface PostSynchronizationDeleteOperation

Specified by:

getEntryToDelete in interface PreOperationDeleteOperation

Returns:

The entry to be deleted, or null if the entry is not yet available.

processLocalDelete

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

Process this delete 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