org.locomotive.loco.servlet
Class UnavailableServlet

java.lang.Object
  |
  +--javax.servlet.GenericServlet
        |
        +--javax.servlet.http.HttpServlet
              |
              +--org.locomotive.servlets.MultiThreadedHttpServlet
                    |
                    +--org.locomotive.loco.servlet.MultiThreadedLocoServlet
                          |
                          +--org.locomotive.loco.servlet.UnavailableServlet

public class UnavailableServlet
extends MultiThreadedLocoServlet

This servlet is invoked when a servlet being requested is currently unavailable (temporarily or permanently). It returns the template LOCO_TEMPLATE_ROOT_PATH/error/service_unavailable.tmpl, or, if that template is missing, a similar warning message is sent. This servlet is a multithreaded servlet.

Author:
Jason Brittain
See Also:
Serialized Form

Field Summary
static java.lang.String PERMANENT_STRING
           
static java.lang.String REASON_ATTRIBUTE_NAME
          The request attribute name String for the unavailability reason.
static java.lang.String SECONDS_ATTRIBUTE_NAME
          The request attribute name String for the unavailability seconds.
static java.lang.String STATUS_ATTRIBUTE_NAME
          The request attribute name String for the unavailability status.
static java.lang.String TEMPORARY_STRING
           
static java.lang.String TIMESTAMP_ATTRIBUTE_NAME
          The request attribute name String for the event timestamp.
 
Fields inherited from class org.locomotive.loco.servlet.MultiThreadedLocoServlet
DEBUG, ERROR, NORMAL, WARNING
 
Constructor Summary
UnavailableServlet()
           
 
Method Summary
 void doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          This method is run for each request to this servlet.
 void doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          This method just calls doGet(request, response).
 
Methods inherited from class org.locomotive.loco.servlet.MultiThreadedLocoServlet
displayPage, getConnection, getFormData, getSteamVars, getURLTokens, getUser, log, logEvent, service
 
Methods inherited from class org.locomotive.servlets.MultiThreadedHttpServlet
displayString, exceptionStackTrace, handleException, sayBadURL
 
Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doOptions, doPut, doTrace, getLastModified, service
 
Methods inherited from class javax.servlet.GenericServlet
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, init, init, log, log
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STATUS_ATTRIBUTE_NAME

public static final java.lang.String STATUS_ATTRIBUTE_NAME
The request attribute name String for the unavailability status.

SECONDS_ATTRIBUTE_NAME

public static final java.lang.String SECONDS_ATTRIBUTE_NAME
The request attribute name String for the unavailability seconds.

REASON_ATTRIBUTE_NAME

public static final java.lang.String REASON_ATTRIBUTE_NAME
The request attribute name String for the unavailability reason.

TIMESTAMP_ATTRIBUTE_NAME

public static final java.lang.String TIMESTAMP_ATTRIBUTE_NAME
The request attribute name String for the event timestamp.

TEMPORARY_STRING

public static final java.lang.String TEMPORARY_STRING

PERMANENT_STRING

public static final java.lang.String PERMANENT_STRING
Constructor Detail

UnavailableServlet

public UnavailableServlet()
Method Detail

doGet

public void doGet(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws javax.servlet.ServletException,
                  java.io.IOException
This method is run for each request to this servlet. It uses the LOCO_TEMPLATE_ROOT_PATH/error/service_unavailable.tmpl template. LOCO_TEMPLATE_ROOT_PATH is the template directory, as specified in the Locomotive's configuration.
Overrides:
doGet in class javax.servlet.http.HttpServlet

doPost

public void doPost(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws javax.servlet.ServletException,
                   java.io.IOException
This method just calls doGet(request, response).
Overrides:
doPost in class javax.servlet.http.HttpServlet