Package org.opends.server.workflowelement.localbackend

Class LocalBackendAddOperation

java.lang.Object

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

org.opends.server.core.AddOperationWrapper

org.opends.server.workflowelement.localbackend.LocalBackendAddOperation

All Implemented Interfaces:

Runnable, AddOperation, Operation, PluginOperation, PostOperationAddOperation, PostOperationOperation, PostResponseAddOperation, PostResponseOperation, PostSynchronizationAddOperation, PostSynchronizationOperation, PreOperationAddOperation, PreOperationOperation, RollbackOperation

public class LocalBackendAddOperation
extends AddOperationWrapper
implements PreOperationAddOperation, PostOperationAddOperation, PostResponseAddOperation, PostSynchronizationAddOperation, RollbackOperation

This class defines an operation used to add 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
LocalBackendAddOperation(AddOperation add)	Creates a new operation that may be used to add a new entry in a local backend of the Directory Server.

Method Summary

Modifier and Type	Method	Description
Entry	getEntryToAdd()	Retrieves the entry to be added to the server.
void	processLocalAdd(LocalBackend<?> backend)	Process this add operation against a local backend.
void	rollback()

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

addObjectClass, addRawAttribute, getEntryDN, getObjectClasses, getOperationalAttributes, getRawAttributes, getRawEntryDN, getUserAttributes, removeAttribute, removeObjectClass, setAttribute, setRawAttributes, 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.AddOperation

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

getEntryDN, getObjectClasses, getOperationalAttributes, getRawAttributes, getRawEntryDN, getUserAttributes

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

getEntryDN, getObjectClasses, getOperationalAttributes, getRawAttributes, getRawEntryDN, getUserAttributes

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

getEntryDN, getObjectClasses, getOperationalAttributes, getRawAttributes, getRawEntryDN, getUserAttributes

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

addObjectClass, getEntryDN, getObjectClasses, getOperationalAttributes, getRawAttributes, getRawEntryDN, getUserAttributes, removeAttribute, removeObjectClass, setAttribute

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

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

Constructor Detail

LocalBackendAddOperation

public LocalBackendAddOperation(AddOperation add)

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

Parameters:

add - The operation to enhance.

Method Detail

getEntryToAdd

public final Entry getEntryToAdd()

Retrieves the entry to be added to the server. Note that this will not be available to pre-parse plugins or during the conflict resolution portion of the synchronization processing.

Specified by:

getEntryToAdd in interface PostOperationAddOperation

Specified by:

getEntryToAdd in interface PostResponseAddOperation

Specified by:

getEntryToAdd in interface PostSynchronizationAddOperation

Specified by:

getEntryToAdd in interface PreOperationAddOperation

Returns:

The entry to be added to the server, or null if it is not yet available.

processLocalAdd

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

Process this add operation against 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