org.ldaptive.servlets

Interface ServletSearchExecutor

All Known Implementing Classes:

AbstractServletSearchExecutor, AbstractServletSearchTemplatesExecutor, AttributeValueServletSearchExecutor, Dsmlv1ServletSearchExecutor, Dsmlv1ServletSearchTemplatesExecutor, JsonServletSearchTemplatesExecutor, LdifServletSearchExecutor, LdifServletSearchTemplatesExecutor

public interface ServletSearchExecutor

Interface to encapsulate servlet search operations.

Method Summary

Modifier and Type	Method and Description
void	close() Closes any resources associated with this servlet search executor.
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.

Method Detail

initialize

void initialize(javax.servlet.ServletConfig config)

Prepares this servlet search executor for use.

Parameters:

config - to initialize this object with

search

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

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

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

java.io.IOException - if an error occurs writing to the response

close

void close()

Closes any resources associated with this servlet search executor.