|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.types.AbstractOperation
org.opends.server.core.SearchOperationBasis
org.opends.server.protocols.internal.InternalSearchOperation
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=true, mayExtend=false, mayInvoke=true) public final class InternalSearchOperation
This class defines a subclass of the core search operation that is to be used for internal searches. The primary difference between this class and the core search operation is that the search entries and references will be queued in memory rather than sent to a client since there is no real client.
Field Summary |
---|
Fields inherited from class org.opends.server.types.AbstractOperation |
---|
cancelRequest, cancelResult, clientConnection, messageID, NO_RESPONSE_CONTROLS, operationID, useNanoTime |
Fields inherited from interface org.opends.server.types.Operation |
---|
LOCALBACKENDOPERATIONS |
Constructor Summary | |
---|---|
InternalSearchOperation(ClientConnection internalConnection,
long operationID,
int messageID,
java.util.List<Control> requestControls,
ByteString rawBaseDN,
SearchScope scope,
DereferencePolicy derefPolicy,
int sizeLimit,
int timeLimit,
boolean typesOnly,
RawFilter rawFilter,
java.util.LinkedHashSet<java.lang.String> attributes,
InternalSearchListener searchListener)
Creates a new internal search operation with the provided information. |
|
InternalSearchOperation(ClientConnection internalConnection,
long operationID,
int messageID,
java.util.List<Control> requestControls,
DN baseDN,
SearchScope scope,
DereferencePolicy derefPolicy,
int sizeLimit,
int timeLimit,
boolean typesOnly,
SearchFilter filter,
java.util.LinkedHashSet<java.lang.String> attributes,
InternalSearchListener searchListener)
Creates a new internal search operation with the provided information. |
Method Summary | |
---|---|
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. |
java.util.LinkedList<SearchResultEntry> |
getSearchEntries()
Retrieves the set of search result entries returned for this search. |
java.util.LinkedList<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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.opends.server.types.operation.PreParseOperation |
---|
addRequestControl, appendAdditionalLogMessage, appendErrorMessage, getAdditionalLogMessage, getErrorMessage, removeRequestControl, setAdditionalLogMessage, setErrorMessage |
Methods inherited from interface org.opends.server.types.operation.PostResponseOperation |
---|
getAdditionalLogMessage, getAuthorizationDN, getErrorMessage, getMatchedDN, getProcessingStopTime, getProcessingTime, getReferralURLs, getResultCode |
Methods inherited from interface org.opends.server.types.operation.InProgressOperation |
---|
appendAdditionalLogMessage, appendErrorMessage, getAdditionalLogMessage, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, setAdditionalLogMessage, setErrorMessage, setMatchedDN, setReferralURLs, setResponseData, setResultCode |
Methods inherited from interface org.opends.server.types.operation.PluginOperation |
---|
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getProcessingStartTime, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString |
Constructor Detail |
---|
public InternalSearchOperation(ClientConnection internalConnection, long operationID, int messageID, java.util.List<Control> requestControls, ByteString rawBaseDN, SearchScope scope, DereferencePolicy derefPolicy, int sizeLimit, int timeLimit, boolean typesOnly, RawFilter rawFilter, java.util.LinkedHashSet<java.lang.String> attributes, InternalSearchListener searchListener)
internalConnection
- The internal client connection with
which this internal search operation
is associated.operationID
- The operation ID for this internal
search.messageID
- The message ID for this internal
search.requestControls
- The set of request controls for this
internal search.rawBaseDN
- The raw base DN for this internal
search.scope
- The scope for this internal search.derefPolicy
- The alias dereferencing policy for
this internal search.sizeLimit
- The size limit for this internal
search.timeLimit
- The time limit for this internal
search.typesOnly
- The typesOnly flag for this internal
search.rawFilter
- The raw filter for this internal
search.attributes
- The names of the requested attributes
for this internal search.searchListener
- The internal search listener that
should be used to process the
results, or null
if
they should be collected internally.public InternalSearchOperation(ClientConnection internalConnection, long operationID, int messageID, java.util.List<Control> requestControls, DN baseDN, SearchScope scope, DereferencePolicy derefPolicy, int sizeLimit, int timeLimit, boolean typesOnly, SearchFilter filter, java.util.LinkedHashSet<java.lang.String> attributes, InternalSearchListener searchListener)
internalConnection
- The internal client connection with
which this internal search operation
is associated.operationID
- The operation ID for this internal
search.messageID
- The message ID for this internal
search.requestControls
- The set of request controls for this
internal search.baseDN
- The base DN for this internal search.scope
- The scope for this internal search.derefPolicy
- The alias dereferencing policy for
this internal search.sizeLimit
- The size limit for this internal
search.timeLimit
- The time limit for this internal
search.typesOnly
- The typesOnly flag for this internal
search.filter
- The filter for this internal search.attributes
- The names of the requested attributes
for this internal search.searchListener
- The internal search listener that
should be used to process the
results, or null
if
they should be collected internally.Method Detail |
---|
public java.util.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 java.util.LinkedList<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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |