|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface PreParseSearchOperation
This class defines a set of methods that are available for use by pre-parse plugins for search operations. Note that this interface is intended only to define an API for use by plugins and is not intended to be implemented by any custom classes.
Method Summary | |
---|---|
java.util.LinkedHashSet<java.lang.String> |
getAttributes()
Retrieves the set of requested attributes for this search operation. |
DereferencePolicy |
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,
java.util.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(java.util.LinkedHashSet<java.lang.String> attributes)
Specifies the set of requested attributes for this search operation. |
void |
setDerefPolicy(DereferencePolicy 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. |
Methods inherited from interface org.opends.server.types.operation.PreParseOperation |
---|
addRequestControl, addResponseControl, appendAdditionalLogMessage, appendErrorMessage, getAdditionalLogMessage, getErrorMessage, removeRequestControl, removeResponseControl, setAdditionalLogMessage, setErrorMessage |
Methods inherited from interface org.opends.server.types.operation.PluginOperation |
---|
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getOperationType, getProcessingStartTime, getRequestControls, getResponseControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString, toString |
Method Detail |
---|
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.DereferencePolicy getDerefPolicy()
void setDerefPolicy(DereferencePolicy 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.java.util.LinkedHashSet<java.lang.String> getAttributes()
void setAttributes(java.util.LinkedHashSet<java.lang.String> attributes)
attributes
- The set of requested attributes for this
search operation.boolean returnEntry(Entry entry, java.util.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).
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |