Package org.opends.server.core

Class SearchOperation

java.lang.Object

org.opends.server.types.Operation

org.opends.server.core.SearchOperation

All Implemented Interfaces:

InProgressOperation, InProgressSearchOperation, PluginOperation, PostCommitOperation, 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

backend, context, out, pluginConfigManager, request, serverContext

Constructor Summary

Constructors

Constructor	Description
SearchOperation(RequestContext context, LocalBackend<?> backend, SearchRequest request, Consumer<ResponseStream> out)	Creates a new search operation.

Method Summary

Modifier and Type	Method	Description
final void	addResponseControl(Control control)	Adds the provided control to the set of controls to include in the response to the client.
final Set<String>	getAttributes()	Retrieves the set of requested attributes for this search operation.
final Dn	getBaseDN()	Retrieves the base DN for this search operation.
final DereferenceAliasesPolicy	getDerefPolicy()	Retrieves the alias dereferencing policy for this search operation.
final int	getEntriesSent()	Retrieves the number of entries sent to the client for this search operation.
final Filter	getFilter()	Retrieves the filter for this search operation.
final Matcher	getMatcher()	Retrieves the matcher derived from the search filter for this search operation.
final int	getReferencesSent()	Retrieves the number of search references sent to the client for this search operation.
SearchRequest	getRequest()	Returns the request associated to this operation.
final ResourceLimits	getResourceLimits()	Retrieves the limits for this search operation.
final List<Control>	getResponseControls()	Retrieves the set of controls to include in the response to the client.
final SearchScope	getScope()	Retrieves the scope for this search operation.
ServerSideSortRequestControl	getServerSideSortControlOrNull()	Return the Server Side Sort Control of the search request or null if absent.
SimplePagedResultsControl	getSimplePagedResultsControlOrNull()	Return the Simple Paged Results Control of the search request or null if absent.
final boolean	getTypesOnly()	Retrieves the typesOnly flag for this search operation.
VirtualListViewRequestControl	getVirtualListViewRequestControlOrNull()	Return the Virtual List View Request Control of the search request or null if absent.
protected void	handleRequestControls()	Handles any controls contained in the request.
protected void	invokePostResponsePlugins()	Invokes any applicable post-response plugins.
protected boolean	invokePreParsePlugins()	Invokes any applicable pre-parse plugins.
boolean	isManageDsaIt()	Returns true if this search operation contains the ManageDsaIT control.
boolean	mayReturnEntry(Entry entry)	Returns if the entry may be returned according to access control and other checks.
final 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.
protected boolean	runImpl()	Performs the work of actually processing this operation.
final void	setAttributes(Set<String> attributes)	Specifies the set of requested attributes for this search operation.
final void	setBaseDN(Dn baseDN)	Specifies the base DN as included in the request from the client.
final void	setDerefPolicy(DereferenceAliasesPolicy derefPolicy)	Specifies the alias dereferencing policy for this search operation.
final void	setFilter(Filter filter)	Specifies the search filter as included in the request from the client.
final void	setScope(SearchScope scope)	Specifies the scope for this search operation.
final void	setTypesOnly(boolean typesOnly)	Specifies the typesOnly flag for this search operation.
boolean	timeLimitExpired()	Returns whether the search operation has reached its time limit.
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, equals, evaluateProxyAuthControls, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getClientConnection, getConnectionID, getErrorMessage, getLargestEntrySize, getMatchedDN, getMessageID, getOperationID, getProxiedAuthorizationDN, getReferralURLs, getRequestContext, getRequestControl, getRequestControls, getResultCode, hashCode, hasPrivilege, hasRequestControl, isInternalOperation, isProxyAuthzControl, isSynchronizationOperation, mustCheckSchema, operationToResult, processOperationResult, removeAllDisallowedControls, run, sendResponses, sendResult, setAttachment, setErrorMessage, setMatchedDN, setReferralURLs, setResult, setResult, setResultCode, setResultCodeAndMessageNoInfoDisclosure, toString, trySetLargestEntrySize

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, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getRequestControl, getRequestControl, getRequestControls, hasPrivilege, isInternalOperation, isSynchronizationOperation, 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, sendResponses, setErrorMessage

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

addAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, sendResponses, setErrorMessage

Constructor Details

SearchOperation

public SearchOperation(RequestContext context,
 LocalBackend<?> backend,
 SearchRequest request,
 Consumer<ResponseStream> out)

Creates a new search operation.

Parameters:

context - The context.

backend - The local backend in which this request is to be processed.

request - The request.

out - A consumer responsible for sending responses to the client.

Method Details

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.

getResourceLimits

public final ResourceLimits getResourceLimits()

Retrieves the limits for this search operation.

Specified by:

getResourceLimits in interface InProgressSearchOperation

Specified by:

getResourceLimits in interface PostOperationSearchOperation

Specified by:

getResourceLimits in interface PostResponseSearchOperation

Specified by:

getResourceLimits in interface PreOperationSearchOperation

Specified by:

getResourceLimits in interface PreParseSearchOperation

Returns:

The resource limits

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

mayReturnEntry

public boolean mayReturnEntry(Entry entry)

Returns if the entry may be returned according to access control and other checks.

Parameters:

entry - the candidate entry to return

Returns:

if the entry may be returned according to access control and other checks

timeLimitExpired

public boolean timeLimitExpired()

Returns whether the search operation has reached its time limit.

Returns:

whether the search operation has reached its time limit

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

getRequest

public SearchRequest getRequest()

Description copied from class: Operation

Returns the request associated to this operation.

Specified by:

getRequest in interface PluginOperation

Overrides:

getRequest in class Operation

Returns:

The request associated to this operation.

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 interface: PluginOperation

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.

getSimplePagedResultsControlOrNull

public SimplePagedResultsControl getSimplePagedResultsControlOrNull()

Return the Simple Paged Results Control of the search request or null if absent.

Returns:

the Simple Paged Results Control of the search request or null if absent

getServerSideSortControlOrNull

public ServerSideSortRequestControl getServerSideSortControlOrNull()

Return the Server Side Sort Control of the search request or null if absent.

Returns:

the Server Side Sort Control of the search request or null if absent

getVirtualListViewRequestControlOrNull

public VirtualListViewRequestControl getVirtualListViewRequestControlOrNull()

Return the Virtual List View Request Control of the search request or null if absent.

Returns:

the Virtual List View Request Control of the search request or null if absent

isManageDsaIt

public boolean isManageDsaIt()

Returns true if this search operation contains the ManageDsaIT control.

Returns:

true if this search operation contains the ManageDsaIT control.

runImpl

protected boolean runImpl()
                   throws LdapException

Description copied from class: Operation

Performs the work of actually processing this operation.

Specified by:

runImpl in class Operation

Returns:

true if the result should be sent immediately, or false if it will be sent later, e.g. as part of a persistent search.

Throws:

LdapException - If an error occurred when processing the operation.

invokePreParsePlugins

protected boolean invokePreParsePlugins()
                                 throws LdapException

Description copied from class: Operation

Invokes any applicable pre-parse plugins.

Specified by:

invokePreParsePlugins in class Operation

Returns:

true if processing should continue.

Throws:

LdapException - If an error occurred when invoking the pre-parse plugins.

invokePostResponsePlugins

protected void invokePostResponsePlugins()

Description copied from class: Operation

Invokes any applicable post-response plugins.

Specified by:

invokePostResponsePlugins in class Operation

handleRequestControls

protected void handleRequestControls()
                              throws LdapException

Handles any controls contained in the request.

Throws:

LdapException - If there is a problem with any of the request controls.