@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface PreParseSearchOperation extends PreParseOperation
Modifier and Type | Method and Description |
---|---|
Set<String> |
getAttributes()
Retrieves the set of requested attributes for this search operation.
|
DereferenceAliasesPolicy |
getDerefPolicy()
Retrieves the alias dereferencing policy for this search operation.
|
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.
|
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.
|
boolean |
getTypesOnly()
Retrieves the typesOnly flag for this search operation.
|
boolean |
returnEntry(Entry entry,
List<Control> controls)
Returns the provided entry to the client.
|
boolean |
returnReference(Dn dn,
SearchResultReference reference)
Returns the provided search result reference to the client.
|
void |
setAttributes(Set<String> attributes)
Specifies the set of requested attributes for this search operation.
|
void |
setDerefPolicy(DereferenceAliasesPolicy derefPolicy)
Specifies the alias dereferencing policy for this search operation.
|
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 |
setScope(SearchScope scope)
Specifies the scope for this search operation.
|
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 |
setTypesOnly(boolean typesOnly)
Specifies the typesOnly flag for this search operation.
|
addAdditionalLogItem, addRequestControl, addResponseControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, removeResponseControl, setErrorMessage
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getOperationType, getProcessingStartTime, getRequestControl, getRequestControls, getResponseControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString, toString
ByteString getRawBaseDN()
void setRawBaseDN(ByteString rawBaseDN)
rawBaseDN
- The raw, unprocessed base DN for this search operation.SearchScope getScope()
void setScope(SearchScope scope)
scope
- The scope for this search operation.DereferenceAliasesPolicy getDerefPolicy()
void setDerefPolicy(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()
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.Set<String> getAttributes()
void setAttributes(Set<String> attributes)
attributes
- The set of requested attributes for this search operation.boolean returnEntry(Entry entry, List<Control> controls)
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).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(Dn dn, SearchResultReference reference)
reference
- The search reference that should be returned.dn
- A 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).Copyright 2010-2020 ForgeRock AS.