Package org.opends.server.core

Class SearchOperationBasis

java.lang.Object

org.opends.server.types.AbstractOperation

org.opends.server.core.SearchOperationBasis

All Implemented Interfaces:

Runnable, SearchOperation, Operation, InProgressOperation, PluginOperation, PostResponseOperation, PostResponseSearchOperation, PreParseOperation, PreParseSearchOperation, SearchEntrySearchOperation, SearchReferenceSearchOperation

Direct Known Subclasses:

InternalSearchOperation

public class SearchOperationBasis
extends AbstractOperation
implements PreParseSearchOperation, PostResponseSearchOperation, SearchEntrySearchOperation, SearchReferenceSearchOperation, SearchOperation

This class defines an operation that may be used to locate entries in the Directory Server based on a given set of criteria.

Field Summary

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

cancelRequest, cancelResult, clientConnection, messageID, NO_RESPONSE_CONTROLS, operationID

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

LOCALBACKENDOPERATIONS

Constructor Summary

Constructors

Constructor	Description
SearchOperationBasis(ClientConnection clientConnection, long operationID, int messageID, List<Control> requestControls, ByteString rawBaseDN, SearchScope scope, DereferenceAliasesPolicy derefPolicy, int sizeLimit, int timeLimit, boolean typesOnly, RawFilter rawFilter, Set<String> attributes)	Creates a new search operation with the provided information.
SearchOperationBasis(ClientConnection clientConnection, long operationID, int messageID, List<Control> requestControls, DN baseDN, SearchScope scope, DereferenceAliasesPolicy derefPolicy, int sizeLimit, int timeLimit, boolean typesOnly, SearchFilter filter, Set<String> attributes)	Creates a new search operation with the provided information.

Method Summary

Modifier and Type	Method	Description
void	abort(CancelRequest cancelRequest)	Attempts to abort this operation before processing has completed.
void	addResponseControl(Control control)	Adds the provided control to the set of controls to include in the response to the client.
void	endSearchPhase()	Indicates that the search phase is over and that any further entry comes from a persistent search.
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.
SearchFilter	getFilter()	Retrieves the filter for this search operation.
MatchedValuesControl	getMatchedValuesControl()	The matched values control associated with 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.
ByteString	getRawBaseDN()	Retrieves the raw, unprocessed base DN as included in the request from the client.
RawFilter	getRawFilter()	Retrieves the raw, unprocessed search filter as included in the request from the client.
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.
long	getTimeLimitExpiration()	Get the time after which the search time limit has expired.
boolean	getTypesOnly()	Retrieves the typesOnly flag for this search operation.
boolean	isClientAcceptsReferrals()	Indicates whether the client is able to handle referrals.
boolean	isIncludeUsableControl()	Indicates whether to include the account usable response control with search result entries or not.
boolean	isRealAttributesOnly()	Returns true if only real attributes should be returned.
boolean	isReturnSubentriesOnly()	Indicates whether LDAP subentries should be returned or not.
boolean	isSendResponse()	Indicates whether the search result done message has to be sent to the client, or not.
boolean	isVirtualAttributesOnly()	Returns true if only virtual attributes should be returned.
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)	Returns the provided entry to the client.
boolean	returnEntry(Entry entry, List<Control> controls, boolean evaluateAci)	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	returnPersistentSearchEntry(Entry entry, List<Control> controls)	Used as a callback for persistent searches to send an entry which has just changed to the client.
boolean	returnReference(DN dn, SearchResultReference reference)	Returns the provided search result reference to the client.
boolean	returnReference(DN dn, SearchResultReference reference, boolean evaluateAci)	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 searchEntry)	Sends the provided search result entry to the client.
boolean	sendSearchReference(SearchResultReference searchReference)	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 for this search operation.
void	setClientAcceptsReferrals(boolean clientAcceptReferrals)	Specify whether the client is able to handle referrals.
void	setDerefPolicy(DereferenceAliasesPolicy derefPolicy)	Specifies the alias dereferencing policy for this search operation.
void	setIncludeUsableControl(boolean includeUsableControl)	Specify whether to include the account usable response control within the search result entries.
void	setMatchedValuesControl(MatchedValuesControl controls)	Set the match values control.
void	setProxiedAuthorizationDN(DN proxiedAuthorizationDN)	Set the proxied authorization DN for this operation if proxied authorization has been requested.
void	setRawBaseDN(ByteString rawBaseDN)	Specifies the raw, unprocessed base DN for this search operation.
void	setRawFilter(RawFilter rawFilter)	Specifies the raw, unprocessed search filter as included in the request from the client.
void	setRealAttributesOnly(boolean realAttributesOnly)	Specify whether to only return real attributes.
void	setReturnSubentriesOnly(boolean returnLDAPSubentries)	Set the flag indicating whether the LDAP subentries should be returned.
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	setTimeLimitExpiration(long timeLimitExpiration)	Set the time after which the search time limit has expired.
void	setTypesOnly(boolean typesOnly)	Specifies the typesOnly flag for this search operation.
void	setVirtualAttributesOnly(boolean virtualAttributesOnly)	Specify whether to only return virtual attributes.
void	toString(StringBuilder buffer)	Appends a string representation of this operation to the provided buffer.
void	updateOperationErrMsgAndResCode()	Updates the error message and the result code of the operation.

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

addAdditionalLogItem, addRequestControl, appendErrorMessage, appendMaskedErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, equals, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getConnectionID, getErrorMessage, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperationID, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControl, getRequestControls, getResultCode, getTransactionId, hashCode, invokePostResponseCallbacks, isInnerOperation, isInternalOperation, isSynchronizationOperation, operationCompleted, processOperationResult, processOperationResult, registerPostResponseCallback, removeAttachment, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, setMatchedDN, setProcessingStartTime, setProcessingStopTime, 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, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, setErrorMessage, setMatchedDN, setReferralURLs, setResponseData, setResultCode

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

addAdditionalLogItem, addRequestControl, appendErrorMessage, appendMaskedErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getConnectionID, getErrorMessage, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperationID, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControl, getRequestControls, getResultCode, isInnerOperation, isInternalOperation, isSynchronizationOperation, operationCompleted, registerPostResponseCallback, removeAttachment, 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, getProcessingStartTime, getRequestControl, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString

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

addAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, setErrorMessage

Constructor Detail

SearchOperationBasis

public SearchOperationBasis(ClientConnection clientConnection,
                            long operationID,
                            int messageID,
                            List<Control> requestControls,
                            ByteString rawBaseDN,
                            SearchScope scope,
                            DereferenceAliasesPolicy derefPolicy,
                            int sizeLimit,
                            int timeLimit,
                            boolean typesOnly,
                            RawFilter rawFilter,
                            Set<String> attributes)

Creates a new search operation with the provided information.

Parameters:

clientConnection - The client connection with which this operation is associated.

operationID - The operation ID for this operation.

messageID - The message ID of the request with which this operation is associated.

requestControls - The set of controls included in the request.

rawBaseDN - The raw, unprocessed base DN as included in the request from the client.

scope - The scope for this search operation.

derefPolicy - The alias dereferencing policy for this search operation.

sizeLimit - The size limit for this search operation.

timeLimit - The time limit for this search operation.

typesOnly - The typesOnly flag for this search operation.

rawFilter - the raw, unprocessed filter as included in the request from the client.

attributes - The requested attributes for this search operation.

SearchOperationBasis

public SearchOperationBasis(ClientConnection clientConnection,
                            long operationID,
                            int messageID,
                            List<Control> requestControls,
                            DN baseDN,
                            SearchScope scope,
                            DereferenceAliasesPolicy derefPolicy,
                            int sizeLimit,
                            int timeLimit,
                            boolean typesOnly,
                            SearchFilter filter,
                            Set<String> attributes)

Creates a new search operation with the provided information.

Parameters:

clientConnection - The client connection with which this operation is associated.

operationID - The operation ID for this operation.

messageID - The message ID of the request with which this operation is associated.

requestControls - The set of controls included in the request.

baseDN - The base DN for this search operation.

scope - The scope for this search operation.

derefPolicy - The alias dereferencing policy for this search operation.

sizeLimit - The size limit for this search operation.

timeLimit - The time limit for this search operation.

typesOnly - The typesOnly flag for this search operation.

filter - The filter for this search operation.

attributes - The attributes for this search operation.

Method Detail

getRawBaseDN

public final ByteString getRawBaseDN()

Description copied from interface: PreParseSearchOperation

Retrieves the raw, unprocessed base DN as included in the request from the client. This may or may not contain a valid DN, as no validation will have been performed.

Specified by:

getRawBaseDN in interface PostResponseSearchOperation

Specified by:

getRawBaseDN in interface PreParseSearchOperation

Specified by:

getRawBaseDN in interface SearchEntrySearchOperation

Specified by:

getRawBaseDN in interface SearchOperation

Specified by:

getRawBaseDN in interface SearchReferenceSearchOperation

Returns:

The raw, unprocessed base DN as included in the request from the client.

setRawBaseDN

public final void setRawBaseDN(ByteString rawBaseDN)

Description copied from interface: PreParseSearchOperation

Specifies the raw, unprocessed base DN for this search operation.

Specified by:

setRawBaseDN in interface PreParseSearchOperation

Specified by:

setRawBaseDN in interface SearchOperation

Parameters:

rawBaseDN - The raw, unprocessed base DN for this search operation.

getBaseDN

public final DN getBaseDN()

Description copied from interface: PostResponseSearchOperation

Retrieves the base DN for this search operation.

Specified by:

getBaseDN in interface PostResponseSearchOperation

Specified by:

getBaseDN in interface SearchEntrySearchOperation

Specified by:

getBaseDN in interface SearchOperation

Specified by:

getBaseDN in interface SearchReferenceSearchOperation

Returns:

The base DN for this search operation.

setBaseDN

public final void setBaseDN(DN baseDN)

Description copied from interface: SearchOperation

Specifies the base DN for this search operation. This method is only intended for internal use.

Specified by:

setBaseDN in interface SearchOperation

Parameters:

baseDN - The base DN for this search operation.

getScope

public final SearchScope getScope()

Description copied from interface: PreParseSearchOperation

Retrieves the scope for this search operation.

Specified by:

getScope in interface PostResponseSearchOperation

Specified by:

getScope in interface PreParseSearchOperation

Specified by:

getScope in interface SearchEntrySearchOperation

Specified by:

getScope in interface SearchOperation

Specified by:

getScope in interface SearchReferenceSearchOperation

Returns:

The scope for this search operation.

setScope

public final void setScope(SearchScope scope)

Description copied from interface: PreParseSearchOperation

Specifies the scope for this search operation.

Specified by:

setScope in interface PreParseSearchOperation

Specified by:

setScope in interface SearchOperation

Parameters:

scope - The scope for this search operation.

getDerefPolicy

public final DereferenceAliasesPolicy getDerefPolicy()

Description copied from interface: PreParseSearchOperation

Retrieves the alias dereferencing policy for this search operation.

Specified by:

getDerefPolicy in interface PostResponseSearchOperation

Specified by:

getDerefPolicy in interface PreParseSearchOperation

Specified by:

getDerefPolicy in interface SearchEntrySearchOperation

Specified by:

getDerefPolicy in interface SearchOperation

Specified by:

getDerefPolicy in interface SearchReferenceSearchOperation

Returns:

The alias dereferencing policy for this search operation.

setDerefPolicy

public final void setDerefPolicy(DereferenceAliasesPolicy derefPolicy)

Description copied from interface: PreParseSearchOperation

Specifies the alias dereferencing policy for this search operation.

Specified by:

setDerefPolicy in interface PreParseSearchOperation

Specified by:

setDerefPolicy in interface SearchOperation

Parameters:

derefPolicy - The alias dereferencing policy for this search operation.

getSizeLimit

public final int getSizeLimit()

Description copied from interface: PreParseSearchOperation

Retrieves the size limit for this search operation.

Specified by:

getSizeLimit in interface PostResponseSearchOperation

Specified by:

getSizeLimit in interface PreParseSearchOperation

Specified by:

getSizeLimit in interface SearchEntrySearchOperation

Specified by:

getSizeLimit in interface SearchOperation

Specified by:

getSizeLimit in interface SearchReferenceSearchOperation

Returns:

The size limit for this search operation.

setSizeLimit

public final void setSizeLimit(int sizeLimit)

Description copied from interface: PreParseSearchOperation

Specifies the size limit for this search operation.

Specified by:

setSizeLimit in interface PreParseSearchOperation

Specified by:

setSizeLimit in interface SearchOperation

Parameters:

sizeLimit - The size limit for this search operation.

getTimeLimit

public final int getTimeLimit()

Description copied from interface: PreParseSearchOperation

Retrieves the time limit for this search operation.

Specified by:

getTimeLimit in interface PostResponseSearchOperation

Specified by:

getTimeLimit in interface PreParseSearchOperation

Specified by:

getTimeLimit in interface SearchEntrySearchOperation

Specified by:

getTimeLimit in interface SearchOperation

Specified by:

getTimeLimit in interface SearchReferenceSearchOperation

Returns:

The time limit for this search operation.

setTimeLimit

public final void setTimeLimit(int timeLimit)

Description copied from interface: PreParseSearchOperation

Specifies the time limit for this search operation.

Specified by:

setTimeLimit in interface PreParseSearchOperation

Specified by:

setTimeLimit in interface SearchOperation

Parameters:

timeLimit - The time limit for this search operation.

getTypesOnly

public final boolean getTypesOnly()

Description copied from interface: PreParseSearchOperation

Retrieves the typesOnly flag for this search operation.

Specified by:

getTypesOnly in interface PostResponseSearchOperation

Specified by:

getTypesOnly in interface PreParseSearchOperation

Specified by:

getTypesOnly in interface SearchEntrySearchOperation

Specified by:

getTypesOnly in interface SearchOperation

Specified by:

getTypesOnly in interface SearchReferenceSearchOperation

Returns:

The typesOnly flag for this search operation.

setTypesOnly

public final void setTypesOnly(boolean typesOnly)

Description copied from interface: PreParseSearchOperation

Specifies the typesOnly flag for this search operation.

Specified by:

setTypesOnly in interface PreParseSearchOperation

Specified by:

setTypesOnly in interface SearchOperation

Parameters:

typesOnly - The typesOnly flag for this search operation.

getRawFilter

public final RawFilter getRawFilter()

Description copied from interface: PreParseSearchOperation

Retrieves the raw, unprocessed search filter as included in the request from the client. It may or may not contain a valid filter (e.g., unsupported attribute types or values with an invalid syntax) because no validation will have been performed on it.

Specified by:

getRawFilter in interface PostResponseSearchOperation

Specified by:

getRawFilter in interface PreParseSearchOperation

Specified by:

getRawFilter in interface SearchEntrySearchOperation

Specified by:

getRawFilter in interface SearchOperation

Specified by:

getRawFilter in interface SearchReferenceSearchOperation

Returns:

The raw, unprocessed search filter as included in the request from the client.

setRawFilter

public final void setRawFilter(RawFilter rawFilter)

Description copied from interface: PreParseSearchOperation

Specifies the raw, unprocessed search filter as included in the request from the client.

Specified by:

setRawFilter in interface PreParseSearchOperation

Specified by:

setRawFilter in interface SearchOperation

Parameters:

rawFilter - The raw, unprocessed search filter.

getFilter

public final SearchFilter getFilter()

Description copied from interface: PostResponseSearchOperation

Retrieves the filter for this search operation.

Specified by:

getFilter in interface PostResponseSearchOperation

Specified by:

getFilter in interface SearchEntrySearchOperation

Specified by:

getFilter in interface SearchOperation

Specified by:

getFilter in interface SearchReferenceSearchOperation

Returns:

The filter for this search operation.

getAttributes

public final Set<String> getAttributes()

Description copied from interface: PreParseSearchOperation

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

Specified by:

getAttributes in interface PostResponseSearchOperation

Specified by:

getAttributes in interface PreParseSearchOperation

Specified by:

getAttributes in interface SearchEntrySearchOperation

Specified by:

getAttributes in interface SearchOperation

Specified by:

getAttributes in interface SearchReferenceSearchOperation

Returns:

The set of requested attributes for this search operation.

setAttributes

public final void setAttributes(Set<String> attributes)

Description copied from interface: PreParseSearchOperation

Specifies the set of requested attributes for this search operation.

Specified by:

setAttributes in interface PreParseSearchOperation

Specified by:

setAttributes in interface SearchOperation

Parameters:

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

getEntriesSent

public final int getEntriesSent()

Description copied from interface: PostResponseSearchOperation

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

Specified by:

getEntriesSent in interface PostResponseSearchOperation

Specified by:

getEntriesSent in interface SearchOperation

Returns:

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

getReferencesSent

public final int getReferencesSent()

Description copied from interface: PostResponseSearchOperation

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

Specified by:

getReferencesSent in interface PostResponseSearchOperation

Specified by:

getReferencesSent in interface SearchOperation

Returns:

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

returnEntry

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

Description copied from interface: PreParseSearchOperation

Returns the provided entry to the client.

Specified by:

returnEntry in interface PreParseSearchOperation

Specified by:

returnEntry in interface SearchOperation

Parameters:

entry - The entry that should be returned.

controls - The set of controls to include with the entry (may be null if no controls should be included with the entry).

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

endSearchPhase

public final void endSearchPhase()

Description copied from interface: SearchOperation

Indicates that the search phase is over and that any further entry comes from a persistent search. State kept to dereference aliases during the search phase is released. Entries can still reach SearchOperation.returnEntry(Entry, List) afterwards, as backends are free to report their own results from another thread, so that method keeps track of this phase being over.

Specified by:

endSearchPhase in interface SearchOperation

returnEntry

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

Description copied from interface: SearchOperation

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 SearchOperation

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

evaluateAci - Indicates whether the access rights to the entry should be evaluated.

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

returnPersistentSearchEntry

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

Description copied from interface: SearchOperation

Used as a callback for persistent searches to send an entry which has just changed to the client. Contrary to SearchOperation.returnEntry(Entry, List), the entry is not matched against the state kept to dereference aliases during the search phase, and neither the size limit nor the time limit of the search applies to it: a persistent search must report every change it is notified of, for as long as it is alive, whether or not the entry was returned before.

Specified by:

returnPersistentSearchEntry in interface SearchOperation

Parameters:

entry - The entry which has changed 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 persistent search should keep reporting changes, or false if it should stop for some reason (e.g. the search has been abandoned).

returnReference

public final boolean returnReference(DN dn,
                                     SearchResultReference reference)

Description copied from interface: PreParseSearchOperation

Returns the provided search result reference to the client.

Specified by:

returnReference in interface PreParseSearchOperation

Specified by:

returnReference in interface SearchOperation

Parameters:

dn - A DN related to the specified search reference.

reference - The search reference that should be returned.

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 final boolean returnReference(DN dn,
                                     SearchResultReference reference,
                                     boolean evaluateAci)

Description copied from interface: SearchOperation

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 SearchOperation

Parameters:

dn - The DN related to the specified search reference.

reference - The search reference to send to the client.

evaluateAci - Indicates whether the access rights to the entry should be evaluated.

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 final void sendSearchResultDone()

Description copied from interface: SearchOperation

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.

Specified by:

sendSearchResultDone in interface SearchOperation

getOperationType

public final OperationType getOperationType()

Description copied from interface: PluginOperation

Retrieves the operation type for this operation.

Specified by:

getOperationType in interface Operation

Specified by:

getOperationType in interface PluginOperation

Returns:

The operation type for this operation.

getProxiedAuthorizationDN

public DN getProxiedAuthorizationDN()

Description copied from interface: SearchOperation

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

Specified by:

getProxiedAuthorizationDN in interface Operation

Specified by:

getProxiedAuthorizationDN in interface SearchOperation

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 Operation

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

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

Specified by:

addResponseControl in interface InProgressOperation

Specified by:

addResponseControl in interface Operation

Specified by:

addResponseControl in interface PreParseOperation

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

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

Specified by:

removeResponseControl in interface InProgressOperation

Specified by:

removeResponseControl in interface Operation

Specified by:

removeResponseControl in interface PreParseOperation

Parameters:

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

abort

public void abort(CancelRequest cancelRequest)

Description copied from interface: Operation

Attempts to abort this operation before processing has completed.

Specified by:

abort in interface Operation

Overrides:

abort in class AbstractOperation

Parameters:

cancelRequest - Information about the way in which the operation should be canceled.

toString

public final 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 Operation

Specified by:

toString in interface PluginOperation

Parameters:

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

setTimeLimitExpiration

public void setTimeLimitExpiration(long timeLimitExpiration)

Description copied from interface: SearchOperation

Set the time after which the search time limit has expired.

Specified by:

setTimeLimitExpiration in interface SearchOperation

Parameters:

timeLimitExpiration - - Time after which the search has expired

isReturnSubentriesOnly

public boolean isReturnSubentriesOnly()

Description copied from interface: SearchOperation

Indicates whether LDAP subentries should be returned or not.

Specified by:

isReturnSubentriesOnly in interface SearchOperation

Returns:

true if the LDAP subentries should be returned, false otherwise

setReturnSubentriesOnly

public void setReturnSubentriesOnly(boolean returnLDAPSubentries)

Description copied from interface: SearchOperation

Set the flag indicating whether the LDAP subentries should be returned.

Specified by:

setReturnSubentriesOnly in interface SearchOperation

Parameters:

returnLDAPSubentries - - Boolean indicating whether the LDAP subentries should be returned or not

getMatchedValuesControl

public MatchedValuesControl getMatchedValuesControl()

Description copied from interface: SearchOperation

The matched values control associated with this search operation.

Specified by:

getMatchedValuesControl in interface SearchOperation

Returns:

the match values control

setMatchedValuesControl

public void setMatchedValuesControl(MatchedValuesControl controls)

Description copied from interface: SearchOperation

Set the match values control.

Specified by:

setMatchedValuesControl in interface SearchOperation

Parameters:

controls - - The matched values control

isIncludeUsableControl

public boolean isIncludeUsableControl()

Description copied from interface: SearchOperation

Indicates whether to include the account usable response control with search result entries or not.

Specified by:

isIncludeUsableControl in interface SearchOperation

Returns:

true if the usable control has to be part of the search result entry

setIncludeUsableControl

public void setIncludeUsableControl(boolean includeUsableControl)

Description copied from interface: SearchOperation

Specify whether to include the account usable response control within the search result entries.

Specified by:

setIncludeUsableControl in interface SearchOperation

Parameters:

includeUsableControl - - True if the account usable response control has to be included within the search result entries, false otherwise

getTimeLimitExpiration

public long getTimeLimitExpiration()

Description copied from interface: SearchOperation

Get the time after which the search time limit has expired.

Specified by:

getTimeLimitExpiration in interface SearchOperation

Returns:

the timeLimitExpiration

isClientAcceptsReferrals

public boolean isClientAcceptsReferrals()

Description copied from interface: SearchOperation

Indicates whether the client is able to handle referrals.

Specified by:

isClientAcceptsReferrals in interface SearchOperation

Returns:

true, if the client is able to handle referrals

setClientAcceptsReferrals

public void setClientAcceptsReferrals(boolean clientAcceptReferrals)

Description copied from interface: SearchOperation

Specify whether the client is able to handle referrals.

Specified by:

setClientAcceptsReferrals in interface SearchOperation

Parameters:

clientAcceptReferrals - - Boolean set to true if the client can handle referrals

isSendResponse

public boolean isSendResponse()

Description copied from interface: SearchOperation

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

Specified by:

isSendResponse in interface SearchOperation

Returns:

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

setSendResponse

public void setSendResponse(boolean sendResponse)

Description copied from interface: SearchOperation

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

Specified by:

setSendResponse in interface SearchOperation

Parameters:

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

isRealAttributesOnly

public boolean isRealAttributesOnly()

Description copied from interface: SearchOperation

Returns true if only real attributes should be returned.

Specified by:

isRealAttributesOnly in interface SearchOperation

Returns:

true if only real attributes should be returned, false otherwise

isVirtualAttributesOnly

public boolean isVirtualAttributesOnly()

Description copied from interface: SearchOperation

Returns true if only virtual attributes should be returned.

Specified by:

isVirtualAttributesOnly in interface SearchOperation

Returns:

true if only virtual attributes should be returned, false otherwise

setRealAttributesOnly

public void setRealAttributesOnly(boolean realAttributesOnly)

Description copied from interface: SearchOperation

Specify whether to only return real attributes.

Specified by:

setRealAttributesOnly in interface SearchOperation

Parameters:

realAttributesOnly - - boolean setup to true, if only the real attributes should be returned

setVirtualAttributesOnly

public void setVirtualAttributesOnly(boolean virtualAttributesOnly)

Description copied from interface: SearchOperation

Specify whether to only return virtual attributes.

Specified by:

setVirtualAttributesOnly in interface SearchOperation

Parameters:

virtualAttributesOnly - - boolean setup to true, if only the virtual attributes should be returned

sendSearchEntry

public void sendSearchEntry(SearchResultEntry searchEntry)
                     throws DirectoryException

Description copied from interface: SearchOperation

Sends the provided search result entry to the client.

Specified by:

sendSearchEntry in interface SearchOperation

Parameters:

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

Throws:

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

sendSearchReference

public boolean sendSearchReference(SearchResultReference searchReference)
                            throws DirectoryException

Description copied from interface: SearchOperation

Sends the provided search result reference to the client.

Specified by:

sendSearchReference in interface SearchOperation

Parameters:

searchReference - 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:

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

setProxiedAuthorizationDN

public void setProxiedAuthorizationDN(DN proxiedAuthorizationDN)

Description copied from interface: SearchOperation

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

Specified by:

setProxiedAuthorizationDN in interface Operation

Specified by:

setProxiedAuthorizationDN in interface SearchOperation

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 final void run()

Description copied from interface: 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 Operation

Specified by:

run in interface Runnable

updateOperationErrMsgAndResCode

public void updateOperationErrMsgAndResCode()

Description copied from class: AbstractOperation

Updates the error message and the result code of the operation. This method is called because no workflows were found to process the operation.

Overrides:

updateOperationErrMsgAndResCode in class AbstractOperation