edu.ucsb.adl.middleware
Class ReferenceServlet

java.lang.Object
  |
  +--javax.servlet.GenericServlet
        |
        +--javax.servlet.http.HttpServlet
              |
              +--edu.ucsb.adl.middleware.ReferenceServlet

All Implemented Interfaces:

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

public final class ReferenceServlet

extends javax.servlet.http.HttpServlet

HTTP interface to the ADL reference service. The reference service can be accessed by an HTTP GET request containing three URL-encoded parameters: baseurl, the remote middleware server's base URL; collection, the name of the remote collection to reference; and localname, the local name for the remote collection. localname is optional, and if not specified or if empty it defaults to the remote name. If the URL of this servlet is S, then an example of a complete URL might be:

S?baseurl=rmi://host.com/middleware/&collection=adl_catalog&localname=foo

The return HTTP status code is 200 (OK) upon success.

Service exceptions are caught and returned as HTTP errors. In particular, BadRequestException is mapped to 400 (bad request), NoAuthorizationException is mapped to 403 (forbidden), and InternalErrorException is mapped to 500 (internal server error).

Version:

$Header: /export/home/gjanee/middleware/edu/ucsb/adl/middleware/RCS/ReferenceServlet.java,v 1.4 2006/06/21 18:07:58 gjanee Exp $

$Log: ReferenceServlet.java,v $ Revision 1.4 2006/06/21 18:07:58 gjanee
To make web browsers a little happier, servlets that formerly returned HTTP status code 204 (no content) now return status code 200 (OK) and return the plain text "DONE\n".

Revision 1.3 2004/03/02 22:01:48 gjanee
If the middleware_configuration_file servlet initialization parameter is not available, we now look for it as a context-wide initialization parameter.

Revision 1.2 2001/10/04 18:24:17 gjanee
To support the middleware being a web application, we now allow the location of the middleware configuration file to be specified relative to the web application directory.

Revision 1.1 2001/09/14 04:30:47 gjanee
Initial revision

Author:

Greg Janée
Alexandria Digital Library

See Also:

Serialized Form

Constructor Summary

ReferenceServlet()
Creates a ReferenceServlet.

Method Summary

void	destroy() Frees all resources held by the servlet.
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) HTTP GET interface to the ADL reference service.
void	init(javax.servlet.ServletConfig config) Initializes the servlet.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, 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

ReferenceServlet

public ReferenceServlet()

Creates a ReferenceServlet.

Method Detail

init

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

Initializes the servlet.

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Parameters:

config - Must contain the following initialization parameter: middleware_configuration_file, the filename of the ADL middleware configuration file. If the filename is not absolute, it is interpreted relative to the middleware web application directory.

Throws:

javax.servlet.UnavailableException - If the initialization fails.

javax.servlet.ServletException

doGet

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

HTTP GET interface to the ADL reference service. This method is multithread-safe.

Overrides:

doGet in class javax.servlet.http.HttpServlet

Parameters:

request - The HTTP request.

response - The HTTP response.

Throws:

java.io.IOException - On any I/O error.

destroy

public void destroy()

Frees all resources held by the servlet.

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet