Package org.opends.server.workflowelement.localbackend

Class LocalBackendCompareOperation

java.lang.Object

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

org.opends.server.core.CompareOperationWrapper

org.opends.server.workflowelement.localbackend.LocalBackendCompareOperation

All Implemented Interfaces:

Runnable, CompareOperation, Operation, PluginOperation, PostOperationCompareOperation, PostOperationOperation, PostResponseCompareOperation, PostResponseOperation, PreOperationCompareOperation, PreOperationOperation

public class LocalBackendCompareOperation
extends CompareOperationWrapper
implements PreOperationCompareOperation, PostOperationCompareOperation, PostResponseCompareOperation

This class defines an operation that may be used to determine whether a specified entry in the Directory Server contains a given attribute-value pair.

Field Summary

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

LOCALBACKENDOPERATIONS

Constructor Summary

Constructors

Constructor	Description
LocalBackendCompareOperation(CompareOperation compare)	Creates a new compare operation based on the provided compare operation.

Method Summary

Modifier and Type	Method	Description
Entry	getEntryToCompare()	Retrieves the entry to target with the compare operation.
void	processLocalCompare(LocalBackend<?> backend)	Process this compare operation in a local backend.

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

getAssertionValue, getAttributeDescription, getEntryDN, getRawAttributeType, getRawEntryDN, setAssertionValue, setRawAttributeType, setRawEntryDN

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.core.CompareOperation

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

getAssertionValue, getAttributeDescription, getEntryDN, getRawAttributeType, 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.PostResponseCompareOperation

getAssertionValue, getAttributeDescription, getEntryDN, getRawAttributeType, 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.PreOperationCompareOperation

getAssertionValue, getAttributeDescription, getEntryDN, getRawAttributeType, getRawEntryDN, setAssertionValue

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

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

Constructor Detail

LocalBackendCompareOperation

public LocalBackendCompareOperation(CompareOperation compare)

Creates a new compare operation based on the provided compare operation.

Parameters:

compare - the compare operation

Method Detail

getEntryToCompare

public Entry getEntryToCompare()

Retrieves the entry to target with the compare operation.

Specified by:

getEntryToCompare in interface PostOperationCompareOperation

Specified by:

getEntryToCompare in interface PostResponseCompareOperation

Specified by:

getEntryToCompare in interface PreOperationCompareOperation

Returns:

The entry to target with the compare operation, or null if the entry is not yet available.

processLocalCompare

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

Process this compare operation in a local backend.

Parameters:

backend - The backend on which operation is performed.

Throws:

CanceledOperationException - if this operation should be cancelled