AtmosphereServlet (atmosphere-runtime 0.5.3 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.atmosphere.cpr
Class AtmosphereServlet

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          weblogic.servlet.http.AbstractAsyncServlet
              org.atmosphere.cpr.AtmosphereServlet

All Implemented Interfaces:: Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, org.apache.catalina.CometProcessor, org.jboss.servlet.http.HttpEventServlet

Direct Known Subclasses:: MeteorServlet

public class AtmosphereServlet
extends weblogic.servlet.http.AbstractAsyncServlet
implements org.apache.catalina.CometProcessor, org.jboss.servlet.http.HttpEventServlet
extends weblogic.servlet.http.AbstractAsyncServlet
implements org.apache.catalina.CometProcessor, org.jboss.servlet.http.HttpEventServlet

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>

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

Nested Class Summary
`static class`	`AtmosphereServlet.Action` Simple class/struck that hold the current state.
`class`	`AtmosphereServlet.AtmosphereConfig`
`static class`	`AtmosphereServlet.AtmosphereHandlerWrapper`

Field Summary
`protected Map<String,AtmosphereServlet.AtmosphereHandlerWrapper>`	`atmosphereHandlers` The list of `AtmosphereHandler` and their associated mapping.
`static String`	`BROADCASTER_CLASS`
`protected String`	`broadcasterClassName`
`protected CometSupport`	`cometSupport`
`protected AtmosphereServlet.AtmosphereConfig`	`config`
`static String`	`DISABLE_ONSTATE_EVENT`
`static String`	`GAE_BROADCASTER`
`protected HashMap<String,String>`	`initParams`
`protected boolean`	`isBroadcasterSpecified`
`protected AtomicBoolean`	`isCometSupportConfigured`
`protected boolean`	`isCometSupportSpecified`
`protected boolean`	`isFilter`
`static String`	`JERSEY_BROADCASTER`
`static String`	`JERSEY_CONTAINER`
`static Logger`	`logger`
`protected ArrayList<String>`	`possibleAtmosphereHandlersCandidate`
`static String`	`PRIMEFACES_SERVLET`
`static String`	`PROPERTY_BLOCKING_COMETSUPPORT`
`static String`	`PROPERTY_COMET_SUPPORT`
`static String`	`PROPERTY_NATIVE_COMETSUPPORT`
`static String`	`PROPERTY_SERVLET_MAPPING`
`static String`	`PROPERTY_USE_STREAM`
`protected boolean`	`useBlockingImplementation`
`protected boolean`	`useNativeImplementation`
`protected boolean`	`useStreamForFlushingComments`
`static String`	`WEB_INF`

Constructor Summary
`AtmosphereServlet()` Create an Atmosphere Servlet.
`AtmosphereServlet(boolean isFilter)` Create an Atmosphere Servlet.

Method Summary
`void`	`addAtmosphereHandler(String mapping, AtmosphereHandler h)` Add an `AtmosphereHandler` serviced by the `Servlet` This API is exposed to allow embedding an Atmosphere application.
`void`	`addInitParameter(String name, String value)` Add init-param like if they were defined in web.xml
`protected void`	`autoDetectAtmosphereHandlers(javax.servlet.ServletContext sc, URLClassLoader c)` Auto detect instance of `AtmosphereHandler` in case META-INF/atmosphere.xml is missing.
`protected void`	`autoDetectContainer()` Auto detect the underlying Servlet Container we are running on.
`protected CometSupportResolver`	`createCometSupportResolver()` Returns an instance of CometSupportResolver `CometSupportResolver`
`void`	`destroy()`
`protected boolean`	`detectJerseyRuntime(javax.servlet.ServletConfig sc)` Auto-detect Jersey when no atmosphere.xml file are specified.
`protected AtmosphereServlet.Action`	`doCometSupport(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)` Invoke the proprietary `CometSupport`
`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`
`protected void`	`doInitParams(javax.servlet.ServletConfig sc)` Read init param from web.xml and apply them.
`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(weblogic.servlet.http.RequestResponseKey rrk)` Weblogic specific comet based implementation.
`protected void`	`doResponse(weblogic.servlet.http.RequestResponseKey rrk, Object context)` Weblogic specific comet based implementation.
`protected void`	`doTimeout(weblogic.servlet.http.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`
`void`	`event(org.apache.catalina.CometEvent cometEvent)` Hack to support Tomcat AIO like other WebServer.
`void`	`event(org.jboss.servlet.http.HttpEvent httpEvent)` Hack to support JBossWeb AIO like other WebServer.
`CometSupport`	`getCometSupport()` Return the current `CometSupport`
`String`	`getDefaultBroadcasterClassName()` Return the default `Broadcaster` class name.
`protected void`	`getFiles(File f)` Get the list of possible candidate to load as `AtmosphereHandler`
`void`	`init(javax.servlet.ServletConfig sc)` Load the `AtmosphereHandler` associated with this AtmosphereServlet.
`boolean`	`isUseStreamForFlushingComments()` `true` if Atmosphere uses `ServletResponse.getOutputStream()` by default for write operation.
`protected void`	`loadAtmosphereDotXml(InputStream stream, URLClassLoader c)` Load AtmosphereHandler defined under META-INF/atmosphere.xml
`protected void`	`loadConfiguration(javax.servlet.ServletConfig sc)`
`AtmosphereServlet.AtmosphereConfig`	`newAtmosphereConfig(boolean supportSession)` Return a configured instance of `AtmosphereServlet.AtmosphereConfig`
`void`	`setCometSupport(CometSupport cometSupport)` Set the `CometSupport` implementation.
`void`	`setDefaultBroadcasterClassName(String broadcasterClassName)` Set the default `Broadcaster` class name
`void`	`setUseStreamForFlushingComments(boolean useStreamForFlushingComments)` Set to `true` so Atmosphere uses `ServletResponse.getOutputStream()` by default for write operation.

Methods inherited from class weblogic.servlet.http.AbstractAsyncServlet
`notify`

Methods inherited from class javax.servlet.http.HttpServlet
`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`

Methods inherited from interface javax.servlet.Servlet
`getServletConfig, getServletInfo, service`

Field Detail

useNativeImplementation

protected boolean useNativeImplementation

useBlockingImplementation

protected boolean useBlockingImplementation

useStreamForFlushingComments

protected boolean useStreamForFlushingComments

JERSEY_BROADCASTER

public static final String JERSEY_BROADCASTER

See Also:: Constant Field Values

JERSEY_CONTAINER

public static final String JERSEY_CONTAINER

See Also:: Constant Field Values

GAE_BROADCASTER

public static final String GAE_BROADCASTER

PROPERTY_SERVLET_MAPPING

public static final String PROPERTY_SERVLET_MAPPING

See Also:: Constant Field Values

PROPERTY_BLOCKING_COMETSUPPORT

public static final String PROPERTY_BLOCKING_COMETSUPPORT

See Also:: Constant Field Values

PROPERTY_NATIVE_COMETSUPPORT

public static final String PROPERTY_NATIVE_COMETSUPPORT

See Also:: Constant Field Values

PROPERTY_USE_STREAM

public static final String PROPERTY_USE_STREAM

See Also:: Constant Field Values

BROADCASTER_CLASS

public static final String BROADCASTER_CLASS

See Also:: Constant Field Values

PROPERTY_COMET_SUPPORT

public static final String PROPERTY_COMET_SUPPORT

See Also:: Constant Field Values

PRIMEFACES_SERVLET

public static final String PRIMEFACES_SERVLET

See Also:: Constant Field Values

DISABLE_ONSTATE_EVENT

public static final String DISABLE_ONSTATE_EVENT

See Also:: Constant Field Values

WEB_INF

public static final String WEB_INF

See Also:: Constant Field Values

logger

public static final Logger logger

possibleAtmosphereHandlersCandidate

protected final ArrayList<String> possibleAtmosphereHandlersCandidate

initParams

protected final HashMap<String,String> initParams

atmosphereHandlers

protected final Map<String,AtmosphereServlet.AtmosphereHandlerWrapper> atmosphereHandlers

The list of AtmosphereHandler and their associated mapping.

cometSupport

protected CometSupport cometSupport

config

protected AtmosphereServlet.AtmosphereConfig config

isFilter

protected boolean isFilter

broadcasterClassName

protected String broadcasterClassName

isCometSupportConfigured

protected final AtomicBoolean isCometSupportConfigured

isCometSupportSpecified

protected boolean isCometSupportSpecified

isBroadcasterSpecified

protected boolean isBroadcasterSpecified

Constructor Detail

AtmosphereServlet

public AtmosphereServlet()

Create an Atmosphere Servlet.

AtmosphereServlet

public AtmosphereServlet(boolean isFilter)

Create an Atmosphere Servlet.

Method Detail

newAtmosphereConfig

public AtmosphereServlet.AtmosphereConfig newAtmosphereConfig(boolean supportSession)

Return a configured instance of AtmosphereServlet.AtmosphereConfig

Parameters:: supportSession - true if session is supported.
Returns:: a configured instance of AtmosphereServlet.AtmosphereConfig

addAtmosphereHandler

public void addAtmosphereHandler(String mapping,
                                 AtmosphereHandler h)

Add an AtmosphereHandler serviced by the Servlet This API is exposed to allow embedding an Atmosphere application.

Parameters:: mapping - The servlet mapping (servlet path); h - implementation of an AtmosphereHandler

addInitParameter

public void addInitParameter(String name,
                             String value)

Add init-param like if they were defined in web.xml

Parameters:: name - The name; value - The value

init

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

Load the AtmosphereHandler associated with this AtmosphereServlet.

Specified by:: init in interface javax.servlet.Servlet
Overrides:: init in class javax.servlet.GenericServlet

Parameters:: sc - the ServletContext
Throws:: javax.servlet.ServletException

doInitParams

protected void doInitParams(javax.servlet.ServletConfig sc)

Read init param from web.xml and apply them.

Parameters:: sc -

loadConfiguration

protected void loadConfiguration(javax.servlet.ServletConfig sc)
                          throws javax.servlet.ServletException

Throws:: javax.servlet.ServletException

detectJerseyRuntime

protected boolean detectJerseyRuntime(javax.servlet.ServletConfig sc)

Auto-detect Jersey when no atmosphere.xml file are specified.

Parameters:: sc - ServletConfig
Returns:: true if Jersey classes are detected

destroy

public void destroy()

Specified by:: destroy in interface javax.servlet.Servlet
Overrides:: destroy in class javax.servlet.GenericServlet

loadAtmosphereDotXml

protected void loadAtmosphereDotXml(InputStream stream,
                                    URLClassLoader c)
                             throws IOException,
                                    javax.servlet.ServletException

Load AtmosphereHandler defined under META-INF/atmosphere.xml

Throws:: IOException; javax.servlet.ServletException

setCometSupport

public void setCometSupport(CometSupport cometSupport)

Set the CometSupport implementation. Make sure you don't set an implementation that only works on some Container. See BlockingIOCometSupport for an example.

Parameters:: cometSupport -

getCometSupport

public CometSupport getCometSupport()

Return the current CometSupport

Returns:

createCometSupportResolver

protected CometSupportResolver createCometSupportResolver()

Returns an instance of CometSupportResolver CometSupportResolver

Returns:: CometSupportResolver

autoDetectContainer

protected void autoDetectContainer()

Auto detect the underlying Servlet Container we are running on.

autoDetectAtmosphereHandlers

protected void autoDetectAtmosphereHandlers(javax.servlet.ServletContext sc,
                                            URLClassLoader c)
                                     throws MalformedURLException,
                                            URISyntaxException

Auto detect instance of AtmosphereHandler in case META-INF/atmosphere.xml is missing.

Parameters:: sc - ServletContext; c - URLClassLoader to load the class.
Throws:: MalformedURLException; URISyntaxException

getFiles

protected void getFiles(File f)

Get the list of possible candidate to load as AtmosphereHandler

Parameters:: f - the real path File