org.ldaptive.servlets

Class SearchServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.ldaptive.servlets.SearchServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public final class SearchServlet
extends javax.servlet.http.HttpServlet

Queries an LDAP and returns the result in the servlet response. The following init params can be set for this servlet:

• poolType - BLOCKING or SOFTLIMIT
• searchExecutorClass - fully qualified class name that implements ServletSearchExecutor

All other init params will set properties on:

• SearchRequest
• ConnectionConfig
• PoolConfig

Example: http://www.server.com/Search?query=uid=dfisher If you need to pass complex queries, such as (&(cn=daniel*)(surname=fisher)), then the query must be form encoded. If you only want to receive a subset of attributes those can be specified. Example: http://www.server.com/Search?query=uid=dfisher&attrs=givenname&attrs=surname

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger Logger for this class.
private static java.lang.String	SEARCH_EXECUTOR_CLASS Custom search executor implementation, value is "searchExecutorClass".
private ServletSearchExecutor	searchExecutor Parses servlet requests and performs search operations.
private static long	serialVersionUID serial version uid.

Constructor Summary

Constructors

Constructor and Description
SearchServlet()

Method Summary

Modifier and Type	Method and Description
void	destroy()
void	init(javax.servlet.ServletConfig config)
void	service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

SEARCH_EXECUTOR_CLASS

private static final java.lang.String SEARCH_EXECUTOR_CLASS

Custom search executor implementation, value is "searchExecutorClass".

See Also:

Constant Field Values

serialVersionUID

private static final long serialVersionUID

serial version uid.

See Also:

Constant Field Values

logger

protected final org.slf4j.Logger logger

Logger for this class.

searchExecutor

private ServletSearchExecutor searchExecutor

Parses servlet requests and performs search operations.

Constructor Detail

SearchServlet

public SearchServlet()

Method Detail

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

service

public void service(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws javax.servlet.ServletException,
                    java.io.IOException

Overrides:

service in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet