public interface SearchRequest extends Request
Creation of Search requests is provided by
newSearch(DN, SearchScope, Filter, String[])
and
newSearch(String, SearchScope, String, String[])
Modifier and Type | Method and Description |
---|---|
SearchRequest |
addAttribute(java.lang.String... attributeDescriptions)
Adds the provided attribute name(s) to the list of attributes to be
included with each entry that matches the search criteria.
|
SearchRequest |
addControl(Control control)
Adds the provided control to this request.
|
java.util.Set<java.lang.String> |
getAttributes()
Returns a
Set containing the list of attributes to be included
with each entry that matches the search criteria. |
DereferenceAliasesPolicy |
getDereferenceAliasesPolicy()
Returns an indication as to whether or not alias entries are to be
dereferenced during the search.
|
Filter |
getFilter()
Returns the filter that defines the conditions that must be fulfilled in
order for an entry to be returned.
|
DN |
getName()
Returns the distinguished name of the base entry relative to which the
search is to be performed.
|
SearchScope |
getScope()
Returns the scope of the search.
|
int |
getSizeLimit()
Returns the size limit that should be used in order to restrict the maximum
number of entries returned by the search.
|
int |
getTimeLimit()
Returns the time limit that should be used in order to restrict the maximum
time (in seconds) allowed for the search.
|
boolean |
isTypesOnly()
Indicates whether search results are to contain both attribute descriptions
and values, or just attribute descriptions.
|
SearchRequest |
setDereferenceAliasesPolicy(DereferenceAliasesPolicy policy)
Sets the alias dereferencing policy to be used during the search.
|
SearchRequest |
setFilter(Filter filter)
Sets the filter that defines the conditions that must be fulfilled in order
for an entry to be returned.
|
SearchRequest |
setFilter(java.lang.String filter)
Sets the filter that defines the conditions that must be fulfilled in order
for an entry to be returned.
|
SearchRequest |
setName(DN dn)
Sets the distinguished name of the base entry relative to which the search
is to be performed.
|
SearchRequest |
setName(java.lang.String dn)
Sets the distinguished name of the base entry relative to which the search
is to be performed.
|
SearchRequest |
setScope(SearchScope scope)
Sets the scope of the search.
|
SearchRequest |
setSizeLimit(int limit)
Sets the size limit that should be used in order to restrict the maximum
number of entries returned by the search.
|
SearchRequest |
setTimeLimit(int limit)
Sets the time limit that should be used in order to restrict the maximum
time (in seconds) allowed for the search.
|
SearchRequest |
setTypesOnly(boolean typesOnly)
Specifies whether search results are to contain both attribute descriptions
and values, or just attribute descriptions.
|
getControl, getControls, isInternal, removeControl
getAttachment, getAttachmentNames, removeAttachment, setAttachment
SearchRequest addAttribute(java.lang.String... attributeDescriptions) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
attributeDescriptions
- The name(s) of the attribute to be included with each entry.java.lang.UnsupportedOperationException
- If this search request does not permit attribute names to be
added.java.lang.NullPointerException
- If attributeDescriptions
was null
.SearchRequest addControl(Control control) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
addControl
in interface Request
control
- The control to be added to this request.java.lang.UnsupportedOperationException
- If this request does not permit controls to be added.java.lang.NullPointerException
- If control
was null
.java.util.Set<java.lang.String> getAttributes()
Set
containing the list of attributes to be included
with each entry that matches the search criteria. Attributes that are
sub-types of listed attributes are implicitly included. The returned
List
may be modified if permitted by this search request.List
containing the list of attributes.DereferenceAliasesPolicy getDereferenceAliasesPolicy()
Filter getFilter()
DN getName()
SearchScope getScope()
int getSizeLimit()
A value of zero (the default) in this field indicates that no client-requested size limit restrictions are in effect. Servers may also enforce a maximum number of entries to return.
int getTimeLimit()
A value of zero (the default) in this field indicates that no client-requested time limit restrictions are in effect for the search. Servers may also enforce a maximum time limit for the search.
boolean isTypesOnly()
true
if only attribute descriptions (and not values) are to
be returned, or false
(the default) if both attribute
descriptions and values are to be returned.SearchRequest setDereferenceAliasesPolicy(DereferenceAliasesPolicy policy) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
policy
- The alias dereferencing policy to be used during the search.java.lang.UnsupportedOperationException
- If this search request does not permit the alias dereferencing
policy to be set.java.lang.NullPointerException
- If policy
was null
.SearchRequest setFilter(Filter filter) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
filter
- The filter that defines the conditions that must be fulfilled in
order for an entry to be returned.java.lang.UnsupportedOperationException
- If this search request does not permit the filter to be set.java.lang.NullPointerException
- If filter
was null
.SearchRequest setFilter(java.lang.String filter) throws java.lang.UnsupportedOperationException, PluginException, java.lang.NullPointerException
filter
- The filter that defines the conditions that must be fulfilled in
order for an entry to be returned.java.lang.UnsupportedOperationException
- If this search request does not permit the filter to be set.PluginException
- If filter
is not a valid LDAP string representation of a
filter.java.lang.NullPointerException
- If filter
was null
.SearchRequest setName(DN dn) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
dn
- The distinguished name of the base entry relative to which the
search is to be performed.java.lang.UnsupportedOperationException
- If this search request does not permit the distinguished name to
be set.java.lang.NullPointerException
- If dn
was null
.SearchRequest setName(java.lang.String dn) throws PluginException, java.lang.UnsupportedOperationException, java.lang.NullPointerException
dn
- The distinguished name of the base entry relative to which the
search is to be performed.PluginException
- If dn
could not be decoded.java.lang.UnsupportedOperationException
- If this search request does not permit the distinguished name to
be set.java.lang.NullPointerException
- If dn
was null
.SearchRequest setScope(SearchScope scope) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
scope
- The scope of the search.java.lang.UnsupportedOperationException
- If this search request does not permit the scope to be set.java.lang.NullPointerException
- If scope
was null
.SearchRequest setSizeLimit(int limit) throws java.lang.UnsupportedOperationException, PluginException
A value of zero (the default) in this field indicates that no client-requested size limit restrictions are in effect. Servers may also enforce a maximum number of entries to return.
limit
- The size limit that should be used in order to restrict the
maximum number of entries returned by the search.java.lang.UnsupportedOperationException
- If this search request does not permit the size limit to be set.PluginException
- If limit
was negative.SearchRequest setTimeLimit(int limit) throws java.lang.UnsupportedOperationException, PluginException
A value of zero (the default) in this field indicates that no client-requested time limit restrictions are in effect for the search. Servers may also enforce a maximum time limit for the search.
limit
- The time limit that should be used in order to restrict the
maximum time (in seconds) allowed for the search.java.lang.UnsupportedOperationException
- If this search request does not permit the time limit to be set.PluginException
- If limit
was negative.SearchRequest setTypesOnly(boolean typesOnly) throws java.lang.UnsupportedOperationException
typesOnly
- true
if only attribute descriptions (and not values) are
to be returned, or false
(the default) if both attribute
descriptions and values are to be returned.java.lang.UnsupportedOperationException
- If this search request does not permit the types-only parameter
to be set.