org.ldaptive.servlets

Class AbstractServletSearchTemplatesExecutor

java.lang.Object

org.ldaptive.templates.SearchTemplatesExecutor

org.ldaptive.servlets.AbstractServletSearchTemplatesExecutor

All Implemented Interfaces:

ServletSearchExecutor

Direct Known Subclasses:

Dsmlv1ServletSearchTemplatesExecutor, JsonServletSearchTemplatesExecutor, LdifServletSearchTemplatesExecutor

public abstract class AbstractServletSearchTemplatesExecutor
extends SearchTemplatesExecutor
implements ServletSearchExecutor

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 static String	DEFAULT_SPRING_CONTEXT_PATH Default spring context path.
private static String	IGNORE_PATTERN Ignore pattern.
private Pattern	ignorePattern Regex pattern to ignore a query.
private static String	MINIMUM_QUERY_TERM_LENGTH Minimum query term length.
private int	minimumQueryTermLength Minimum length for at least one query term.
private static String	SPRING_CONTEXT_PATH Spring context path.

Fields inherited from class org.ldaptive.templates.SearchTemplatesExecutor

logger

Constructor Summary

Constructors

Constructor and Description
AbstractServletSearchTemplatesExecutor()

Method Summary

Modifier and Type	Method and Description
void	initialize(javax.servlet.ServletConfig config) Prepares this servlet search executor for use.
void	search(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Reads parameters from the request, performs an ldap search, and writes the result to the response.
protected abstract void	writeResponse(SearchResult result, javax.servlet.http.HttpServletResponse response) Writes the supplied search result to the servlet response output stream.

Methods inherited from class org.ldaptive.templates.SearchTemplatesExecutor

close, getConnectionFactories, getSearchExecutor, getSearchTemplates, search, search, setConnectionFactories, setSearchExecutor, setSearchTemplates, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ldaptive.servlets.ServletSearchExecutor

close

Field Detail

SPRING_CONTEXT_PATH

private static final String SPRING_CONTEXT_PATH

Spring context path.

See Also:

Constant Field Values

DEFAULT_SPRING_CONTEXT_PATH

private static final String DEFAULT_SPRING_CONTEXT_PATH

Default spring context path.

See Also:

Constant Field Values

IGNORE_PATTERN

private static final String IGNORE_PATTERN

Ignore pattern.

See Also:

Constant Field Values

MINIMUM_QUERY_TERM_LENGTH

private static final String MINIMUM_QUERY_TERM_LENGTH

Minimum query term length.

See Also:

Constant Field Values

ignorePattern

private Pattern ignorePattern

Regex pattern to ignore a query.

minimumQueryTermLength

private int minimumQueryTermLength

Minimum length for at least one query term.

Constructor Detail

AbstractServletSearchTemplatesExecutor

public AbstractServletSearchTemplatesExecutor()

Method Detail

initialize

public void initialize(javax.servlet.ServletConfig config)

Description copied from interface: ServletSearchExecutor

Prepares this servlet search executor for use.

Specified by:

initialize in interface ServletSearchExecutor

Parameters:

config - to initialize this object with

search

public void search(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws LdapException,
                   IOException

Description copied from interface: ServletSearchExecutor

Reads parameters from the request, performs an ldap search, and writes the result to the response.

Specified by:

search in interface ServletSearchExecutor

Parameters:

request - servlet request to read search parameters from

response - servlet response to write ldap search result to

Throws:

LdapException - if an error occurs performing the search

IOException - if an error occurs writing to the response

writeResponse

protected abstract void writeResponse(SearchResult result,
                                      javax.servlet.http.HttpServletResponse response)
                               throws IOException

Writes the supplied search result to the servlet response output stream.

Parameters:

result - search result to write

response - to write to

Throws:

IOException - if an error occurs writing to the response