org.ldaptive.templates

Class SearchTemplatesExecutor

java.lang.Object

org.ldaptive.templates.SearchTemplatesExecutor

Direct Known Subclasses:

AbstractServletSearchTemplatesExecutor

public class SearchTemplatesExecutor
extends java.lang.Object

Searches an LDAP using a defined set of search templates. For each term count some number of templates are defined and used for searching.

Field Summary

Fields

Modifier and Type	Field and Description
private PooledConnectionFactory[]	connectionFactories Connection factory.
protected org.slf4j.Logger	logger Logger for this class.
private AggregatePooledSearchExecutor	searchExecutor Search executor.
private SearchTemplates[]	searchTemplates Search templates.

Constructor Summary

Constructors

Constructor and Description
SearchTemplatesExecutor() Default constructor.
SearchTemplatesExecutor(AggregatePooledSearchExecutor executor, PooledConnectionFactory[] factories, SearchTemplates... templates) Creates a new templates search executor.

Method Summary

Modifier and Type	Method and Description
void	close() Closes any resources associated with this object.
PooledConnectionFactory[]	getConnectionFactories() Returns the connection factories.
AggregatePooledSearchExecutor	getSearchExecutor() Returns the search executor.
SearchTemplates[]	getSearchTemplates() Returns the search templates.
SearchResult	search(Query query) Applies the supplied query to a search templates and aggregates all results into a single search result.
protected SearchResult	search(SearchFilter[] filters, java.lang.String[] returnAttrs, java.lang.Integer fromResult, java.lang.Integer toResult) Performs an LDAP search with the supplied filters and aggregates all the search results together.
void	setConnectionFactories(PooledConnectionFactory[] factories) Sets the connection factories.
void	setSearchExecutor(AggregatePooledSearchExecutor executor) Sets the search executor.
void	setSearchTemplates(SearchTemplates[] templates) Sets the search templates.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

logger

protected final org.slf4j.Logger logger

Logger for this class.

searchExecutor

private AggregatePooledSearchExecutor searchExecutor

Search executor.

connectionFactories

private PooledConnectionFactory[] connectionFactories

Connection factory.

searchTemplates

private SearchTemplates[] searchTemplates

Search templates.

Constructor Detail

SearchTemplatesExecutor

public SearchTemplatesExecutor()

Default constructor.

SearchTemplatesExecutor

public SearchTemplatesExecutor(AggregatePooledSearchExecutor executor,
                               PooledConnectionFactory[] factories,
                               SearchTemplates... templates)

Creates a new templates search executor.

Parameters:

executor - aggregate pooled search executor

factories - pooled connection factories

templates - search templates

Method Detail

getSearchExecutor

public AggregatePooledSearchExecutor getSearchExecutor()

Returns the search executor.

Returns:

aggregate pooled search executor

setSearchExecutor

public void setSearchExecutor(AggregatePooledSearchExecutor executor)

Sets the search executor.

Parameters:

executor - aggregate pooled search executor

getConnectionFactories

public PooledConnectionFactory[] getConnectionFactories()

Returns the connection factories.

Returns:

pooled connection factories

setConnectionFactories

public void setConnectionFactories(PooledConnectionFactory[] factories)

Sets the connection factories.

Parameters:

factories - pooled connection factory

getSearchTemplates

public SearchTemplates[] getSearchTemplates()

Returns the search templates.

Returns:

search templates

setSearchTemplates

public void setSearchTemplates(SearchTemplates[] templates)

Sets the search templates.

Parameters:

templates - search templates

search

public SearchResult search(Query query)
                    throws LdapException

Applies the supplied query to a search templates and aggregates all results into a single search result.

Parameters:

query - to execute

Returns:

ldap result

Throws:

LdapException - if the search fails

search

protected SearchResult search(SearchFilter[] filters,
                              java.lang.String[] returnAttrs,
                              java.lang.Integer fromResult,
                              java.lang.Integer toResult)
                       throws LdapException

Performs an LDAP search with the supplied filters and aggregates all the search results together.

Parameters:

filters - to execute

returnAttrs - attributes to return from the search

fromResult - index to return results from

toResult - index to return results to

Returns:

ldap result containing all results

Throws:

LdapException - if the search fails

close

public void close()

Closes any resources associated with this object.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object