Package org.opends.server.core

Class SearchOperation

java.lang.Object

org.opends.server.types.Operation

org.opends.server.core.SearchOperation

All Implemented Interfaces:

Runnable, InProgressOperation, InProgressSearchOperation, PluginOperation, PostOperationOperation, PostOperationSearchOperation, PostResponseOperation, PostResponseSearchOperation, PreOperationOperation, PreOperationSearchOperation, PreParseOperation, PreParseSearchOperation

public class SearchOperation
extends Operation
implements PreOperationSearchOperation, PreParseSearchOperation, PostOperationSearchOperation, PostResponseSearchOperation, InProgressSearchOperation

This class defines an operation used to search for entries in the Directory Server.

Field Summary

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

requestContext

Constructor Summary

Constructors

Constructor	Description
SearchOperation(org.forgerock.services.context.Context context, SearchRequest request)	Creates a new search operation with the provided information.

Method Summary

Modifier and Type	Method	Description
void	addResponseControl(Control control)	Adds the provided control to the set of controls to include in the response to the client.
Set<String>	getAttributes()	Retrieves the set of requested attributes for this search operation.
Dn	getBaseDN()	Retrieves the base DN for this search operation.
DereferenceAliasesPolicy	getDerefPolicy()	Retrieves the alias dereferencing policy for this search operation.
int	getEntriesSent()	Retrieves the number of entries sent to the client for this search operation.
Filter	getFilter()	Retrieves the filter for this search operation.
Matcher	getMatcher()	Retrieves the matcher derived from the search filter for this search operation.
OperationType	getOperationType()	Retrieves the operation type for this operation.
Dn	getProxiedAuthorizationDN()	Retrieves the proxied authorization DN for this operation if proxied authorization has been requested.
int	getReferencesSent()	Retrieves the number of search references sent to the client for this search operation.
List<Control>	getResponseControls()	Retrieves the set of controls to include in the response to the client.
SearchScope	getScope()	Retrieves the scope for this search operation.
int	getSizeLimit()	Retrieves the size limit for this search operation.
int	getTimeLimit()	Retrieves the time limit for this search operation.
boolean	getTypesOnly()	Retrieves the typesOnly flag for this search operation.
boolean	isSendResponse()	Indicates whether the search result done message has to be sent to the client, or not.
void	removeResponseControl(Control control)	Removes the provided control from the set of controls to include in the response to the client.
boolean	returnEntry(Entry entry, List<Control> controls)	Used as a callback for backends to indicate that the provided entry matches the search criteria and that additional processing should be performed to potentially send it back to the client.
boolean	returnReference(Dn dn, SearchResultReference reference)	Used as a callback for backends to indicate that the provided search reference was encountered during processing and that additional processing should be performed to potentially send it back to the client.
void	run()	Performs the work of actually processing this operation.
void	sendSearchEntry(SearchResultEntry entry)	Sends the provided search result entry to the client.
boolean	sendSearchReference(SearchResultReference reference)	Sends the provided search result reference to the client.
void	sendSearchResultDone()	Sends the search result done message to the client.
void	setAttributes(Set<String> attributes)	Specifies the set of requested attributes for this search operation.
void	setBaseDN(Dn baseDN)	Specifies the base DN as included in the request from the client.
void	setDerefPolicy(DereferenceAliasesPolicy derefPolicy)	Specifies the alias dereferencing policy for this search operation.
void	setFilter(Filter filter)	Specifies the search filter as included in the request from the client.
void	setProxiedAuthorizationDN(Dn proxiedAuthorizationDN)	Set the proxied authorization DN for this operation if proxied authorization has been requested.
void	setScope(SearchScope scope)	Specifies the scope for this search operation.
void	setSendResponse(boolean sendResponse)	Specify whether the search result done message has to be sent to the client, or not.
void	setSizeLimit(int sizeLimit)	Specifies the size limit for this search operation.
void	setTimeLimit(int timeLimit)	Specifies the time limit for this search operation.
void	setTypesOnly(boolean typesOnly)	Specifies the typesOnly flag for this search operation.
void	toString(StringBuilder buffer)	Appends a string representation of this operation to the provided buffer.

Methods inherited from class org.opends.server.types.Operation

addAdditionalLogItem, addPasswordPolicyWarningToLog, addPostReadResponse, addPreReadResponse, addRequestControl, appendErrorMessage, appendMaskedErrorMessage, checkAttributeConformsToSyntax, checkIfBackendIsWritable, checkIfCanceled, createLdapException, disconnectClient, dontSynchronize, equals, evaluateProxyAuthControls, filterNonDisclosableMatchedDN, findMatchedDN, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getClientConnection, getConnectionID, getContext, getErrorMessage, getLocalBackend, getMatchedDN, getMessageID, getOperationID, getReferralURLs, getRequestControl, getRequestControls, getResultCode, hashCode, hasPrivilege, hasRequestControl, invokePostResponseCallbacks, isHumanReadable, isInnerOperation, isInternalOperation, isProxyAuthzControl, isSynchronizationOperation, mustCheckSchema, operationCompleted, processOperationResult, processOperationResult, registerPostResponseCallback, removeAllDisallowedControls, removeAttachment, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMatchedDN, setReferralURLs, setResult, setResult, setResultCode, setResultCodeAndMessageNoInfoDisclosure, 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, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, setErrorMessage, setMatchedDN, setReferralURLs, setResult, setResultCode

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

checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getRequestControl, getRequestControl, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString

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

addAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, setErrorMessage, setMatchedDN, setReferralURLs, setResult, setResultCode

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

getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode

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

addAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, setErrorMessage

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

addAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, setErrorMessage

Constructor Detail

SearchOperation

public SearchOperation(org.forgerock.services.context.Context context,
                       SearchRequest request)

Creates a new search operation with the provided information.

Parameters:

context - The request context with which this operation is associated.

request - The search request.

Method Detail

setBaseDN

public final void setBaseDN(Dn baseDN)

Specifies the base DN as included in the request from the client.

This method should only be called by pre-parse plugins or for internal use.

Specified by:

setBaseDN in interface PreParseSearchOperation

Parameters:

baseDN - The non-null base DN as included in the request from the client.

getBaseDN

public final Dn getBaseDN()

Description copied from interface: PreOperationSearchOperation

Retrieves the base DN for this search operation.

Specified by:

getBaseDN in interface InProgressSearchOperation

Specified by:

getBaseDN in interface PostOperationSearchOperation

Specified by:

getBaseDN in interface PostResponseSearchOperation

Specified by:

getBaseDN in interface PreOperationSearchOperation

Specified by:

getBaseDN in interface PreParseSearchOperation

Returns:

The base DN for this search operation.

getScope

public final SearchScope getScope()

Retrieves the scope for this search operation.

Specified by:

getScope in interface InProgressSearchOperation

Specified by:

getScope in interface PostOperationSearchOperation

Specified by:

getScope in interface PostResponseSearchOperation

Specified by:

getScope in interface PreOperationSearchOperation

Specified by:

getScope in interface PreParseSearchOperation

Returns:

The scope for this search operation.

setScope

public final void setScope(SearchScope scope)

Specifies the scope for this search operation. This should only be called by pre-parse plugins.

Specified by:

setScope in interface PreParseSearchOperation

Parameters:

scope - The scope for this search operation.

getDerefPolicy

public final DereferenceAliasesPolicy getDerefPolicy()

Retrieves the alias dereferencing policy for this search operation.

Specified by:

getDerefPolicy in interface InProgressSearchOperation

Specified by:

getDerefPolicy in interface PostOperationSearchOperation

Specified by:

getDerefPolicy in interface PostResponseSearchOperation

Specified by:

getDerefPolicy in interface PreOperationSearchOperation

Specified by:

getDerefPolicy in interface PreParseSearchOperation

Returns:

The alias dereferencing policy for this search operation.

setDerefPolicy

public final void setDerefPolicy(DereferenceAliasesPolicy derefPolicy)

Specifies the alias dereferencing policy for this search operation. This should only be called by pre-parse plugins.

Specified by:

setDerefPolicy in interface PreParseSearchOperation

Parameters:

derefPolicy - The alias dereferencing policy for this search operation.

getSizeLimit

public final int getSizeLimit()

Retrieves the size limit for this search operation.

Specified by:

getSizeLimit in interface InProgressSearchOperation

Specified by:

getSizeLimit in interface PostOperationSearchOperation

Specified by:

getSizeLimit in interface PostResponseSearchOperation

Specified by:

getSizeLimit in interface PreOperationSearchOperation

Specified by:

getSizeLimit in interface PreParseSearchOperation

Returns:

The size limit for this search operation.

setSizeLimit

public final void setSizeLimit(int sizeLimit)

Specifies the size limit for this search operation. This should only be called by pre-parse plugins.

Specified by:

setSizeLimit in interface PreParseSearchOperation

Parameters:

sizeLimit - The size limit for this search operation.

getTimeLimit

public final int getTimeLimit()

Retrieves the time limit for this search operation.

Specified by:

getTimeLimit in interface InProgressSearchOperation

Specified by:

getTimeLimit in interface PostOperationSearchOperation

Specified by:

getTimeLimit in interface PostResponseSearchOperation

Specified by:

getTimeLimit in interface PreOperationSearchOperation

Specified by:

getTimeLimit in interface PreParseSearchOperation

Returns:

The time limit for this search operation.

setTimeLimit

public final void setTimeLimit(int timeLimit)

Specifies the time limit for this search operation. This should only be called by pre-parse plugins.

Specified by:

setTimeLimit in interface PreParseSearchOperation

Parameters:

timeLimit - The time limit for this search operation.

getTypesOnly

public final boolean getTypesOnly()

Retrieves the typesOnly flag for this search operation.

Specified by:

getTypesOnly in interface InProgressSearchOperation

Specified by:

getTypesOnly in interface PostOperationSearchOperation

Specified by:

getTypesOnly in interface PostResponseSearchOperation

Specified by:

getTypesOnly in interface PreOperationSearchOperation

Specified by:

getTypesOnly in interface PreParseSearchOperation

Returns:

The typesOnly flag for this search operation.

setTypesOnly

public final void setTypesOnly(boolean typesOnly)

Specifies the typesOnly flag for this search operation. This should only be called by pre-parse plugins.

Specified by:

setTypesOnly in interface PreParseSearchOperation

Parameters:

typesOnly - The typesOnly flag for this search operation.

setFilter

public final void setFilter(Filter filter)

Specifies the search filter as included in the request from the client.

This method should only be called by pre-parse plugins.

Specified by:

setFilter in interface PreParseSearchOperation

Parameters:

filter - The non-null search filter as included in the request from the client.

getFilter

public final Filter getFilter()

Retrieves the filter for this search operation.

Only use this method for logging. Prefer to use getMatcher() for matching entries.

Specified by:

getFilter in interface InProgressSearchOperation

Specified by:

getFilter in interface PostOperationSearchOperation

Specified by:

getFilter in interface PostResponseSearchOperation

Specified by:

getFilter in interface PreOperationSearchOperation

Specified by:

getFilter in interface PreParseSearchOperation

Returns:

The filter for this search operation.

getMatcher

public final Matcher getMatcher()

Retrieves the matcher derived from the search filter for this search operation.

Returns:

the matcher for this search operation.

getAttributes

public final Set<String> getAttributes()

Retrieves the set of requested attributes for this search operation. Its contents should not be altered.

Specified by:

getAttributes in interface InProgressSearchOperation

Specified by:

getAttributes in interface PostOperationSearchOperation

Specified by:

getAttributes in interface PostResponseSearchOperation

Specified by:

getAttributes in interface PreOperationSearchOperation

Specified by:

getAttributes in interface PreParseSearchOperation

Returns:

The set of requested attributes for this search operation.

setAttributes

public final void setAttributes(Set<String> attributes)

Specifies the set of requested attributes for this search operation. It should only be called by pre-parse plugins.

Specified by:

setAttributes in interface PreParseSearchOperation

Parameters:

attributes - The set of requested attributes for this search operation.

getEntriesSent

public final int getEntriesSent()

Retrieves the number of entries sent to the client for this search operation.

Specified by:

getEntriesSent in interface PostOperationSearchOperation

Specified by:

getEntriesSent in interface PostResponseSearchOperation

Returns:

The number of entries sent to the client for this search operation.

getReferencesSent

public final int getReferencesSent()

Retrieves the number of search references sent to the client for this search operation.

Specified by:

getReferencesSent in interface PostOperationSearchOperation

Specified by:

getReferencesSent in interface PostResponseSearchOperation

Returns:

The number of search references sent to the client for this search operation.

returnEntry

public boolean returnEntry(Entry entry,
                           List<Control> controls)

Used as a callback for backends to indicate that the provided entry matches the search criteria and that additional processing should be performed to potentially send it back to the client.

Specified by:

returnEntry in interface PreOperationSearchOperation

Specified by:

returnEntry in interface PreParseSearchOperation

Parameters:

entry - The entry that matches the search criteria and should be sent to the client.

controls - The set of controls to include with the entry (may be null if none are needed).

Returns:

true if the caller should continue processing the search request and sending additional entries and references, or false if not for some reason (e.g., the size limit has been reached or the search has been abandoned).

returnReference

public boolean returnReference(Dn dn,
                               SearchResultReference reference)

Used as a callback for backends to indicate that the provided search reference was encountered during processing and that additional processing should be performed to potentially send it back to the client.

Specified by:

returnReference in interface PreOperationSearchOperation

Specified by:

returnReference in interface PreParseSearchOperation

Parameters:

reference - The search reference to send to the client.

dn - The DN related to the specified search reference.

Returns:

true if the caller should continue processing the search request and sending additional entries and references , or false if not for some reason (e.g., the size limit has been reached or the search has been abandoned).

sendSearchResultDone

public void sendSearchResultDone()

Sends the search result done message to the client. Note that this method should only be called from external classes in special cases (e.g., persistent search) where they are sure that the result won't be sent by the core server. Also note that the result code and optionally the error message should have been set for this operation before this method is called.

getOperationType

public final OperationType getOperationType()

Description copied from interface: PluginOperation

Retrieves the operation type for this operation.

Specified by:

getOperationType in interface PluginOperation

Returns:

The operation type for this operation.

getProxiedAuthorizationDN

public final Dn getProxiedAuthorizationDN()

Description copied from class: Operation

Retrieves the proxied authorization DN for this operation if proxied authorization has been requested.

Specified by:

getProxiedAuthorizationDN in class Operation

Returns:

The proxied authorization DN for this operation if proxied authorization has been requested, or null if proxied authorization has not been requested.

getResponseControls

public final List<Control> getResponseControls()

Description copied from interface: PluginOperation

Retrieves the set of controls to include in the response to the client. The contents of this list must not be altered.

Specified by:

getResponseControls in interface PluginOperation

Returns:

The set of controls to include in the response to the client.

addResponseControl

public final void addResponseControl(Control control)

Description copied from class: Operation

Adds the provided control to the set of controls to include in the response to the client.

This method may not be called by post-response plugins.

Specified by:

addResponseControl in interface InProgressOperation

Specified by:

addResponseControl in interface PostOperationOperation

Specified by:

addResponseControl in interface PreOperationOperation

Specified by:

addResponseControl in interface PreParseOperation

Specified by:

addResponseControl in class Operation

Parameters:

control - The control to add to the set of controls to include in the response to the client.

removeResponseControl

public final void removeResponseControl(Control control)

Description copied from class: Operation

Removes the provided control from the set of controls to include in the response to the client.

This method may not be called by post-response plugins.

Specified by:

removeResponseControl in interface InProgressOperation

Specified by:

removeResponseControl in interface PostOperationOperation

Specified by:

removeResponseControl in interface PreOperationOperation

Specified by:

removeResponseControl in interface PreParseOperation

Specified by:

removeResponseControl in class Operation

Parameters:

control - The control to remove from the set of controls to include in the response to the client.

toString

public void toString(StringBuilder buffer)

Description copied from class: Operation

Appends a string representation of this operation to the provided buffer.

Specified by:

toString in interface PluginOperation

Specified by:

toString in class Operation

Parameters:

buffer - The buffer into which a string representation of this operation should be appended.

isSendResponse

public final boolean isSendResponse()

Indicates whether the search result done message has to be sent to the client, or not.

Returns:

true if the search result done message is to be sent to the client

setSendResponse

public final void setSendResponse(boolean sendResponse)

Specify whether the search result done message has to be sent to the client, or not.

Parameters:

sendResponse - - boolean indicating whether the search result done message is to send to the client

sendSearchEntry

public void sendSearchEntry(SearchResultEntry entry)
                     throws LdapException

Sends the provided search result entry to the client.

Parameters:

entry - The search result entry to be sent to the client.

Throws:

LdapException - If a problem occurs while attempting to send the entry to the client and the search should be terminated.

sendSearchReference

public boolean sendSearchReference(SearchResultReference reference)
                            throws LdapException

Sends the provided search result reference to the client.

Parameters:

reference - The search result reference to be sent to the client.

Returns:

true if the client is able to accept referrals, or false if the client cannot handle referrals and no more attempts should be made to send them for the associated search operation.

Throws:

LdapException - If a problem occurs while attempting to send the reference to the client and the search should be terminated.

setProxiedAuthorizationDN

public final void setProxiedAuthorizationDN(Dn proxiedAuthorizationDN)

Description copied from class: Operation

Set the proxied authorization DN for this operation if proxied authorization has been requested.

Specified by:

setProxiedAuthorizationDN in class Operation

Parameters:

proxiedAuthorizationDN - The proxied authorization DN for this operation if proxied authorization has been requested, or null if proxied authorization has not been requested.

run

public void run()

Description copied from class: Operation

Performs the work of actually processing this operation. This should include all processing for the operation, including invoking pre-parse and post-response plugins, logging messages and any other work that might need to be done in the course of processing.

Specified by:

run in interface Runnable

Specified by:

run in class Operation