org.ldaptive
Class SearchRequest

java.lang.Object
  org.ldaptive.AbstractRequest
      org.ldaptive.SearchRequest

All Implemented Interfaces:

Message<RequestControl>, Request

Direct Known Subclasses:

AbstractSearchExecutor, SearchExecutor

public class SearchRequest
extends AbstractRequest

Contains the data required to perform an ldap search operation.

Version:

$Revision: 3189 $ $Date: 2016-11-01 17:21:43 -0400 (Tue, 01 Nov 2016) $

Author:

Middleware Services

Constructor Summary

SearchRequest()
Default constructor.

SearchRequest(String dn, SearchFilter filter)
Creates a new search request.

SearchRequest(String dn, SearchFilter filter, String... attrs)
Creates a new search request.

SearchRequest(String dn, String filter)
Creates a new search request.

SearchRequest(String dn, String filter, String... attrs)
Creates a new search request.

Method Summary

boolean	equals(Object o)
String	getBaseDn() Returns the base DN.
String[]	getBinaryAttributes() Returns names of binary attributes.
DerefAliases	getDerefAliases() Returns how to dereference aliases.
String[]	getReturnAttributes() Returns the search return attributes.
SearchEntryHandler[]	getSearchEntryHandlers() Returns the search entry handlers.
SearchFilter	getSearchFilter() Returns the search filter.
SearchReferenceHandler[]	getSearchReferenceHandlers() Returns the search reference handlers.
SearchScope	getSearchScope() Gets the search scope.
long	getSizeLimit() Returns the size limit.
SortBehavior	getSortBehavior() Returns the sort behavior.
long	getTimeLimit() Returns the time limit.
String	getTimeLimitDuration() Returns the time limit as a duration.
boolean	getTypesOnly() Returns whether to return only attribute types.
int	hashCode()
static SearchRequest	newObjectScopeSearchRequest(String dn) Returns a search request initialized for use with an object level search scope.
static SearchRequest	newObjectScopeSearchRequest(String dn, String[] attrs) Returns a search request initialized for use with an object level search scope.
static SearchRequest	newObjectScopeSearchRequest(String dn, String[] attrs, SearchFilter filter) Returns a search request initialized for use with an object level search scope.
protected static SearchRequest	newSearchRequest(SearchRequest request) Returns a search request initialized with the supplied request.
void	setBaseDn(String dn) Sets the base DN.
void	setBinaryAttributes(String... attrs) Sets names of binary attributes.
void	setDerefAliases(DerefAliases da) Sets how to dereference aliases.
void	setReturnAttributes(String... attrs) Sets the search return attributes.
void	setSearchEntryHandlers(SearchEntryHandler... handlers) Sets the search entry handlers.
void	setSearchFilter(SearchFilter filter) Sets the search filter.
void	setSearchReferenceHandlers(SearchReferenceHandler... handlers) Sets the search reference handlers.
void	setSearchScope(SearchScope scope) Sets the search scope.
void	setSizeLimit(long limit) Sets the size limit.
void	setSortBehavior(SortBehavior sb) Sets the sort behavior.
void	setTimeLimit(long limit) Sets the time limit.
void	setTimeLimitDuration(String limit) Sets the time limit.
void	setTypesOnly(boolean b) Sets whether to return only attribute types.
String	toString()

Methods inherited from class org.ldaptive.AbstractRequest

getControls, getFollowReferrals, getIntermediateResponseHandlers, setControls, setFollowReferrals, setIntermediateResponseHandlers

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchRequest

public SearchRequest()

Default constructor.

SearchRequest

public SearchRequest(String dn,
                     SearchFilter filter)

Creates a new search request.

Parameters:

dn - to search

filter - search filter

SearchRequest

public SearchRequest(String dn,
                     SearchFilter filter,
                     String... attrs)

Creates a new search request.

Parameters:

dn - to search

filter - search filter

attrs - to return

SearchRequest

public SearchRequest(String dn,
                     String filter)

Creates a new search request.

Parameters:

dn - to search

filter - search filter

SearchRequest

public SearchRequest(String dn,
                     String filter,
                     String... attrs)

Creates a new search request.

Parameters:

dn - to search

filter - search filter

attrs - to return

Method Detail

getBaseDn

public String getBaseDn()

Returns the base DN.

Returns:

base DN

setBaseDn

public void setBaseDn(String dn)

Sets the base DN.

Parameters:

dn - base DN

getSearchFilter

public SearchFilter getSearchFilter()

Returns the search filter.

Returns:

search filter

setSearchFilter

public void setSearchFilter(SearchFilter filter)

Sets the search filter.

Parameters:

filter - search filter

getReturnAttributes

public String[] getReturnAttributes()

Returns the search return attributes.

Returns:

search return attributes

setReturnAttributes

public void setReturnAttributes(String... attrs)

Sets the search return attributes.

Parameters:

attrs - search return attributes

getSearchScope

public SearchScope getSearchScope()

Gets the search scope.

Returns:

search scope

setSearchScope

public void setSearchScope(SearchScope scope)

Sets the search scope.

Parameters:

scope - search scope

getTimeLimit

public long getTimeLimit()

Returns the time limit.

Returns:

time limit

setTimeLimit

public void setTimeLimit(long limit)

Sets the time limit.

Parameters:

limit - time limit

getTimeLimitDuration

public String getTimeLimitDuration()

Returns the time limit as a duration.

Returns:

time limit in duration syntax

setTimeLimitDuration

public void setTimeLimitDuration(String limit)

Sets the time limit.

Parameters:

limit - in duration syntax or in milliseconds

getSizeLimit

public long getSizeLimit()

Returns the size limit.

Returns:

size limit

setSizeLimit

public void setSizeLimit(long limit)

Sets the size limit.

Parameters:

limit - size limit

getDerefAliases

public DerefAliases getDerefAliases()

Returns how to dereference aliases.

Returns:

how to dereference aliases

setDerefAliases

public void setDerefAliases(DerefAliases da)

Sets how to dereference aliases.

Parameters:

da - how to dereference aliases

getTypesOnly

public boolean getTypesOnly()

Returns whether to return only attribute types.

Returns:

whether to return only attribute types

setTypesOnly

public void setTypesOnly(boolean b)

Sets whether to return only attribute types.

Parameters:

b - whether to return only attribute types

getBinaryAttributes

public String[] getBinaryAttributes()

Returns names of binary attributes.

Returns:

binary attribute names

setBinaryAttributes

public void setBinaryAttributes(String... attrs)

Sets names of binary attributes.

Parameters:

attrs - binary attribute names

getSortBehavior

public SortBehavior getSortBehavior()

Returns the sort behavior.

Returns:

sort behavior

setSortBehavior

public void setSortBehavior(SortBehavior sb)

Sets the sort behavior.

Parameters:

sb - sort behavior

getSearchEntryHandlers

public SearchEntryHandler[] getSearchEntryHandlers()

Returns the search entry handlers.

Returns:

search entry handlers

setSearchEntryHandlers

public void setSearchEntryHandlers(SearchEntryHandler... handlers)

Sets the search entry handlers.

Parameters:

handlers - search entry handlers

getSearchReferenceHandlers

public SearchReferenceHandler[] getSearchReferenceHandlers()

Returns the search reference handlers.

Returns:

search reference handlers

setSearchReferenceHandlers

public void setSearchReferenceHandlers(SearchReferenceHandler... handlers)

Sets the search reference handlers.

Parameters:

handlers - search reference handlers

newObjectScopeSearchRequest

public static SearchRequest newObjectScopeSearchRequest(String dn)

Returns a search request initialized for use with an object level search scope.

Parameters:

dn - of an ldap entry

Returns:

search request

newObjectScopeSearchRequest

public static SearchRequest newObjectScopeSearchRequest(String dn,
                                                        String[] attrs)

Returns a search request initialized for use with an object level search scope.

Parameters:

dn - of an ldap entry

attrs - to return

Returns:

search request

newObjectScopeSearchRequest

public static SearchRequest newObjectScopeSearchRequest(String dn,
                                                        String[] attrs,
                                                        SearchFilter filter)

Returns a search request initialized for use with an object level search scope.

Parameters:

dn - of an ldap entry

attrs - to return

filter - to execute on the ldap entry

Returns:

search request

newSearchRequest

protected static SearchRequest newSearchRequest(SearchRequest request)

Returns a search request initialized with the supplied request. Note that stateful ldap entry handlers could cause thread safety issues.

Parameters:

request - search request to read properties from

Returns:

search request

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object