org.apache.tomcat.bayeux

Class BayeuxServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.tomcat.bayeux.BayeuxServlet

All Implemented Interfaces:

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

public class BayeuxServlet
extends javax.servlet.http.HttpServlet
implements HttpEventServlet

Version:

1.0

Author:

Filip Hanik, Guy Molinari

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	reconnectInterval The reconnect interval.
protected TomcatBayeux	tb Reference to the global TomcatBayeux object
protected int	timeout The timeout.
static String	TOMCAT_BAYEUX_ATTR Attribute to hold the TomcatBayeux object in the servlet context

Constructor Summary

Constructors

Constructor and Description
BayeuxServlet()

Method Summary

Modifier and Type	Method and Description
protected void	checkBayeux(HttpEvent cometEvent)
void	destroy() Upon servlet destruction, the servlet will clean up the TomcatBayeux object and terminate any outstanding events.
void	event(HttpEvent cometEvent) Process the given IO event.
protected int	getReconnectInterval()
String	getServletInfo()
protected int	getTimeout() Returns the preconfigured connection timeout.
protected int	handleBayeux(String message, HttpEvent event)
void	init()
void	service(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)

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, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.Servlet

getServletConfig, init

Field Detail

timeout

protected int timeout

The timeout.

reconnectInterval

protected int reconnectInterval

The reconnect interval.

TOMCAT_BAYEUX_ATTR

public static final String TOMCAT_BAYEUX_ATTR

Attribute to hold the TomcatBayeux object in the servlet context

See Also:

Constant Field Values

tb

protected TomcatBayeux tb

Reference to the global TomcatBayeux object

Constructor Detail

BayeuxServlet

public BayeuxServlet()

Method Detail

destroy

public void destroy()

Upon servlet destruction, the servlet will clean up the TomcatBayeux object and terminate any outstanding events.

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet

getTimeout

protected int getTimeout()

Returns the preconfigured connection timeout. If no timeout has been configured as a servlet init parameter named timeout then the default of 2min will be used.

Returns:

int - the timeout for a connection in milliseconds

getReconnectInterval

protected int getReconnectInterval()

event

public void event(HttpEvent cometEvent)
           throws IOException,
                  javax.servlet.ServletException

Description copied from interface: HttpEventServlet

Process the given IO event.

Specified by:

event in interface HttpEventServlet

Parameters:

cometEvent - The event that will be processed

Throws:

IOException

javax.servlet.ServletException

checkBayeux

protected void checkBayeux(HttpEvent cometEvent)
                    throws IOException,
                           UnsupportedOperationException

Parameters:

cometEvent - CometEvent

Throws:

IOException

UnsupportedOperationException

handleBayeux

protected int handleBayeux(String message,
                           HttpEvent event)
                    throws IOException,
                           javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

getServletInfo

public String getServletInfo()

Specified by:

getServletInfo in interface javax.servlet.Servlet

Overrides:

getServletInfo in class javax.servlet.GenericServlet

init

public void init()
          throws javax.servlet.ServletException

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

service

public void service(javax.servlet.ServletRequest servletRequest,
                    javax.servlet.ServletResponse servletResponse)
             throws javax.servlet.ServletException,
                    IOException

Specified by:

service in interface javax.servlet.Servlet

Overrides:

service in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException