org.atmosphere.cpr
Class AtmosphereServlet

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          org.eclipse.jetty.websocket.WebSocketServlet
              weblogic.servlet.http.AbstractAsyncServlet
                  org.atmosphere.cpr.AtmosphereServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, CometProcessor, ServletContextProvider, WebSocketFactory.Acceptor, HttpEventServlet

Direct Known Subclasses:

MeteorServlet

public class AtmosphereServlet
extends AbstractAsyncServlet
implements CometProcessor, HttpEventServlet, ServletContextProvider, CometProcessor

The AtmosphereServlet acts as a dispatcher for AtmosphereHandler defined in META-INF/atmosphere.xml, or if atmosphere.xml is missing, all classes that implements AtmosphereHandler will be discovered and mapped using the class's name.

This Servlet can be defined inside an application's web.xml using the following:

  <servlet>
      <description>AtmosphereServlet</description>
      <servlet-name>AtmosphereServlet</servlet-name>
      <servlet-class>org.atmosphere.cpr.AtmosphereServlet</servlet-class>
      <load-on-startup>0 </load-on-startup>
  </servlet>
  <servlet-mapping>
      <servlet-name>AtmosphereServlet</servlet-name>
      <url-pattern>/Atmosphere </url-pattern>
  </servlet-mapping>
 

You can force this Servlet to use native API of the Web Server instead of the Servlet 3.0 Async API you are deploying on by adding

  <init-param>
      <param-name>org.atmosphere.useNative</param-name>
      <param-value>true</param-value>
  </init-param>
 

You can force this Servlet to use one Thread per connection instead of native API of the Web Server you are deploying on by adding

  <init-param>
      <param-name>org.atmosphere.useBlocking</param-name>
      <param-value>true</param-value>
  </init-param>
 

You can also define Broadcasterby adding:

  <init-param>
      <param-name>org.atmosphere.cpr.broadcasterClass</param-name>
      <param-value>class-name</param-value>
  </init-param>
 

You can also for Atmosphere to use OutputStream for all write operations.

  <init-param>
      <param-name>org.atmosphere.useStream</param-name>
      <param-value>true</param-value>
  </init-param>
 

You can also configure BroadcasterCache that persist message when Browser is disconnected.

  <init-param>
      <param-name>org.atmosphere.cpr.broadcasterCacheClass</param-name>
      <param-value>class-name</param-value>
  </init-param>
 

You can also configure Atmosphere to use http session or not

  <init-param>
      <param-name>org.atmosphere.cpr.sessionSupport</param-name>
      <param-value>false</param-value>
  </init-param>
 

You can also configure BroadcastFilter that will be applied at all newly created Broadcaster

  <init-param>
      <param-name>org.atmosphere.cpr.broadcastFilterClasses</param-name>
      <param-value>BroadcastFilter class name separated by coma</param-value>
  </init-param>
 

All the property available are defined in ApplicationConfig The Atmosphere Framework can also be used as a Servlet Filter (AtmosphereFilter).

If you are planning to use JSP, Servlet or JSF, you can instead use the MeteorServlet, which allow the use of Meteor inside those components.

Author:

Jeanfrancois Arcand

See Also:

Serialized Form

Field Summary

protected AtmosphereFramework

framework

Constructor Summary

AtmosphereServlet()
Create an Atmosphere Servlet.

AtmosphereServlet(boolean isFilter)
Create an Atmosphere Servlet.

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

Method Summary

void	destroy()
void	doDelete(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Delegate the request processing to an instance of CometSupport
void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Delegate the request processing to an instance of CometSupport
void	doHead(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Delegate the request processing to an instance of CometSupport
void	doOptions(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Delegate the request processing to an instance of CometSupport
void	doPost(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Delegate the request processing to an instance of CometSupport
void	doPut(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Delegate the request processing to an instance of CometSupport
protected boolean	doRequest(RequestResponseKey rrk) Weblogic specific comet based implementation.
protected void	doResponse(RequestResponseKey rrk, Object context) Weblogic specific comet based implementation.
protected void	doTimeout(RequestResponseKey rrk) Weblogic specific comet based implementation.
void	doTrace(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Delegate the request processing to an instance of CometSupport
WebSocket	doWebSocketConnect(javax.servlet.http.HttpServletRequest request, String protocol) Jetty 7.2 & 8.0.0-M1/M2and up WebSocket support.
void	event(CometEvent cometEvent) Hack to support Tomcat AIO like other WebServer.
void	event(CometEvent cometEvent) Hack to support Tomcat 7 AIO
void	event(HttpEvent httpEvent) Hack to support JBossWeb AIO like other WebServer.
AtmosphereFramework	framework()
void	init(javax.servlet.ServletConfig sc)

Methods inherited from class weblogic.servlet.http.AbstractAsyncServlet

notify

Methods inherited from class org.eclipse.jetty.websocket.WebSocketServlet

checkOrigin, init, service

Methods inherited from class javax.servlet.http.HttpServlet

getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, log, log

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.atmosphere.di.ServletContextProvider

getServletContext

Methods inherited from interface javax.servlet.Servlet

getServletConfig, getServletInfo, service

Field Detail

framework

protected AtmosphereFramework framework

Constructor Detail

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 Detail

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class WebSocketServlet

init

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

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

framework

public AtmosphereFramework framework()

doHead

public void doHead(javax.servlet.http.HttpServletRequest req,
                   javax.servlet.http.HttpServletResponse res)
            throws IOException,
                   javax.servlet.ServletException

Delegate the request processing to an instance of CometSupport

Overrides:

doHead in class javax.servlet.http.HttpServlet

Parameters:

req - the HttpServletRequest

res - the HttpServletResponse

Throws:

IOException

javax.servlet.ServletException

doOptions

public void doOptions(javax.servlet.http.HttpServletRequest req,
                      javax.servlet.http.HttpServletResponse res)
               throws IOException,
                      javax.servlet.ServletException

Delegate the request processing to an instance of CometSupport

Overrides:

doOptions in class javax.servlet.http.HttpServlet

Parameters:

req - the HttpServletRequest

res - the HttpServletResponse

Throws:

IOException

javax.servlet.ServletException

doTrace

public void doTrace(javax.servlet.http.HttpServletRequest req,
                    javax.servlet.http.HttpServletResponse res)
             throws IOException,
                    javax.servlet.ServletException

Delegate the request processing to an instance of CometSupport

Overrides:

doTrace in class javax.servlet.http.HttpServlet

Parameters:

req - the HttpServletRequest

res - the HttpServletResponse

Throws:

IOException

javax.servlet.ServletException

doDelete

public void doDelete(javax.servlet.http.HttpServletRequest req,
                     javax.servlet.http.HttpServletResponse res)
              throws IOException,
                     javax.servlet.ServletException

Delegate the request processing to an instance of CometSupport

Overrides:

doDelete in class javax.servlet.http.HttpServlet

Parameters:

req - the HttpServletRequest

res - the HttpServletResponse

Throws:

IOException

javax.servlet.ServletException

doPut

public void doPut(javax.servlet.http.HttpServletRequest req,
                  javax.servlet.http.HttpServletResponse res)
           throws IOException,
                  javax.servlet.ServletException

Delegate the request processing to an instance of CometSupport

Overrides:

doPut in class javax.servlet.http.HttpServlet

Parameters:

req - the HttpServletRequest

res - the HttpServletResponse

Throws:

IOException

javax.servlet.ServletException

doGet

public void doGet(javax.servlet.http.HttpServletRequest req,
                  javax.servlet.http.HttpServletResponse res)
           throws IOException,
                  javax.servlet.ServletException

Delegate the request processing to an instance of CometSupport

Overrides:

doGet in class javax.servlet.http.HttpServlet

Parameters:

req - the HttpServletRequest

res - the HttpServletResponse

Throws:

IOException

javax.servlet.ServletException

doPost

public void doPost(javax.servlet.http.HttpServletRequest req,
                   javax.servlet.http.HttpServletResponse res)
            throws IOException,
                   javax.servlet.ServletException

Delegate the request processing to an instance of CometSupport

Overrides:

doPost in class javax.servlet.http.HttpServlet

Parameters:

req - the HttpServletRequest

res - the HttpServletResponse

Throws:

IOException

javax.servlet.ServletException

event

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

Hack to support Tomcat AIO like other WebServer. This method is invoked by Tomcat when it detect a Servlet implements the interface CometProcessor without invoking Servlet.service(javax.servlet.ServletRequest, javax.servlet.ServletResponse)

Parameters:

cometEvent - the CometEvent

Throws:

IOException

javax.servlet.ServletException

event

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

Hack to support Tomcat 7 AIO

Specified by:

event in interface CometProcessor

Throws:

IOException

javax.servlet.ServletException

event

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

Hack to support JBossWeb AIO like other WebServer. This method is invoked by Tomcat when it detect a Servlet implements the interface HttpEventServlet without invoking Servlet.service(javax.servlet.ServletRequest, javax.servlet.ServletResponse)

Specified by:

event in interface HttpEventServlet

Parameters:

httpEvent - the CometEvent

Throws:

IOException

javax.servlet.ServletException

doRequest

protected boolean doRequest(RequestResponseKey rrk)
                     throws IOException,
                            javax.servlet.ServletException

Weblogic specific comet based implementation.

Specified by:

doRequest in class AbstractAsyncServlet

Parameters:

rrk -

Returns:

true if suspended

Throws:

IOException

javax.servlet.ServletException

doResponse

protected void doResponse(RequestResponseKey rrk,
                          Object context)
                   throws IOException,
                          javax.servlet.ServletException

Weblogic specific comet based implementation.

Specified by:

doResponse in class AbstractAsyncServlet

Parameters:

rrk -

Throws:

IOException

javax.servlet.ServletException

doTimeout

protected void doTimeout(RequestResponseKey rrk)
                  throws IOException,
                         javax.servlet.ServletException

Weblogic specific comet based implementation.

Specified by:

doTimeout in class AbstractAsyncServlet

Parameters:

rrk -

Throws:

IOException

javax.servlet.ServletException

doWebSocketConnect

public WebSocket doWebSocketConnect(javax.servlet.http.HttpServletRequest request,
                                    String protocol)

Jetty 7.2 & 8.0.0-M1/M2and up WebSocket support.

Specified by:

doWebSocketConnect in interface WebSocketFactory.Acceptor

Parameters:

request -

protocol -

Returns:

a WebSocket}