@PublicAPI(stability=UNCOMMITTED, mayInstantiate=true, mayExtend=false, mayInvoke=true) public final class InternalSearchOperation extends SearchOperationBasis
NO_RESPONSE_CONTROLS, requestContext
Constructor and Description |
---|
InternalSearchOperation(org.forgerock.services.context.Context context,
org.forgerock.opendj.ldap.messages.SearchRequest request,
org.opends.server.protocols.internal.InternalSearchOperation.InternalSearchListener searchListener)
Creates a new internal search operation with the provided information.
|
Modifier and Type | Method and Description |
---|---|
void |
addSearchEntry(SearchResultEntry searchEntry)
Provides the provided search result entry to the internal search listener if one was provided, or stores it in an
internal list otherwise.
|
void |
addSearchReference(SearchResultReference searchReference)
Provides the provided search result reference to the internal search listener if one was provided, or stores it
in an internal list otherwise.
|
LinkedList<SearchResultEntry> |
getSearchEntries()
Retrieves the set of search result entries returned for this search.
|
List<SearchResultReference> |
getSearchReferences()
Retrieves the set of search result references returned for this search.
|
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.
|
addResponseControl, getAttributes, getBaseDN, getDerefPolicy, getEntriesSent, getFilter, getMatchedValuesControl, getOperationType, getProxiedAuthorizationDN, getRawBaseDN, getRawFilter, getReferencesSent, getResponseControls, getScope, getSizeLimit, getTimeLimit, getTimeLimitExpiration, getTypesOnly, isClientAcceptsReferrals, isIncludeUsableControl, isRealAttributesOnly, isReturnSubentriesOnly, isSendResponse, isVirtualAttributesOnly, removeResponseControl, returnEntry, returnEntry, returnReference, returnReference, run, sendSearchResultDone, setAttributes, setBaseDN, setClientAcceptsReferrals, setDerefPolicy, setIncludeUsableControl, setMatchedValuesControl, setProxiedAuthorizationDN, setRawBaseDN, setRawFilter, setRealAttributesOnly, setReturnSubentriesOnly, setScope, setSendResponse, setSizeLimit, setTimeLimit, setTimeLimitExpiration, setTypesOnly, setVirtualAttributesOnly, toString, updateOperationErrMsgAndResCode
addAdditionalLogItem, addPostReadResponse, addPreReadResponse, addRequestControl, appendErrorMessage, appendMaskedErrorMessage, checkIfBackendIsWritable, checkIfCanceled, disconnectClient, dontSynchronize, equals, evaluateProxyAuthControls, filterNonDisclosableMatchedDN, findMatchedDN, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getClientConnection, getConnectionID, getContext, getErrorMessage, getLocalBackend, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperationID, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControl, getRequestControls, getResultCode, hashCode, invokePostResponseCallbacks, isInnerOperation, isInternalOperation, isProxyAuthzControl, isSynchronizationOperation, newDirectoryException, operationCompleted, processOperationResult, processOperationResult, registerPostResponseCallback, removeAllDisallowedControls, removeAttachment, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, setMatchedDN, setProcessingStartTime, setProcessingStopTime, setReferralURLs, setResponseData, setResult, setResultCode, setResultCodeAndMessageNoInfoDisclosure, setSynchronizationOperation, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
addAdditionalLogItem, addRequestControl, appendErrorMessage, appendMaskedErrorMessage, disconnectClient, dontSynchronize, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getClientConnection, getConnectionID, getContext, 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, setResult, setResultCode, setSynchronizationOperation, toString
addAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, setErrorMessage
addAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, setErrorMessage
addAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, setErrorMessage, setMatchedDN, setReferralURLs, setResponseData, setResultCode
getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getProcessingStopTime, getProcessingTime, getReferralURLs, getResultCode
addAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, setErrorMessage, setMatchedDN, setReferralURLs, setResponseData, setResultCode
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getProcessingStartTime, getRequestControl, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString
public InternalSearchOperation(org.forgerock.services.context.Context context, org.forgerock.opendj.ldap.messages.SearchRequest request, org.opends.server.protocols.internal.InternalSearchOperation.InternalSearchListener searchListener)
context
- The context with which this internal search operation is associated.request
- The search requestsearchListener
- The internal search listener that should be used to process the results, or null
if they
should be collected internally.public LinkedList<SearchResultEntry> getSearchEntries()
null
if a custom internal
search listener is to be used.@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public void addSearchEntry(SearchResultEntry searchEntry) throws DirectoryException
searchEntry
- The search result entry returned for this search.DirectoryException
- If a problem occurs while processing the provided entry and the search should be terminated.public List<SearchResultReference> getSearchReferences()
null
if a custom internal
search listener is to be used.@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public void addSearchReference(SearchResultReference searchReference) throws DirectoryException
searchReference
- The search result reference returned for this search.DirectoryException
- If a problem occurs while processing the provided reference and the search should be terminated.@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public void sendSearchEntry(SearchResultEntry searchEntry) throws DirectoryException
sendSearchEntry
in interface SearchOperation
sendSearchEntry
in class SearchOperationBasis
searchEntry
- The search result entry to be sent to the client.DirectoryException
- If a problem occurs while attempting to send the entry to the client and the search should be
terminated.@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public boolean sendSearchReference(SearchResultReference searchReference) throws DirectoryException
sendSearchReference
in interface SearchOperation
sendSearchReference
in class SearchOperationBasis
searchReference
- The search result reference to be sent to the client.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.DirectoryException
- If a problem occurs while attempting to send the reference to the client and the search should be
terminated.Copyright © 2010–2017 ForgeRock AS. All rights reserved.