public interface SearchOperation extends Operation
Modifier and Type | Method and Description |
---|---|
Set<String> |
getAttributes()
Retrieves the set of requested attributes for this search operation.
|
org.forgerock.opendj.ldap.Dn |
getBaseDN()
Retrieves the base DN for this search operation.
|
org.forgerock.opendj.ldap.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.
|
org.forgerock.opendj.ldap.Dn |
getProxiedAuthorizationDN()
Retrieves the proxied authorization DN for this operation if proxied authorization has been requested.
|
org.forgerock.opendj.ldap.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.
|
org.forgerock.opendj.ldap.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.
|
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 |
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 |
returnReference(org.forgerock.opendj.ldap.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.
|
boolean |
returnReference(org.forgerock.opendj.ldap.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 |
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(org.forgerock.opendj.ldap.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(org.forgerock.opendj.ldap.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(org.forgerock.opendj.ldap.Dn proxiedAuthorizationDN)
Set the proxied authorization DN for this operation if proxied authorization has been requested.
|
void |
setRawBaseDN(org.forgerock.opendj.ldap.ByteString rawBaseDN)
Specifies the raw, unprocessed base DN as included in the request from the client.
|
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(org.forgerock.opendj.ldap.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.
|
addAdditionalLogItem, addRequestControl, addResponseControl, appendErrorMessage, appendMaskedErrorMessage, disconnectClient, dontSynchronize, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getClientConnection, getConnectionID, getContext, getErrorMessage, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperationID, getOperationType, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControl, getRequestControls, getResponseControls, getResultCode, isInnerOperation, isInternalOperation, isSynchronizationOperation, operationCompleted, registerPostResponseCallback, removeAttachment, removeResponseControl, run, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, setMatchedDN, setReferralURLs, setResponseData, setResult, setResultCode, setSynchronizationOperation, toString, toString
org.forgerock.opendj.ldap.ByteString getRawBaseDN()
void setRawBaseDN(org.forgerock.opendj.ldap.ByteString rawBaseDN)
rawBaseDN
- The raw, unprocessed base DN as included in the request from the client.org.forgerock.opendj.ldap.Dn getBaseDN()
getRawBaseDN
method.null
if the raw base DN has not yet been
processed.void setBaseDN(org.forgerock.opendj.ldap.Dn baseDN)
baseDN
- The base DN for this search operation.org.forgerock.opendj.ldap.SearchScope getScope()
void setScope(org.forgerock.opendj.ldap.SearchScope scope)
scope
- The scope for this search operation.org.forgerock.opendj.ldap.DereferenceAliasesPolicy getDerefPolicy()
void setDerefPolicy(org.forgerock.opendj.ldap.DereferenceAliasesPolicy derefPolicy)
derefPolicy
- The alias dereferencing policy for this search operation.int getSizeLimit()
void setSizeLimit(int sizeLimit)
sizeLimit
- The size limit for this search operation.int getTimeLimit()
long getTimeLimitExpiration()
void setTimeLimit(int timeLimit)
timeLimit
- The time limit for this search operation.boolean getTypesOnly()
void setTypesOnly(boolean typesOnly)
typesOnly
- The typesOnly flag for this search operation.RawFilter getRawFilter()
void setRawFilter(RawFilter rawFilter)
rawFilter
- The raw, unprocessed search filter as included in the request from the client.SearchFilter getFilter()
null
if the raw filter has not yet been processed.Set<String> getAttributes()
void setAttributes(Set<String> attributes)
attributes
- The set of requested attributes for this search operation.int getEntriesSent()
int getReferencesSent()
boolean returnEntry(Entry entry, List<Control> controls)
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).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).boolean returnEntry(Entry entry, List<Control> controls, boolean evaluateAci)
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.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).boolean returnReference(org.forgerock.opendj.ldap.Dn dn, SearchResultReference reference)
reference
- The search reference to send to the client.dn
- The DN related to the specified search reference.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).boolean returnReference(org.forgerock.opendj.ldap.Dn dn, SearchResultReference reference, boolean evaluateAci)
reference
- The search reference to send to the client.dn
- The DN related to the specified search reference.evaluateAci
- Indicates whether the access rights to the entry should be evaluated.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).void sendSearchResultDone()
void setTimeLimitExpiration(long timeLimitExpiration)
timeLimitExpiration
- - Time after which the search has expiredboolean isReturnSubentriesOnly()
void setReturnSubentriesOnly(boolean returnLDAPSubentries)
returnLDAPSubentries
- - Boolean indicating whether the LDAP subentries should be returned or notMatchedValuesControl getMatchedValuesControl()
void setMatchedValuesControl(MatchedValuesControl controls)
controls
- - The matched values controlboolean isIncludeUsableControl()
void setIncludeUsableControl(boolean includeUsableControl)
includeUsableControl
- - True if the account usable response control has to be included within the search result entries,
false otherwiseboolean isClientAcceptsReferrals()
void setClientAcceptsReferrals(boolean clientAcceptReferrals)
clientAcceptReferrals
- - Boolean set to true if the client can handle referralsboolean isSendResponse()
void setSendResponse(boolean sendResponse)
sendResponse
- - boolean indicating whether the search result done message is to send to the clientboolean isRealAttributesOnly()
void setRealAttributesOnly(boolean realAttributesOnly)
realAttributesOnly
- - boolean setup to true, if only the real attributes should be returnedboolean isVirtualAttributesOnly()
void setVirtualAttributesOnly(boolean virtualAttributesOnly)
virtualAttributesOnly
- - boolean setup to true, if only the virtual attributes should be returnedvoid sendSearchEntry(SearchResultEntry entry) throws DirectoryException
entry
- 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.boolean sendSearchReference(SearchResultReference reference) throws DirectoryException
reference
- 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.org.forgerock.opendj.ldap.Dn getProxiedAuthorizationDN()
getProxiedAuthorizationDN
in interface Operation
null
if proxied authorization has not been requested.void setProxiedAuthorizationDN(org.forgerock.opendj.ldap.Dn proxiedAuthorizationDN)
setProxiedAuthorizationDN
in interface Operation
proxiedAuthorizationDN
- The proxied authorization DN for this operation if proxied authorization has been requested, or
null
if proxied authorization has not been requested.Copyright © 2010–2017 ForgeRock AS. All rights reserved.