public class SearchRequest extends AbstractRequest implements AbandonableRequest, RequestWithResponse
Constructor and Description |
---|
SearchRequest()
Creates a new instance of SearchRequestImpl.
|
Modifier and Type | Method and Description |
---|---|
SearchRequest |
addAttributes(String... attributes)
Adds attributes to the set of entry attributes to return.
|
Set<String> |
getAttributes()
Gets a list of the attributes to be returned from each entry which
matches the search filter.
|
String |
getBaseDn()
Gets the search base as a distinguished name.
|
org.apache.directory.shared.ldap.message.AliasDerefMode |
getDerefAliases()
Gets the alias handling parameter.
|
String |
getFilter()
Gets the search filter associated with this search request.
|
org.apache.directory.shared.ldap.filter.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.
|
SearchRequest |
removeAttributes(String... attributes)
Removes attributes to the set of entry attributes to return.
|
void |
setBaseDn(String baseDn)
Sets the search base as a distinguished name.
|
void |
setDerefAliases(org.apache.directory.shared.ldap.message.AliasDerefMode aliasDerefAliases)
Sets the alias handling parameter.
|
void |
setFilter(String filter)
Sets the search filter associated with this search request.
|
void |
setScope(org.apache.directory.shared.ldap.filter.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.
|
getTimeout, setTimeout
add, getControl, getControls, getMessageId, hasControl, remove, setMessageId, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getTimeout, setTimeout
add, getControl, getControls, getMessageId, hasControl, remove, setMessageId
public SearchRequest()
messageId
- The message IDpublic Set<String> getAttributes()
public String getBaseDn()
public void setBaseDn(String baseDn)
baseDn
- the search basepublic org.apache.directory.shared.ldap.message.AliasDerefMode getDerefAliases()
public void setDerefAliases(org.apache.directory.shared.ldap.message.AliasDerefMode aliasDerefAliases)
aliasDerefAliases
- the alias handling parameter enumeration.public String getFilter()
public void setFilter(String filter)
filter
- the expression node for the root of the filter
expression tree.public org.apache.directory.shared.ldap.filter.SearchScope getScope()
public void setScope(org.apache.directory.shared.ldap.filter.SearchScope scope)
scope
- the scope enumeration parameter.public long getSizeLimit()
public void setSizeLimit(long entriesMax)
entriesMax
- maximum search result entries to return.public int getTimeLimit()
public void setTimeLimit(int secondsMax)
secondsMax
- the search time limit in seconds.public boolean getTypesOnly()
public void setTypesOnly(boolean typesOnly)
typesOnly
- true for only types, false for types and values.public SearchRequest addAttributes(String... attributes)
attributes
- the attributes description or identifier.public SearchRequest removeAttributes(String... attributes)
attributes
- the attributes description or identifier.Copyright © 2009–2014 The Apache Software Foundation. All rights reserved.