Package org.opends.server.workflowelement.localbackend

Class LocalBackendSearchOperation

java.lang.Object

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

org.opends.server.core.SearchOperationWrapper

org.opends.server.workflowelement.localbackend.LocalBackendSearchOperation

All Implemented Interfaces:

Runnable, SearchOperation, Operation, InProgressOperation, PluginOperation, PostOperationOperation, PostOperationSearchOperation, PreOperationOperation, PreOperationSearchOperation, SearchEntrySearchOperation, SearchReferenceSearchOperation

public class LocalBackendSearchOperation
extends SearchOperationWrapper
implements PreOperationSearchOperation, PostOperationSearchOperation, SearchEntrySearchOperation, SearchReferenceSearchOperation

This class defines an operation used to search for entries 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
LocalBackendSearchOperation(SearchOperation search)	Creates a new operation that may be used to search for entries in a local backend of the Directory Server.

Method Summary

Modifier and Type	Method	Description
void	processLocalSearch(LocalBackend<?> backend)	Process this search operation against a local backend.

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

endSearchPhase, getAttributes, getBaseDN, getDerefPolicy, getEntriesSent, getFilter, getMatchedValuesControl, getRawBaseDN, getRawFilter, getReferencesSent, getScope, getSizeLimit, getTimeLimit, getTimeLimitExpiration, getTypesOnly, isClientAcceptsReferrals, isIncludeUsableControl, isRealAttributesOnly, isReturnSubentriesOnly, isSendResponse, isVirtualAttributesOnly, returnEntry, returnEntry, returnPersistentSearchEntry, returnReference, returnReference, sendSearchEntry, sendSearchReference, sendSearchResultDone, setAttributes, setBaseDN, setClientAcceptsReferrals, setDerefPolicy, setIncludeUsableControl, setMatchedValuesControl, setRawBaseDN, setRawFilter, setRealAttributesOnly, setReturnSubentriesOnly, setScope, setSendResponse, setSizeLimit, setTimeLimit, setTimeLimitExpiration, setTypesOnly, setVirtualAttributesOnly, 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.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.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.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.PostOperationSearchOperation

getAttributes, getBaseDN, getDerefPolicy, getEntriesSent, getFilter, getRawBaseDN, getRawFilter, getReferencesSent, getScope, getSizeLimit, getTimeLimit, getTypesOnly

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

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

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

getAttributes, getBaseDN, getDerefPolicy, getFilter, getRawBaseDN, getRawFilter, getScope, getSizeLimit, getTimeLimit, getTypesOnly, returnEntry, returnReference

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

getAttributes, getBaseDN, getDerefPolicy, getFilter, getRawBaseDN, getRawFilter, getScope, getSizeLimit, getTimeLimit, getTypesOnly

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

getProxiedAuthorizationDN, setProxiedAuthorizationDN

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

getAttributes, getBaseDN, getDerefPolicy, getFilter, getRawBaseDN, getRawFilter, getScope, getSizeLimit, getTimeLimit, getTypesOnly

Constructor Detail

LocalBackendSearchOperation

public LocalBackendSearchOperation(SearchOperation search)

Creates a new operation that may be used to search for entries in a local backend of the Directory Server.

Parameters:

search - The operation to process.

Method Detail

processLocalSearch

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

Process this search operation against a local backend.

Parameters:

backend - The backend on which operation is performed.

Throws:

CanceledOperationException - if this operation should be cancelled