org.atmosphere.cpr
Interface CometSupport

All Known Implementing Classes:

BlockingIOCometSupport, GlassFishv2CometSupport, GlassFishv3CometSupport, GrizzlyCometSupport, JettyCometSupport, Servlet30Support, TomcatCometSupport, WebLogicCometSupport

public interface CometSupport

Atmosphere's supported WebServer must implement this interface in order to be auto detected by the AtmosphereServlet. If the AtmosphereServlet fail to detect the CometSupport, it will use a blocking thread approach to emulate Comet using the BlockingIOCometSupport

Author:

Jeanfrancois Arcand

Method Summary

String	getContainerDottedVersion() Return the supported version of the Java Web Server
String	getContainerName() Return the name of the Java Web Server.
void	init(ServletConfig sc) Initialize the WebServer using the ServletConfig
AtmosphereServlet.Action	service(HttpServletRequest req, HttpServletResponse res) Serve the HttpServletRequest and the HttpServletResponse.

Method Detail

getContainerName

String getContainerName()

Return the name of the Java Web Server.

Returns:

the name of the Java Web Server.

getContainerDottedVersion

String getContainerDottedVersion()

Return the supported version of the Java Web Server

Returns:

the supported version of the Java Web Server

init

void init(ServletConfig sc)
          throws ServletException

Initialize the WebServer using the ServletConfig

Parameters:

sc - the ServletConfig

Throws:

ServletException

service

AtmosphereServlet.Action service(HttpServletRequest req,
                                 HttpServletResponse res)
                                 throws IOException,
                                        ServletException

Serve the HttpServletRequest and the HttpServletResponse.

Parameters:

req - the HttpServletRequest

res - the HttpServletResponse

Returns:

the AtmosphereServlet.Action that was manipulated by the AtmosphereHandler

Throws:

IOException

ServletException