public interface SearchRequest extends ManyReplyRequest, AbandonableRequest
Modifier and Type | Field and Description |
---|---|
static MessageTypeEnum[] |
RESPONSE_TYPES
Different response types that a search request may return.
|
Modifier and Type | Method and Description |
---|---|
SearchRequest |
addAllControls(Control[] controls)
Adds an array of controls to this Message.
|
SearchRequest |
addAttributes(String... attributes)
Adds some attributes to the set of entry attributes to return.
|
SearchRequest |
addControl(Control control)
Adds a control to this Message.
|
SearchRequest |
followReferrals()
Tells the client to follow referrals instead of throwing exceptions
|
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.
|
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 |
ignoreReferrals()
Tells the client to ignore referrals instead of throwing exceptions.
|
boolean |
isFollowReferrals()
Tells the client if it should follow referrals instead of throwing exceptions
|
boolean |
isIgnoreReferrals()
Tells the client if it should ignore referrals instead of throwing exceptions
|
SearchRequest |
removeAttribute(String attribute)
Removes an attribute to the set of entry attributes to return.
|
SearchRequest |
removeControl(Control control)
Deletes a control removing it from this Message.
|
SearchRequest |
setBase(Dn baseDn)
Sets the search base as a distinguished name.
|
SearchRequest |
setDerefAliases(AliasDerefMode aliasDerefAliases)
Sets the alias handling parameter.
|
SearchRequest |
setFilter(ExprNode filter)
Sets the search filter associated with this search request.
|
SearchRequest |
setFilter(String filter)
Sets the search filter associated with this search request.
|
SearchRequest |
setMessageId(int messageId)
Sets the Message ID for this request
|
SearchRequest |
setScope(SearchScope scope)
Sets the search scope parameter enumeration.
|
SearchRequest |
setSizeLimit(long entriesMax)
Sets sizelimit that restricts the maximum number of entries to be
returned as a result of the search.
|
SearchRequest |
setTimeLimit(int secondsMax)
Sets the timelimit that restricts the maximum time (in seconds) allowed
for a search.
|
SearchRequest |
setTypesOnly(boolean typesOnly)
An indicator as to whether search results will contain both attribute
types and values, or just attribute types.
|
getResultResponse
hasResponse
get, getControl, getControls, getMessageId, getType, hasControl, put
abandon, addAbandonListener, isAbandoned
static final MessageTypeEnum[] RESPONSE_TYPES
getResponseTypes()
MessageTypeEnum[] getResponseTypes()
getResponseTypes
in interface ManyReplyRequest
RESPONSE_TYPES
SearchRequest setBase(Dn baseDn)
baseDn
- the search baseSearchScope getScope()
SearchRequest setScope(SearchScope scope)
scope
- the scope enumeration parameter.AliasDerefMode getDerefAliases()
SearchRequest setDerefAliases(AliasDerefMode aliasDerefAliases)
aliasDerefAliases
- the alias handling parameter enumeration.long getSizeLimit()
SearchRequest setSizeLimit(long entriesMax)
entriesMax
- maximum search result entries to return.int getTimeLimit()
SearchRequest setTimeLimit(int secondsMax)
secondsMax
- the search time limit in seconds.boolean getTypesOnly()
SearchRequest setTypesOnly(boolean typesOnly)
typesOnly
- true for only types, false for types and values.ExprNode getFilter()
SearchRequest setFilter(ExprNode filter)
filter
- the expression node for the root of the filter expression tree.SearchRequest setFilter(String filter) throws LdapException
filter
- the expression node for the root of the filter expression tree.LdapException
- If the filter can't be addedList<String> getAttributes()
SearchRequest addAttributes(String... attributes)
attributes
- the attributes description or identifier.SearchRequest removeAttribute(String attribute)
attribute
- the attribute description or identifier.SearchRequest setMessageId(int messageId)
setMessageId
in interface Message
messageId
- The message IdSearchRequest addControl(Control control)
addControl
in interface Message
control
- the control to add.SearchRequest addAllControls(Control[] controls)
addAllControls
in interface Message
controls
- the controls to add.SearchRequest removeControl(Control control)
removeControl
in interface Message
control
- the control to remove.boolean isFollowReferrals()
SearchRequest followReferrals()
boolean isIgnoreReferrals()
SearchRequest ignoreReferrals()
Copyright © 2003–2020 The Apache Software Foundation. All rights reserved.