Uses of Class
org.ldaptive.SearchRequest

Packages that use SearchRequest

Package	Description
org.ldaptive
org.ldaptive.ad.control.util
org.ldaptive.ad.handler
org.ldaptive.async
org.ldaptive.auth
org.ldaptive.cache
org.ldaptive.cli
org.ldaptive.concurrent
org.ldaptive.control.util
org.ldaptive.handler
org.ldaptive.jaas
org.ldaptive.pool
org.ldaptive.props
org.ldaptive.provider
org.ldaptive.provider.jndi
org.ldaptive.referral

Uses of SearchRequest in org.ldaptive

Subclasses of SearchRequest in org.ldaptive

Modifier and Type	Class and Description
class	SearchExecutor Helper class which encapsulates the try, finally idiom used to execute a SearchOperation.

Fields in org.ldaptive with type parameters of type SearchRequest

Modifier and Type	Field and Description
private Cache<SearchRequest>	SearchOperation.cache Cache to use when performing searches.
private Cache<SearchRequest>	SearchExecutor.searchCache Cache to use when performing searches.
private OperationExceptionHandler<SearchRequest,SearchResult>	SearchExecutor.searchExceptionHandler Handler to handle search exceptions.

Methods in org.ldaptive that return SearchRequest

Modifier and Type	Method and Description
static SearchRequest	SearchRequest.newObjectScopeSearchRequest(java.lang.String dn) Returns a search request initialized for use with an object level search scope.
static SearchRequest	SearchRequest.newObjectScopeSearchRequest(java.lang.String dn, java.lang.String[] attrs) Returns a search request initialized for use with an object level search scope.
static SearchRequest	SearchRequest.newObjectScopeSearchRequest(java.lang.String dn, java.lang.String[] attrs, SearchFilter filter) Returns a search request initialized for use with an object level search scope.
protected static SearchRequest	SearchRequest.newSearchRequest(SearchRequest request) Returns a search request initialized with the supplied request.

Methods in org.ldaptive that return types with arguments of type SearchRequest

Modifier and Type	Method and Description
Cache<SearchRequest>	SearchOperation.getCache() Returns the cache to check when performing search operations.
Cache<SearchRequest>	SearchExecutor.getSearchCache() Returns the search cache.
OperationExceptionHandler<SearchRequest,SearchResult>	SearchExecutor.getSearchExceptionHandler() Returns the search exception handler.

Methods in org.ldaptive with parameters of type SearchRequest

Modifier and Type	Method and Description
protected Response<SearchResult>	SearchOperation.executeSearch(SearchRequest request) Performs the ldap search.
protected Response<SearchResult>	SearchOperation.invoke(SearchRequest request)
protected static SearchRequest	SearchRequest.newSearchRequest(SearchRequest request) Returns a search request initialized with the supplied request.
protected SearchResult	SearchOperation.readResult(SearchRequest request, SearchIterator si) Invokes the provider search operation and iterates over the results.

Method parameters in org.ldaptive with type arguments of type SearchRequest

Modifier and Type	Method and Description
void	SearchOperation.setCache(Cache<SearchRequest> c) Sets the cache.
void	SearchExecutor.setSearchCache(Cache<SearchRequest> cache) Sets the search cache.
void	SearchExecutor.setSearchExceptionHandler(OperationExceptionHandler<SearchRequest,SearchResult> handler) Sets the search exception handler.

Constructor parameters in org.ldaptive with type arguments of type SearchRequest

Constructor and Description
SearchOperation(Connection conn, Cache<SearchRequest> c) Creates a new search operation.

Uses of SearchRequest in org.ldaptive.ad.control.util

Methods in org.ldaptive.ad.control.util with parameters of type SearchRequest

Modifier and Type	Method and Description
Response<SearchResult>	DirSyncClient.execute(SearchRequest request) Performs a search operation with the DirSyncControl.
java.util.concurrent.BlockingQueue<NotificationClient.NotificationItem>	NotificationClient.execute(SearchRequest request) Invokes NotificationClient.execute(SearchRequest, int) with a capacity of Integer.MAX_VALUE.
Response<SearchResult>	DirSyncClient.execute(SearchRequest request, CookieManager manager) Performs a search operation with the DirSyncControl.
java.util.concurrent.BlockingQueue<NotificationClient.NotificationItem>	NotificationClient.execute(SearchRequest request, int capacity) Performs a search operation with the NotificationControl.
Response<SearchResult>	DirSyncClient.execute(SearchRequest request, Response<SearchResult> response) Performs a search operation with the DirSyncControl.
Response<SearchResult>	DirSyncClient.executeToCompletion(SearchRequest request) Invokes DirSyncClient.execute(SearchRequest, CookieManager) with a DefaultCookieManager.
Response<SearchResult>	DirSyncClient.executeToCompletion(SearchRequest request, CookieManager manager) Performs a search operation with the DirSyncControl.

Uses of SearchRequest in org.ldaptive.ad.handler

Methods in org.ldaptive.ad.handler with parameters of type SearchRequest

Modifier and Type	Method and Description
protected void	AbstractBinaryAttributeHandler.handleAttributes(Connection conn, SearchRequest request, SearchEntry entry)
protected void	PrimaryGroupIdHandler.handleAttributes(Connection conn, SearchRequest request, SearchEntry entry)
protected void	RangeEntryHandler.handleAttributes(Connection conn, SearchRequest request, SearchEntry entry)
void	AbstractBinaryAttributeHandler.initializeRequest(SearchRequest request)

Uses of SearchRequest in org.ldaptive.async

Fields in org.ldaptive.async declared as SearchRequest

Modifier and Type	Field and Description
private SearchRequest	AsyncSearchOperation.AsyncSearchListener.searchRequest Containing request handlers.

Methods in org.ldaptive.async with parameters of type SearchRequest

Modifier and Type	Method and Description
FutureResponse<SearchResult>	AsyncSearchOperation.execute(SearchRequest request)
protected Response<SearchResult>	AsyncSearchOperation.invoke(SearchRequest request)

Constructors in org.ldaptive.async with parameters of type SearchRequest

Constructor and Description
AsyncSearchListener(SearchRequest request) Creates a new async search listener.

Uses of SearchRequest in org.ldaptive.auth

Fields in org.ldaptive.auth with type parameters of type SearchRequest

Modifier and Type	Field and Description
private Cache<SearchRequest>	AbstractSearchOperationFactory.searchCache Cache to use when performing searches.
private OperationExceptionHandler<SearchRequest,SearchResult>	AbstractSearchOperationFactory.searchExceptionHandler Handler to handle search exceptions.

Methods in org.ldaptive.auth that return SearchRequest

Modifier and Type	Method and Description
protected SearchRequest	AbstractSearchEntryResolver.createSearchRequest(AuthenticationCriteria ac) Returns a search request for the supplied authentication criteria.
protected SearchRequest	AuthorizationIdentityEntryResolver.createSearchRequest(AuthenticationCriteria ac, java.lang.String dn) Returns a search request for an object level search for the supplied DN.
protected SearchRequest	WhoAmIEntryResolver.createSearchRequest(AuthenticationCriteria ac, java.lang.String dn) Returns a search request for an object level search for the supplied DN.
protected SearchRequest	AbstractSearchDnResolver.createSearchRequest(SearchFilter filter) Returns a search request for searching for a single entry in an LDAP, returning no attributes.

Methods in org.ldaptive.auth that return types with arguments of type SearchRequest

Modifier and Type	Method and Description
Cache<SearchRequest>	AbstractSearchOperationFactory.getSearchCache() Returns the search cache.
OperationExceptionHandler<SearchRequest,SearchResult>	AbstractSearchOperationFactory.getSearchExceptionHandler() Returns the search exception handler.

Method parameters in org.ldaptive.auth with type arguments of type SearchRequest

Modifier and Type	Method and Description
void	AbstractSearchOperationFactory.setSearchCache(Cache<SearchRequest> cache) Sets the search cache.
void	AbstractSearchOperationFactory.setSearchExceptionHandler(OperationExceptionHandler<SearchRequest,SearchResult> handler) Sets the search exception handler.

Uses of SearchRequest in org.ldaptive.cache

Classes in org.ldaptive.cache with type parameters of type SearchRequest

Modifier and Type	Interface and Description
interface	Cache<Q extends SearchRequest> Interface for cache implementations.
class	LRUCache<Q extends SearchRequest> Least-Recently-Used cache implementation.

Uses of SearchRequest in org.ldaptive.cli

Methods in org.ldaptive.cli that return SearchRequest

Modifier and Type	Method and Description
protected SearchRequest	SearchOperationCli.initSearchRequest(org.apache.commons.cli.CommandLine line) Initialize a search request with command line options.

Methods in org.ldaptive.cli with parameters of type SearchRequest

Modifier and Type	Method and Description
protected int	SearchOperationCli.search(ConnectionFactory cf, SearchRequest request) Executes the ldap search operation.

Uses of SearchRequest in org.ldaptive.concurrent

Subclasses of SearchRequest in org.ldaptive.concurrent

Modifier and Type	Class and Description
class	AbstractAggregateSearchExecutor<T extends ConnectionFactory> Base class for aggregate search executors.
class	AbstractParallelSearchExecutor<T extends ConnectionFactory> Base class for parallel search executors.
class	AbstractSearchExecutor Base class for concurrent search executors.
class	AggregatePooledSearchExecutor Executes a list of search filters in parallel over a list of connection factories, each search is performed on a separate connection in the pool.
class	AggregateSearchExecutor Executes a list of search filters in parallel over a list of connection factories.
class	ParallelPooledSearchExecutor Executes a list of search filters in parallel, each search is performed on a separate connection in the pool.
class	ParallelSearchExecutor Executes a list of search filters in parallel.
class	QueueingSearchExecutor Executes a search filter and places the results of the operation on a blocking queue.

Fields in org.ldaptive.concurrent with type parameters of type SearchRequest

Modifier and Type	Field and Description
private Cache<SearchRequest>	AbstractSearchExecutor.searchCache Cache to use when performing searches.
private OperationExceptionHandler<SearchRequest,SearchResult>	AbstractSearchExecutor.searchExceptionHandler Handler to handle search exceptions.

Methods in org.ldaptive.concurrent that return types with arguments of type SearchRequest

Modifier and Type	Method and Description
Cache<SearchRequest>	AbstractSearchExecutor.getSearchCache() Returns the search cache.
OperationExceptionHandler<SearchRequest,SearchResult>	AbstractSearchExecutor.getSearchExceptionHandler() Returns the search exception handler.

Methods in org.ldaptive.concurrent with parameters of type SearchRequest

Modifier and Type	Method and Description
protected void	QueueingSearchExecutor.configureSearchRequest(SearchRequest request, java.util.concurrent.BlockingQueue<QueueingSearchExecutor.SearchItem> queue) Sets the appropriate handlers on the supplied search request so that entries, references, and intermediate responses are made available on the supplied queue.
protected java.util.concurrent.Callable<Response<SearchResult>>	QueueingSearchExecutor.createCallable(Connection conn, SearchOperation operation, SearchRequest request, java.util.concurrent.BlockingQueue<QueueingSearchExecutor.SearchItem> queue) Returns a Callable that executes the supplied request with the supplied operation in a try-finally block that opens and closes the connection.
HandlerResult<SearchEntry>	QueueingSearchExecutor.SearchEntryHandler.handle(Connection conn, SearchRequest request, SearchEntry entry)
HandlerResult<SearchReference>	QueueingSearchExecutor.SearchReferenceHandler.handle(Connection conn, SearchRequest request, SearchReference reference)
void	QueueingSearchExecutor.SearchEntryHandler.initializeRequest(SearchRequest request)
void	QueueingSearchExecutor.SearchReferenceHandler.initializeRequest(SearchRequest request)

Method parameters in org.ldaptive.concurrent with type arguments of type SearchRequest

Modifier and Type	Method and Description
void	AbstractSearchExecutor.setSearchCache(Cache<SearchRequest> cache) Sets the search cache.
void	AbstractSearchExecutor.setSearchExceptionHandler(OperationExceptionHandler<SearchRequest,SearchResult> handler) Sets the search exception handler.

Uses of SearchRequest in org.ldaptive.control.util

Methods in org.ldaptive.control.util with parameters of type SearchRequest

Modifier and Type	Method and Description
java.util.concurrent.BlockingQueue<SyncReplItem>	SyncReplClient.execute(SearchRequest request) Invokes SyncReplClient.execute(SearchRequest, CookieManager, int) with a DefaultCookieManager and a capacity of Integer.MAX_VALUE.
Response<SearchResult>	PagedResultsClient.execute(SearchRequest request) Performs a search operation with the PagedResultsControl.
java.util.concurrent.BlockingQueue<PersistentSearchItem>	PersistentSearchClient.execute(SearchRequest request) Invokes PersistentSearchClient.execute(SearchRequest, int) with a capacity of Integer.MAX_VALUE.
java.util.concurrent.BlockingQueue<SyncReplItem>	SyncReplClient.execute(SearchRequest request, CookieManager manager) Invokes SyncReplClient.execute(SearchRequest, CookieManager, int) with a capacity of Integer.MAX_VALUE.
Response<SearchResult>	PagedResultsClient.execute(SearchRequest request, CookieManager manager) Performs a search operation with the PagedResultsControl.
java.util.concurrent.BlockingQueue<SyncReplItem>	SyncReplClient.execute(SearchRequest request, CookieManager manager, int capacity) Performs an async search operation with the SyncRequestControl.
java.util.concurrent.BlockingQueue<PersistentSearchItem>	PersistentSearchClient.execute(SearchRequest request, int capacity) Performs an async search operation with the PersistentSearchRequestControl.
Response<SearchResult>	PagedResultsClient.execute(SearchRequest request, Response<SearchResult> response) Performs a search operation with the PagedResultsControl.
Response<SearchResult>	VirtualListViewClient.execute(SearchRequest request, VirtualListViewParams params) Performs a search operation with the VirtualListViewRequestControl.
Response<SearchResult>	VirtualListViewClient.execute(SearchRequest request, VirtualListViewParams params, Response<SearchResult> response) Performs a search operation with the VirtualListViewRequestControl.
Response<SearchResult>	PagedResultsClient.executeToCompletion(SearchRequest request) Performs a search operation with the PagedResultsControl.
Response<SearchResult>	PagedResultsClient.executeToCompletion(SearchRequest request, CookieManager manager) Performs a search operation with the PagedResultsControl.

Uses of SearchRequest in org.ldaptive.handler

Methods in org.ldaptive.handler with parameters of type SearchRequest

Modifier and Type	Method and Description
HandlerResult<SearchEntry>	RecursiveEntryHandler.handle(Connection conn, SearchRequest request, SearchEntry entry)
HandlerResult<SearchEntry>	SearchEntryHandler.handle(Connection conn, SearchRequest request, SearchEntry entry)
HandlerResult<SearchEntry>	AbstractSearchEntryHandler.handle(Connection conn, SearchRequest request, SearchEntry entry)
HandlerResult<SearchReference>	SearchReferenceHandler.handle(Connection conn, SearchRequest request, SearchReference reference)
protected void	AbstractSearchEntryHandler.handleAttribute(Connection conn, SearchRequest request, LdapAttribute attr) Handle a single attribute.
protected java.lang.String	CaseChangeEntryHandler.handleAttributeName(Connection conn, SearchRequest request, java.lang.String name)
protected java.lang.String	AbstractSearchEntryHandler.handleAttributeName(Connection conn, SearchRequest request, java.lang.String name) Returns the supplied attribute name unaltered.
protected void	MergeAttributeEntryHandler.handleAttributes(Connection conn, SearchRequest request, SearchEntry entry)
protected void	DnAttributeEntryHandler.handleAttributes(Connection conn, SearchRequest request, SearchEntry entry)
protected void	AbstractSearchEntryHandler.handleAttributes(Connection conn, SearchRequest request, SearchEntry entry) Handle the attributes of a search entry.
protected byte[]	CaseChangeEntryHandler.handleAttributeValue(Connection conn, SearchRequest request, byte[] value)
protected byte[]	AbstractSearchEntryHandler.handleAttributeValue(Connection conn, SearchRequest request, byte[] value) Returns the supplied attribute value unaltered.
protected java.lang.String	CaseChangeEntryHandler.handleAttributeValue(Connection conn, SearchRequest request, java.lang.String value)
protected java.lang.String	AbstractSearchEntryHandler.handleAttributeValue(Connection conn, SearchRequest request, java.lang.String value) Returns the supplied attribute value unaltered.
protected java.lang.String	CaseChangeEntryHandler.handleDn(Connection conn, SearchRequest request, SearchEntry entry)
protected java.lang.String	AbstractSearchEntryHandler.handleDn(Connection conn, SearchRequest request, SearchEntry entry) Handle the dn of a search entry.
void	SearchReferenceHandler.initializeRequest(SearchRequest request) Initialize the search request for use with this reference handler.
void	SearchEntryHandler.initializeRequest(SearchRequest request) Initialize the search request for use with this entry handler.
void	AbstractSearchEntryHandler.initializeRequest(SearchRequest request)

Uses of SearchRequest in org.ldaptive.jaas

Fields in org.ldaptive.jaas declared as SearchRequest

Modifier and Type	Field and Description
private SearchRequest	LdapRoleAuthorizationModule.searchRequest Search request to use for roles.

Methods in org.ldaptive.jaas that return SearchRequest

Modifier and Type	Method and Description
SearchRequest	RoleResolverFactory.createSearchRequest(java.util.Map<java.lang.String,?> jaasOptions) Creates a new search request with the supplied JAAS options.
SearchRequest	PropertiesRoleResolverFactory.createSearchRequest(java.util.Map<java.lang.String,?> jaasOptions)

Methods in org.ldaptive.jaas with parameters of type SearchRequest

Modifier and Type	Method and Description
java.util.Set<LdapRole>	AbstractSearchRoleResolver.search(SearchRequest request)
java.util.Set<LdapRole>	RoleResolver.search(SearchRequest request) Executes a search request and converts any attributes to ldap roles.

Uses of SearchRequest in org.ldaptive.pool

Fields in org.ldaptive.pool declared as SearchRequest

Modifier and Type	Field and Description
private SearchRequest	SearchValidator.searchRequest Search request to perform validation with.

Methods in org.ldaptive.pool that return SearchRequest

Modifier and Type	Method and Description
SearchRequest	SearchValidator.getSearchRequest() Returns the search request.

Methods in org.ldaptive.pool with parameters of type SearchRequest

Modifier and Type	Method and Description
void	SearchValidator.setSearchRequest(SearchRequest sr) Sets the search request.

Constructors in org.ldaptive.pool with parameters of type SearchRequest

Constructor and Description
SearchValidator(SearchRequest sr) Creates a new search validator.

Uses of SearchRequest in org.ldaptive.props

Constructors in org.ldaptive.props with parameters of type SearchRequest

Constructor and Description
SearchRequestPropertySource(SearchRequest request) Creates a new search request property source using the default properties file.
SearchRequestPropertySource(SearchRequest request, java.util.Properties props) Creates a new search request property source.
SearchRequestPropertySource(SearchRequest request, PropertySource.PropertyDomain domain, java.util.Properties props) Creates a new search request property source.
SearchRequestPropertySource(SearchRequest request, java.io.Reader... readers) Creates a new search request property source.
SearchRequestPropertySource(SearchRequest request, java.lang.String... paths) Creates a new search request property source.

Uses of SearchRequest in org.ldaptive.provider

Methods in org.ldaptive.provider with parameters of type SearchRequest

Modifier and Type	Method and Description
SearchIterator	ProviderConnection.search(SearchRequest request) Search the ldap.
void	ProviderConnection.searchAsync(SearchRequest request, SearchListener listener) Search the ldap asynchronously.

Uses of SearchRequest in org.ldaptive.provider.jndi

Fields in org.ldaptive.provider.jndi declared as SearchRequest

Modifier and Type	Field and Description
private SearchRequest	JndiConnection.JndiSearchIterator.request Search request.

Methods in org.ldaptive.provider.jndi with parameters of type SearchRequest

Modifier and Type	Method and Description
protected javax.naming.directory.SearchControls	JndiConnection.JndiSearchIterator.getSearchControls(SearchRequest sr) Returns a search controls object configured with the supplied search request.
protected java.lang.String	JndiConnection.JndiSearchIterator.getSearchDn(javax.naming.ldap.LdapContext ctx, SearchRequest sr) Determines the DN of the supplied search request.
protected void	JndiConnection.JndiSearchIterator.initializeSearchContext(javax.naming.ldap.LdapContext ctx, SearchRequest sr) Adds any additional environment properties found in the supplied request to the supplied context.
protected javax.naming.NamingEnumeration<javax.naming.directory.SearchResult>	JndiConnection.JndiSearchIterator.search(javax.naming.ldap.LdapContext ctx, SearchRequest sr) Executes DirContext.search( javax.naming.Name, String, Object[], SearchControls).
SearchIterator	JndiConnection.search(SearchRequest request)
void	JndiConnection.searchAsync(SearchRequest request, SearchListener listener)

Constructors in org.ldaptive.provider.jndi with parameters of type SearchRequest

Constructor and Description
JndiSearchIterator(SearchRequest sr) Creates a new jndi search iterator.

Uses of SearchRequest in org.ldaptive.referral

Methods in org.ldaptive.referral that return SearchRequest

Modifier and Type	Method and Description
protected SearchRequest	SearchReferralHandler.createReferralRequest(SearchRequest request, LdapURL url)

Methods in org.ldaptive.referral that return types with arguments of type SearchRequest

Modifier and Type	Method and Description
protected Operation<SearchRequest,SearchResult>	SearchReferralHandler.createReferralOperation(Connection conn)

Methods in org.ldaptive.referral with parameters of type SearchRequest

Modifier and Type	Method and Description
protected SearchRequest	SearchReferralHandler.createReferralRequest(SearchRequest request, LdapURL url)
HandlerResult<SearchReference>	SearchReferralHandler.SearchReferenceHandler.handle(Connection conn, SearchRequest request, SearchReference reference)
void	SearchReferralHandler.initializeRequest(SearchRequest request)
void	SearchReferralHandler.SearchReferenceHandler.initializeRequest(SearchRequest request)