public abstract class SearchOperationWrapper extends OperationWrapper<SearchOperation> implements SearchOperation
LOCALBACKENDOPERATIONS
Modifier | Constructor and Description |
---|---|
protected |
SearchOperationWrapper(SearchOperation search)
Creates a new search operation based on the provided search 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.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 |
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.
|
String |
toString()
Retrieves a string representation of this operation.
|
abort, addAdditionalLogItem, addRequestControl, addResponseControl, appendErrorMessage, appendMaskedErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, equals, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getConnectionID, getErrorMessage, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperation, getOperationID, getOperationType, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getProxiedAuthorizationDN, getReferralURLs, getRequestControl, getRequestControls, getResponseControls, getResultCode, hashCode, isInnerOperation, isInternalOperation, isSynchronizationOperation, operationCompleted, registerPostResponseCallback, removeAttachment, removeResponseControl, run, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, setMatchedDN, setProxiedAuthorizationDN, setReferralURLs, setResponseData, setResultCode, setSynchronizationOperation, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getProxiedAuthorizationDN, setProxiedAuthorizationDN
abort, addAdditionalLogItem, addRequestControl, addResponseControl, appendErrorMessage, appendMaskedErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getConnectionID, 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, setResultCode, setSynchronizationOperation, toString
protected SearchOperationWrapper(SearchOperation search)
search
- The search operation to wrappublic boolean returnEntry(Entry entry, List<Control> controls)
SearchOperation
returnEntry
in interface SearchOperation
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).public boolean returnEntry(Entry entry, List<Control> controls, boolean evaluateAci)
SearchOperation
returnEntry
in interface SearchOperation
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).public boolean returnReference(org.forgerock.opendj.ldap.Dn dn, SearchResultReference reference)
SearchOperation
returnReference
in interface SearchOperation
dn
- The DN related to the specified search reference.reference
- The search reference to send to the client.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).public boolean returnReference(org.forgerock.opendj.ldap.Dn dn, SearchResultReference reference, boolean evaluateAci)
SearchOperation
returnReference
in interface SearchOperation
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.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).public String toString()
Operation
toString
in interface Operation
toString
in class OperationWrapper<SearchOperation>
public Set<String> getAttributes()
SearchOperation
getAttributes
in interface SearchOperation
public org.forgerock.opendj.ldap.Dn getBaseDN()
SearchOperation
getRawBaseDN
method.getBaseDN
in interface SearchOperation
null
if the
raw base DN has not yet been processed.public org.forgerock.opendj.ldap.DereferenceAliasesPolicy getDerefPolicy()
SearchOperation
getDerefPolicy
in interface SearchOperation
public int getEntriesSent()
SearchOperation
getEntriesSent
in interface SearchOperation
public SearchFilter getFilter()
SearchOperation
getFilter
in interface SearchOperation
null
if the
raw filter has not yet been processed.public org.forgerock.opendj.ldap.ByteString getRawBaseDN()
SearchOperation
getRawBaseDN
in interface SearchOperation
public RawFilter getRawFilter()
SearchOperation
getRawFilter
in interface SearchOperation
public int getReferencesSent()
SearchOperation
getReferencesSent
in interface SearchOperation
public org.forgerock.opendj.ldap.SearchScope getScope()
SearchOperation
getScope
in interface SearchOperation
public int getSizeLimit()
SearchOperation
getSizeLimit
in interface SearchOperation
public int getTimeLimit()
SearchOperation
getTimeLimit
in interface SearchOperation
public boolean getTypesOnly()
SearchOperation
getTypesOnly
in interface SearchOperation
public void sendSearchResultDone()
SearchOperation
sendSearchResultDone
in interface SearchOperation
public void setAttributes(Set<String> attributes)
SearchOperation
setAttributes
in interface SearchOperation
attributes
- The set of requested attributes for this search
operation.public void setBaseDN(org.forgerock.opendj.ldap.Dn baseDN)
SearchOperation
setBaseDN
in interface SearchOperation
baseDN
- The base DN for this search operation.public void setDerefPolicy(org.forgerock.opendj.ldap.DereferenceAliasesPolicy derefPolicy)
SearchOperation
setDerefPolicy
in interface SearchOperation
derefPolicy
- The alias dereferencing policy for this search
operation.public void setRawBaseDN(org.forgerock.opendj.ldap.ByteString rawBaseDN)
SearchOperation
setRawBaseDN
in interface SearchOperation
rawBaseDN
- The raw, unprocessed base DN as included in the request
from the client.public void setRawFilter(RawFilter rawFilter)
SearchOperation
setRawFilter
in interface SearchOperation
rawFilter
- The raw, unprocessed search filter as included in the
request from the client.public void setScope(org.forgerock.opendj.ldap.SearchScope scope)
SearchOperation
setScope
in interface SearchOperation
scope
- The scope for this search operation.public void setSizeLimit(int sizeLimit)
SearchOperation
setSizeLimit
in interface SearchOperation
sizeLimit
- The size limit for this search operation.public void setTimeLimit(int timeLimit)
SearchOperation
setTimeLimit
in interface SearchOperation
timeLimit
- The time limit for this search operation.public void setTypesOnly(boolean typesOnly)
SearchOperation
setTypesOnly
in interface SearchOperation
typesOnly
- The typesOnly flag for this search operation.public void setTimeLimitExpiration(long timeLimitExpiration)
SearchOperation
setTimeLimitExpiration
in interface SearchOperation
timeLimitExpiration
- - Time after which the search has expiredpublic boolean isReturnSubentriesOnly()
SearchOperation
isReturnSubentriesOnly
in interface SearchOperation
public void setReturnSubentriesOnly(boolean returnLDAPSubentries)
SearchOperation
setReturnSubentriesOnly
in interface SearchOperation
returnLDAPSubentries
- - Boolean indicating whether the LDAP
subentries should be returned or notpublic MatchedValuesControl getMatchedValuesControl()
SearchOperation
getMatchedValuesControl
in interface SearchOperation
public void setMatchedValuesControl(MatchedValuesControl controls)
SearchOperation
setMatchedValuesControl
in interface SearchOperation
controls
- - The matched values controlpublic boolean isIncludeUsableControl()
SearchOperation
isIncludeUsableControl
in interface SearchOperation
public void setIncludeUsableControl(boolean includeUsableControl)
SearchOperation
setIncludeUsableControl
in interface SearchOperation
includeUsableControl
- - True if the account usable response control
has to be included within the search result
entries, false otherwisepublic long getTimeLimitExpiration()
SearchOperation
getTimeLimitExpiration
in interface SearchOperation
public boolean isClientAcceptsReferrals()
SearchOperation
isClientAcceptsReferrals
in interface SearchOperation
public void setClientAcceptsReferrals(boolean clientAcceptReferrals)
SearchOperation
setClientAcceptsReferrals
in interface SearchOperation
clientAcceptReferrals
- - Boolean set to true if the client
can handle referralspublic boolean isSendResponse()
SearchOperation
isSendResponse
in interface SearchOperation
public void setSendResponse(boolean sendResponse)
SearchOperation
setSendResponse
in interface SearchOperation
sendResponse
- - boolean indicating whether the search result done
message is to send to the clientpublic boolean isRealAttributesOnly()
SearchOperation
isRealAttributesOnly
in interface SearchOperation
public void setRealAttributesOnly(boolean realAttributesOnly)
SearchOperation
setRealAttributesOnly
in interface SearchOperation
realAttributesOnly
- - boolean setup to true, if only the real
attributes should be returnedpublic boolean isVirtualAttributesOnly()
SearchOperation
isVirtualAttributesOnly
in interface SearchOperation
public void setVirtualAttributesOnly(boolean virtualAttributesOnly)
SearchOperation
setVirtualAttributesOnly
in interface SearchOperation
virtualAttributesOnly
- - boolean setup to true, if only the virtual
attributes should be returnedpublic void sendSearchEntry(SearchResultEntry entry) throws DirectoryException
SearchOperation
sendSearchEntry
in interface SearchOperation
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.public boolean sendSearchReference(SearchResultReference reference) throws DirectoryException
SearchOperation
sendSearchReference
in interface SearchOperation
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.Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.