edu.ucsb.adl.middleware
Class CollectionAvailabilityServlet

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

All Implemented Interfaces:

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

public final class CollectionAvailabilityServlet

extends javax.servlet.http.HttpServlet

Servlet that allows a collection to be enabled or disabled. The servlet is invoked by an HTTP GET request containing two URL-encoded parameters: op, the operation to perform, which must be "enable" or "disable"; and collection, the name of a collection. If the URL of this servlet is S, then an example of a complete URL might be:

S?op=enable&collection=adl_catalog

The successful HTTP status code is 200 (OK). Error status codes include 400 (bad request) and 500 (internal server error).

Version:

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

$Log: CollectionAvailabilityServlet.java,v $ Revision 1.3 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.2 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.1 2002/09/26 04:14:22 gjanee
Initial revision

Author:

Greg Janée
Alexandria Digital Library

See Also:

Serialized Form

Constructor Summary

CollectionAvailabilityServlet()
Creates a CollectionAvailabilityServlet.

Method Summary

void	destroy() Frees all resources held by the servlet.
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Performs the HTTP GET service described above.
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

CollectionAvailabilityServlet

public CollectionAvailabilityServlet()

Creates a CollectionAvailabilityServlet.

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 an 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

Performs the HTTP GET service described above.

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