edu.vt.middleware.ldap.servlets

Class SearchServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

edu.vt.middleware.ldap.servlets.SearchServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

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

SearchServlet is a servlet which queries an LDAP and returns the result as LDIF or DSML. The following init params can be set for this servlet: edu.vt.middleware.ldap.servlets.propertiesFile - to load ldap properties from edu.vt.middleware.ldap.servlets.outputFormat - type of output to produce, 'ldif' or 'dsml' 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

LDIF

The content returned by the servlet is of type text/plain.

DSML

The content returned by the servlet is of type text/xml, if you want to receive the content as text/plain that can be specified as well. Example: http://www.server.com/Search?query=uid=dfisher&content-type=text By default DSML version 1 is returned, if you want to receive DSML version 2 then you must pass in the dsml-version parameter. Example: http://www.server.com/Search?query=uid=dfisher&dsml-version=2

Version:

$Revision: 1330 $ $Date: 2010-05-24 00:10:53 +0200 (Mon, 24 May 2010) $

Author:

Middleware Services

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchServlet()

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Called by the servlet container to indicate to a servlet that the servlet is being taken out of service.
void	init(javax.servlet.ServletConfig config) Initialize this servlet.
void	service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handle all requests sent to this servlet.

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

Constructor Detail

SearchServlet

public SearchServlet()

Method Detail

init

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

Initialize this servlet.

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Parameters:

config - ServletConfig

Throws:

javax.servlet.ServletException - if an error occurs

service

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

Handle all requests sent to this servlet.

Overrides:

service in class javax.servlet.http.HttpServlet

Parameters:

request - HttpServletRequest

response - HttpServletResponse

Throws:

javax.servlet.ServletException - if an error occurs

IOException - if an error occurs

destroy

public void destroy()

Called by the servlet container to indicate to a servlet that the servlet is being taken out of service.

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet