public class SearchRequestImpl extends AbstractAbandonableRequest implements InternalSearchRequest
RESPONSE_TYPES
Constructor and Description |
---|
SearchRequestImpl(int id)
Creates a Lockable SearcRequest implementing object used to search the
DIT.
|
Modifier and Type | Method and Description |
---|---|
void |
addAttribute(String attribute)
Adds an attribute to the set of entry attributes to return.
|
boolean |
equals(Object obj)
Checks to see if two search requests are equal.
|
List<String> |
getAttributes()
Gets a list of the attributes to be returned from each entry which
matches the search filter.
|
DN |
getBase()
Gets the search base as a distinguished name.
|
AliasDerefMode |
getDerefAliases()
Gets the alias handling parameter.
|
ExprNode |
getFilter()
Gets the search filter associated with this search request.
|
MessageTypeEnum[] |
getResponseTypes()
Gets the different response types generated by a search request.
|
InternalResultResponse |
getResultResponse()
The result containing response for this request.
|
SearchScope |
getScope()
Gets the search scope parameter enumeration.
|
long |
getSizeLimit()
A sizelimit that restricts the maximum number of entries to be returned
as a result of the search.
|
int |
getTimeLimit()
Gets the timelimit that restricts the maximum time (in seconds) allowed
for a search.
|
boolean |
getTypesOnly()
An indicator as to whether search results will contain both attribute
types and values, or just attribute types.
|
void |
removeAttribute(String attribute)
Removes an attribute to the set of entry attributes to return.
|
void |
setBase(DN base)
Sets the search base as a distinguished name.
|
void |
setDerefAliases(AliasDerefMode aliasDerefAliases)
Sets the alias handling parameter.
|
void |
setFilter(ExprNode filter)
Sets the search filter associated with this search request.
|
void |
setScope(SearchScope scope)
Sets the search scope parameter enumeration.
|
void |
setSizeLimit(long entriesMax)
Sets sizelimit that restricts the maximum number of entries to be
returned as a result of the search.
|
void |
setTimeLimit(int secondsMax)
Sets the timelimit that restricts the maximum time (in seconds) allowed
for a search.
|
void |
setTypesOnly(boolean typesOnly)
An indicator as to whether search results will contain both attribute
types and values, or just attribute types.
|
String |
toString()
Return a string the represent a SearchRequest
|
abandon, addAbandonListener, isAbandoned
hashCode, hasResponse
add, addAll, get, getControls, getMessageId, getType, hasControl, put, remove
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
hasResponse
add, addAll, get, getControls, getMessageId, getType, hasControl, put, remove
abandon, addAbandonListener, isAbandoned
public SearchRequestImpl(int id)
id
- the sequential message identifierpublic List<String> getAttributes()
getAttributes
in interface InternalSearchRequest
public DN getBase()
getBase
in interface InternalSearchRequest
public void setBase(DN base)
setBase
in interface InternalSearchRequest
base
- the search basepublic AliasDerefMode getDerefAliases()
getDerefAliases
in interface InternalSearchRequest
public void setDerefAliases(AliasDerefMode aliasDerefAliases)
setDerefAliases
in interface InternalSearchRequest
aliasDerefAliases
- the alias handling parameter enumeration.public ExprNode getFilter()
getFilter
in interface InternalSearchRequest
public void setFilter(ExprNode filter)
setFilter
in interface InternalSearchRequest
filter
- the expression node for the root of the filter expression
tree.public MessageTypeEnum[] getResponseTypes()
getResponseTypes
in interface InternalSearchRequest
getResponseTypes
in interface ManyReplyRequest
InternalSearchRequest.RESPONSE_TYPES
public SearchScope getScope()
getScope
in interface InternalSearchRequest
public void setScope(SearchScope scope)
setScope
in interface InternalSearchRequest
scope
- the scope enumeration parameter.public long getSizeLimit()
getSizeLimit
in interface InternalSearchRequest
public void setSizeLimit(long entriesMax)
setSizeLimit
in interface InternalSearchRequest
entriesMax
- maximum search result entries to return.public int getTimeLimit()
getTimeLimit
in interface InternalSearchRequest
public void setTimeLimit(int secondsMax)
setTimeLimit
in interface InternalSearchRequest
secondsMax
- the search time limit in seconds.public boolean getTypesOnly()
getTypesOnly
in interface InternalSearchRequest
public void setTypesOnly(boolean typesOnly)
setTypesOnly
in interface InternalSearchRequest
typesOnly
- true for only types, false for types and values.public void addAttribute(String attribute)
addAttribute
in interface InternalSearchRequest
attribute
- the attribute description or identifier.public void removeAttribute(String attribute)
removeAttribute
in interface InternalSearchRequest
attribute
- the attribute description or identifier.public InternalResultResponse getResultResponse()
getResultResponse
in interface InternalResultResponseRequest
public boolean equals(Object obj)
equals
in class InternalAbstractMessage
obj
- the object to check for equality to this SearchRequestCopyright © 2003–2014 The Apache Software Foundation. All rights reserved.