Package org.atmosphere.cpr

Class AtmosphereServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

org.atmosphere.cpr.AtmosphereServlet

All Implemented Interfaces:

Servlet, ServletConfig, Serializable

public class AtmosphereServlet
extends HttpServlet

AtmosphereServlet that use Servlet 3.0 Async API when available, and fallback to native comet support if not available. For Tomcat6/7 and JBossWeb Native support, use atmosphere-native dependencies instead.

If Servlet 3.0 or native API isn't found, Atmosphere will use BlockingIOCometSupport.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final AtmosphereFrameworkInitializer	initializer
protected static final org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor	Description
AtmosphereServlet()	Create an Atmosphere Servlet.
AtmosphereServlet(boolean isFilter)	Create an Atmosphere Servlet.
AtmosphereServlet(boolean isFilter, boolean autoDetectHandlers)	Create an Atmosphere Servlet.

Method Summary

Modifier and Type	Method	Description
protected AtmosphereServlet	configureFramework(ServletConfig sc)
protected AtmosphereServlet	configureFramework(ServletConfig sc, boolean init)
void	destroy()
void	doDelete(HttpServletRequest req, HttpServletResponse res)	Delegate the request processing to an instance of AsyncSupport.
void	doGet(HttpServletRequest req, HttpServletResponse res)	Delegate the request processing to an instance of AsyncSupport.
void	doHead(HttpServletRequest req, HttpServletResponse res)	Delegate the request processing to an instance of AsyncSupport.
void	doOptions(HttpServletRequest req, HttpServletResponse res)	Delegate the request processing to an instance of AsyncSupport
void	doPost(HttpServletRequest req, HttpServletResponse res)	Delegate the request processing to an instance of AsyncSupport.
void	doPut(HttpServletRequest req, HttpServletResponse res)	Delegate the request processing to an instance of AsyncSupport.
void	doTrace(HttpServletRequest req, HttpServletResponse res)	Delegate the request processing to an instance of AsyncSupport.
AtmosphereFramework	framework()
void	init(ServletConfig sc)
protected AtmosphereFramework	newAtmosphereFramework()

Methods inherited from class jakarta.servlet.http.HttpServlet

getLastModified, service, service

Methods inherited from class jakarta.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

Field Details

logger

protected static final org.slf4j.Logger logger

initializer

protected final AtmosphereFrameworkInitializer initializer

Constructor Details

AtmosphereServlet

public AtmosphereServlet()

Create an Atmosphere Servlet.

AtmosphereServlet

public AtmosphereServlet(boolean isFilter)

Create an Atmosphere Servlet.

Parameters:

isFilter - true if this instance is used as an AtmosphereFilter

AtmosphereServlet

public AtmosphereServlet(boolean isFilter,
 boolean autoDetectHandlers)

Create an Atmosphere Servlet.

Parameters:

isFilter - true if this instance is used as an AtmosphereFilter

Method Details

destroy

public void destroy()

Specified by:

destroy in interface Servlet

Overrides:

destroy in class GenericServlet

init

public void init(ServletConfig sc)
          throws ServletException

Specified by:

init in interface Servlet

Overrides:

init in class GenericServlet

Throws:

ServletException

configureFramework

protected AtmosphereServlet configureFramework(ServletConfig sc)
                                        throws ServletException

Throws:

ServletException

configureFramework

protected AtmosphereServlet configureFramework(ServletConfig sc,
 boolean init)
                                        throws ServletException

Throws:

ServletException

newAtmosphereFramework

protected AtmosphereFramework newAtmosphereFramework()

framework

public AtmosphereFramework framework()

doHead

public void doHead(HttpServletRequest req,
 HttpServletResponse res)
            throws IOException,
ServletException

Delegate the request processing to an instance of AsyncSupport.

Overrides:

doHead in class HttpServlet

Parameters:

req - the HttpServletRequest

res - the HttpServletResponse

Throws:

IOException

ServletException

doOptions

public void doOptions(HttpServletRequest req,
 HttpServletResponse res)
               throws IOException,
ServletException

Delegate the request processing to an instance of AsyncSupport

Overrides:

doOptions in class HttpServlet

Parameters:

req - the HttpServletRequest

res - the HttpServletResponse

Throws:

IOException

ServletException

doTrace

public void doTrace(HttpServletRequest req,
 HttpServletResponse res)
             throws IOException,
ServletException

Delegate the request processing to an instance of AsyncSupport.

Overrides:

doTrace in class HttpServlet

Parameters:

req - the HttpServletRequest

res - the HttpServletResponse

Throws:

IOException

ServletException

doDelete

public void doDelete(HttpServletRequest req,
 HttpServletResponse res)
              throws IOException,
ServletException

Delegate the request processing to an instance of AsyncSupport.

Overrides:

doDelete in class HttpServlet

Parameters:

req - the HttpServletRequest

res - the HttpServletResponse

Throws:

IOException

ServletException

doPut

public void doPut(HttpServletRequest req,
 HttpServletResponse res)
           throws IOException,
ServletException

Delegate the request processing to an instance of AsyncSupport.

Overrides:

doPut in class HttpServlet

Parameters:

req - the HttpServletRequest

res - the HttpServletResponse

Throws:

IOException

ServletException

doGet

public void doGet(HttpServletRequest req,
 HttpServletResponse res)
           throws IOException,
ServletException

Delegate the request processing to an instance of AsyncSupport.

Overrides:

doGet in class HttpServlet

Parameters:

req - the HttpServletRequest

res - the HttpServletResponse

Throws:

IOException

ServletException

doPost

public void doPost(HttpServletRequest req,
 HttpServletResponse res)
            throws IOException,
ServletException

Delegate the request processing to an instance of AsyncSupport.

Overrides:

doPost in class HttpServlet

Parameters:

req - the HttpServletRequest

res - the HttpServletResponse

Throws:

IOException

ServletException