org.patrodyne.timer.httptask

Class HttpTaskServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.patrodyne.timer.httptask.HttpTaskServlet

All Implemented Interfaces:

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

public class HttpTaskServlet
extends javax.servlet.http.HttpServlet

A servlet to initiate Timer managed tasks and invoke HTTP endpoints on a periodic schedule. Tasks are configured from properties provided at the JNDI path, java:comp/env/timer/httptask. Each JDNI property provides a key (job name) and value TYPE|DELAY|PERIOD|URL where TYPE = FD (fixed delay) or FR (fixed rate) DELAY = initial offset in milliseconds PERIOD = time between invocations in milliseconds URL = an HTTP endpoint.

Author:

Rick O'Sullivan

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HttpTaskServlet()

Method Summary

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	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Called by the server (via the service method) to allow a servlet to handle a GET request.
Properties	getJobs() Get the task properties.
List<HttpTask>	getTasks() Get the list of HTTP tasks.
Timer	getTimer() Get a facility to schedule jobs.
void	init(javax.servlet.ServletConfig config) Called by the servlet container to indicate to a servlet that the servlet is being placed into service.
int	nextTaskIndex() Next circular task taskIndex.
void	setJobs(Properties jobs) Set the task properties.
void	setTasks(List<HttpTask> tasks) Set the list of HTTP tasks.

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

HttpTaskServlet

public HttpTaskServlet()

Method Detail

getJobs

public Properties getJobs()
                   throws NamingException

Get the task properties.

Returns:

the jobs properties.

Throws:

NamingException

setJobs

public void setJobs(Properties jobs)

Set the task properties.

Parameters:

jobs - the jobs to set

getTimer

public Timer getTimer()

Get a facility to schedule jobs.

Returns:

The timer facility.

getTasks

public List<HttpTask> getTasks()

Get the list of HTTP tasks.

Returns:

the HTTP tasks

setTasks

public void setTasks(List<HttpTask> tasks)

Set the list of HTTP tasks.

Parameters:

tasks - the HTTP tasks to set

nextTaskIndex

public int nextTaskIndex()

Next circular task taskIndex.

init

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

Called by the servlet container to indicate to a servlet that the servlet is being placed into service. See Servlet.init(javax.servlet.ServletConfig). This implementation schedules jobs configured in JNDI.

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Parameters:

config - the configuration information for this servlet.

Throws:

javax.servlet.ServletException

doGet

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

Called by the server (via the service method) to allow a servlet to handle a GET request.

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

IOException

destroy

public void destroy()

Called by the servlet container to indicate to a servlet that the servlet is being taken out of service. Cancels and purges tasks managed by the Timer.

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet