Uses of Package
org.atmosphere.cpr

Packages that use org.atmosphere.cpr

Package	Description
org.atmosphere.annotation
org.atmosphere.cache
org.atmosphere.client
org.atmosphere.config.managed
org.atmosphere.container
org.atmosphere.container.version
org.atmosphere.cpr
org.atmosphere.handler
org.atmosphere.inject
org.atmosphere.interceptor
org.atmosphere.lifecycle
org.atmosphere.pool
org.atmosphere.util
org.atmosphere.websocket
org.atmosphere.websocket.protocol

Classes in org.atmosphere.cpr used by org.atmosphere.annotation

Class and Description
AsyncSupport Atmosphere's supported WebServer must implement this interface in order to be auto detected by the AtmosphereFramework.
AsyncSupportListener A listener that can be used to track AsyncSupport events like SUSPEND, RESUME, TIMEOUT, DESTROYED and CLOSED
AtmosphereFramework The AtmosphereFramework is the entry point for the framework.
AtmosphereFrameworkListener Lifecycle listener for AtmosphereFramework
AtmosphereHandler Implementation of AtmosphereHandler allows creation of event-driven web applications which are hosted in the browser.
AtmosphereInterceptor Intercept the dispatch of AtmosphereResource before they get dispatched to AtmosphereHandlers.
AtmosphereResourceFactory A Factory used to manage AtmosphereResource instances.
AtmosphereResourceListener Listener for when gets suspended and disconnected.
Broadcaster A Broadcaster is responsible for delivering messages to its subscribed AtmosphereResources, which are representing suspended responses.
BroadcasterCache A BroadcasterCache is a cache for broadcasted messages.
BroadcasterCacheListener Listener for BroadcasterCache
BroadcasterFactory Factory for Broadcaster used by Atmosphere when creating broadcasters.
BroadcasterListener A listener for a Broadcaster's event lifecycle.
BroadcastFilter Transform a message before it get broadcasted to AtmosphereHandler.onStateChange(org.atmosphere.cpr.AtmosphereResourceEvent).

Classes in org.atmosphere.cpr used by org.atmosphere.cache

Class and Description
AtmosphereConfig This class contains information about the current state of the AtmosphereFramework.
AtmosphereResource An AtmosphereResource encapsulates the mechanism to AtmosphereResource.suspend(), AtmosphereResource.resume() and broadcast (AtmosphereResource.getBroadcaster()) messages among suspended resources.
BroadcasterCache A BroadcasterCache is a cache for broadcasted messages.
BroadcasterCacheListener Listener for BroadcasterCache

Classes in org.atmosphere.cpr used by org.atmosphere.client

Class and Description
Action An Action is used by AtmosphereInterceptor, AsyncSupport and AtmosphereFramework to determine what to do with a request, e.g suspend it, resume it, etc.
AtmosphereConfig This class contains information about the current state of the AtmosphereFramework.
AtmosphereInterceptor Intercept the dispatch of AtmosphereResource before they get dispatched to AtmosphereHandlers.
AtmosphereInterceptorAdapter A Simple AtmosphereInterceptor that creates an AtmosphereInterceptorWriter and sets it as the default AsyncIOWriter on an AtmosphereResponse.
AtmosphereResource An AtmosphereResource encapsulates the mechanism to AtmosphereResource.suspend(), AtmosphereResource.resume() and broadcast (AtmosphereResource.getBroadcaster()) messages among suspended resources.
BroadcastFilter Transform a message before it get broadcasted to AtmosphereHandler.onStateChange(org.atmosphere.cpr.AtmosphereResourceEvent).
BroadcastFilter.BroadcastAction Simple class that tells the Broadcaster to broadcast or not the transformed value.
PerRequestBroadcastFilter An extended BroadcastFilter that can be used to filter based on AtmosphereResource.

Classes in org.atmosphere.cpr used by org.atmosphere.config.managed

Class and Description
Action An Action is used by AtmosphereInterceptor, AsyncSupport and AtmosphereFramework to determine what to do with a request, e.g suspend it, resume it, etc.
AtmosphereConfig This class contains information about the current state of the AtmosphereFramework.
AtmosphereFramework.AtmosphereHandlerWrapper
AtmosphereHandler Implementation of AtmosphereHandler allows creation of event-driven web applications which are hosted in the browser.
AtmosphereInterceptor Intercept the dispatch of AtmosphereResource before they get dispatched to AtmosphereHandlers.
AtmosphereInterceptorAdapter A Simple AtmosphereInterceptor that creates an AtmosphereInterceptorWriter and sets it as the default AsyncIOWriter on an AtmosphereResponse.
AtmosphereRequest An Atmosphere request representation.
AtmosphereResource An AtmosphereResource encapsulates the mechanism to AtmosphereResource.suspend(), AtmosphereResource.resume() and broadcast (AtmosphereResource.getBroadcaster()) messages among suspended resources.
AtmosphereResourceEvent An AtmosphereResourceEvent is created every time an event occurs, like when a Broadcaster.broadcast(java.lang.Object) is executed, when a browser remotely closes the connection or when a suspended resource times out or gets resumed.
AtmosphereResourceFactory A Factory used to manage AtmosphereResource instances.
AtmosphereResourceHeartbeatEventListener Receive notifications when heartbeat events occur.
AtmosphereServletProcessor Simple interface that can be used to wrap a Servlet from an AtmosphereHandler.
Broadcaster A Broadcaster is responsible for delivering messages to its subscribed AtmosphereResources, which are representing suspended responses.

Classes in org.atmosphere.cpr used by org.atmosphere.container

Class and Description
Action An Action is used by AtmosphereInterceptor, AsyncSupport and AtmosphereFramework to determine what to do with a request, e.g suspend it, resume it, etc.
AsynchronousProcessor Base class which implement the semantics of suspending and resuming of a Comet/WebSocket Request.
AsyncSupport Atmosphere's supported WebServer must implement this interface in order to be auto detected by the AtmosphereFramework.
AtmosphereConfig This class contains information about the current state of the AtmosphereFramework.
AtmosphereFramework The AtmosphereFramework is the entry point for the framework.
AtmosphereHandler Implementation of AtmosphereHandler allows creation of event-driven web applications which are hosted in the browser.
AtmosphereRequest An Atmosphere request representation.
AtmosphereResourceImpl AtmosphereResource implementation for supporting AtmosphereRequest and AtmosphereResponse.
AtmosphereResponse An Atmosphere's response representation.

Classes in org.atmosphere.cpr used by org.atmosphere.container.version

Class and Description
AsyncIOWriter An Asynchronous I/O Writer is used by a AtmosphereResponse when writing data.
AsyncIOWriterAdapter Adapter class for AsyncIOWriter.
AtmosphereConfig This class contains information about the current state of the AtmosphereFramework.
AtmosphereInterceptorWriter An AsyncIOWriter that delegates the write operation to its AsyncIOInterceptor.
AtmosphereResponse An Atmosphere's response representation.
KeepOpenStreamAware The KeepOpenStreamAware interface is used by a class implementing the AsyncIOWriter interface to indicate the closing of the underlining stream is managed elsewhere and invoking the AsyncIOWriter.close(AtmosphereResponse) method does not close the stream.

Classes in org.atmosphere.cpr used by org.atmosphere.cpr

Class and Description
Action An Action is used by AtmosphereInterceptor, AsyncSupport and AtmosphereFramework to determine what to do with a request, e.g suspend it, resume it, etc.
Action.TYPE The action's type.
AnnotationHandler A class that handles the results of an annotation scan.
AnnotationProcessor An annotation processor for configuring the AtmosphereFramework.
AsyncIOInterceptor A filter-like API that allow an AtmosphereInterceptor to intercept the response before it gets written back to the client.
AsyncIOWriter An Asynchronous I/O Writer is used by a AtmosphereResponse when writing data.
AsyncIOWriterAdapter Adapter class for AsyncIOWriter.
AsyncSupport Atmosphere's supported WebServer must implement this interface in order to be auto detected by the AtmosphereFramework.
AsyncSupportListener A listener that can be used to track AsyncSupport events like SUSPEND, RESUME, TIMEOUT, DESTROYED and CLOSED
AsyncSupportResolver This interface is used by AtmosphereFramework to determine which AsyncSupport instance should be used
AtmosphereConfig This class contains information about the current state of the AtmosphereFramework.
AtmosphereConfig.ShutdownHook A shutdown hook that will be called when the AtmosphereFramework.destroy() method gets invoked.
AtmosphereConfig.StartupHook A Startup hook that will be called when the AtmosphereFramework.init() method complete.
AtmosphereFramework The AtmosphereFramework is the entry point for the framework.
AtmosphereFramework.AtmosphereHandlerWrapper
AtmosphereFramework.MetaServiceAction This enumeration represents all possible actions to specify in a meta service file.
AtmosphereFrameworkInitializer
AtmosphereFrameworkListener Lifecycle listener for AtmosphereFramework
AtmosphereHandler Implementation of AtmosphereHandler allows creation of event-driven web applications which are hosted in the browser.
AtmosphereInterceptor Intercept the dispatch of AtmosphereResource before they get dispatched to AtmosphereHandlers.
AtmosphereInterceptorWriter An AsyncIOWriter that delegates the write operation to its AsyncIOInterceptor.
AtmosphereObjectFactory Customization point for Atmosphere to instantiate classes.
AtmosphereRequest An Atmosphere request representation.
AtmosphereRequest.Builder
AtmosphereRequest.LocalAttributes
AtmosphereRequestImpl.Body
AtmosphereRequestImpl.Builder
AtmosphereResource An AtmosphereResource encapsulates the mechanism to AtmosphereResource.suspend(), AtmosphereResource.resume() and broadcast (AtmosphereResource.getBroadcaster()) messages among suspended resources.
AtmosphereResource.TRANSPORT
AtmosphereResourceEvent An AtmosphereResourceEvent is created every time an event occurs, like when a Broadcaster.broadcast(java.lang.Object) is executed, when a browser remotely closes the connection or when a suspended resource times out or gets resumed.
AtmosphereResourceEventImpl AtmosphereResourceEvent implementation.
AtmosphereResourceEventListener Receive notifications when resume, client disconnect or broadcast events occur.
AtmosphereResourceEventListenerAdapter An implementation of AtmosphereResourceEventListener which just log events with log level TRACE.
AtmosphereResourceFactory A Factory used to manage AtmosphereResource instances.
AtmosphereResourceFactory.Async An interface to use in order to retrieve an AtmosphereResource inside a cluster.
AtmosphereResourceHeartbeatEventListener Receive notifications when heartbeat events occur.
AtmosphereResourceImpl AtmosphereResource implementation for supporting AtmosphereRequest and AtmosphereResponse.
AtmosphereResourceListener Listener for when gets suspended and disconnected.
AtmosphereResourceSession The AtmosphereResourceSession is managed by the AtmosphereResourceSessionFactory.
AtmosphereResourceSessionFactory Factory for AtmosphereResourceSession instances
AtmosphereResponse An Atmosphere's response representation.
AtmosphereResponse.Builder
AtmosphereResponseImpl.Builder
AtmosphereServlet AtmosphereServlet that use Servlet 3.0 Async API when available, and fallback to native comet support if not available.
Broadcaster A Broadcaster is responsible for delivering messages to its subscribed AtmosphereResources, which are representing suspended responses.
Broadcaster.POLICY
Broadcaster.SCOPE
BroadcasterCache A BroadcasterCache is a cache for broadcasted messages.
BroadcasterCacheListener Listener for BroadcasterCache
BroadcasterConfig Handle Broadcaster configuration like ExecutorService and BroadcastFilter.
BroadcasterConfig.FilterManipulator Manipulate the message before and after they are getting filtered by BroadcastFilter
BroadcasterFactory Factory for Broadcaster used by Atmosphere when creating broadcasters.
BroadcasterFactory.BroadcasterCreationException
BroadcasterFuture Simple Future that can be used when awaiting for a Broadcaster to finish its broadcast operation to AtmosphereHandler.
BroadcasterLifeCyclePolicy This class can be used to configure the life cycle of a Broadcaster, eg.
BroadcasterLifeCyclePolicy.ATMOSPHERE_RESOURCE_POLICY
BroadcasterLifeCyclePolicy.Builder
BroadcasterLifeCyclePolicyListener Simple listener to be used to track BroadcasterLifeCyclePolicy events.
BroadcasterListener A listener for a Broadcaster's event lifecycle.
BroadcasterListenerAdapter An implementation of BroadcasterListener.
BroadcastFilter Transform a message before it get broadcasted to AtmosphereHandler.onStateChange(org.atmosphere.cpr.AtmosphereResourceEvent).
BroadcastFilter.BroadcastAction Simple class that tells the Broadcaster to broadcast or not the transformed value.
BroadcastFilter.BroadcastAction.ACTION
BroadcastFilterLifecycle Add lifecycle method to the BroadcastFilter interface.
DefaultBroadcaster The default Broadcaster implementation.
DefaultBroadcaster.AsyncWriteToken
DefaultBroadcaster.WriteQueue
DefaultMetaBroadcaster Broadcast events to all or a subset of available Broadcasters based on their Broadcaster.getID() value.
Deliver A Deliver is an Broadcaster's internal token that is created before the message gets Broadcaster.
Deliver.TYPE
MetaBroadcaster Broadcast events to all or a subset of available Broadcasters based on their Broadcaster.getID() value.
MetaBroadcaster.MetaBroadcasterCache Cache message if no Broadcaster maps the MetaBroadcaster.broadcastTo(String, Object)
Meteor A Meteor is a simple class that can be used from a Servlet to suspend, broadcast and resume responses.
PerRequestBroadcastFilter An extended BroadcastFilter that can be used to filter based on AtmosphereResource.
Serializer Serialize the Object that was used as parameter to Broadcaster.broadcast(java.lang.Object).
WebSocketProcessorFactory Factory for WebSocketProcessor.

Classes in org.atmosphere.cpr used by org.atmosphere.handler

Class and Description
AtmosphereConfig This class contains information about the current state of the AtmosphereFramework.
AtmosphereHandler Implementation of AtmosphereHandler allows creation of event-driven web applications which are hosted in the browser.
AtmosphereResource An AtmosphereResource encapsulates the mechanism to AtmosphereResource.suspend(), AtmosphereResource.resume() and broadcast (AtmosphereResource.getBroadcaster()) messages among suspended resources.
AtmosphereResourceEvent An AtmosphereResourceEvent is created every time an event occurs, like when a Broadcaster.broadcast(java.lang.Object) is executed, when a browser remotely closes the connection or when a suspended resource times out or gets resumed.
AtmosphereResponse An Atmosphere's response representation.
AtmosphereServletProcessor Simple interface that can be used to wrap a Servlet from an AtmosphereHandler.

Classes in org.atmosphere.cpr used by org.atmosphere.inject

Class and Description
AtmosphereConfig This class contains information about the current state of the AtmosphereFramework.
AtmosphereFramework The AtmosphereFramework is the entry point for the framework.
AtmosphereObjectFactory Customization point for Atmosphere to instantiate classes.
AtmosphereRequest An Atmosphere request representation.
AtmosphereResource An AtmosphereResource encapsulates the mechanism to AtmosphereResource.suspend(), AtmosphereResource.resume() and broadcast (AtmosphereResource.getBroadcaster()) messages among suspended resources.
AtmosphereResourceEvent An AtmosphereResourceEvent is created every time an event occurs, like when a Broadcaster.broadcast(java.lang.Object) is executed, when a browser remotely closes the connection or when a suspended resource times out or gets resumed.
AtmosphereResourceFactory A Factory used to manage AtmosphereResource instances.
AtmosphereResourceSessionFactory Factory for AtmosphereResourceSession instances
AtmosphereResponse An Atmosphere's response representation.
Broadcaster A Broadcaster is responsible for delivering messages to its subscribed AtmosphereResources, which are representing suspended responses.
BroadcasterFactory Factory for Broadcaster used by Atmosphere when creating broadcasters.
MetaBroadcaster Broadcast events to all or a subset of available Broadcasters based on their Broadcaster.getID() value.

Classes in org.atmosphere.cpr used by org.atmosphere.interceptor

Class and Description
Action An Action is used by AtmosphereInterceptor, AsyncSupport and AtmosphereFramework to determine what to do with a request, e.g suspend it, resume it, etc.
AtmosphereConfig This class contains information about the current state of the AtmosphereFramework.
AtmosphereInterceptor Intercept the dispatch of AtmosphereResource before they get dispatched to AtmosphereHandlers.
AtmosphereInterceptorAdapter A Simple AtmosphereInterceptor that creates an AtmosphereInterceptorWriter and sets it as the default AsyncIOWriter on an AtmosphereResponse.
AtmosphereRequest An Atmosphere request representation.
AtmosphereResource An AtmosphereResource encapsulates the mechanism to AtmosphereResource.suspend(), AtmosphereResource.resume() and broadcast (AtmosphereResource.getBroadcaster()) messages among suspended resources.
AtmosphereResourceEvent An AtmosphereResourceEvent is created every time an event occurs, like when a Broadcaster.broadcast(java.lang.Object) is executed, when a browser remotely closes the connection or when a suspended resource times out or gets resumed.
AtmosphereResourceEventListener Receive notifications when resume, client disconnect or broadcast events occur.
AtmosphereResourceEventListenerAdapter An implementation of AtmosphereResourceEventListener which just log events with log level TRACE.
AtmosphereResourceEventListenerAdapter.OnSuspend On Suspend's Listener
AtmosphereResourceHeartbeatEventListener Receive notifications when heartbeat events occur.
AtmosphereResourceImpl AtmosphereResource implementation for supporting AtmosphereRequest and AtmosphereResponse.
AtmosphereResponse An Atmosphere's response representation.
Broadcaster A Broadcaster is responsible for delivering messages to its subscribed AtmosphereResources, which are representing suspended responses.
BroadcasterListener A listener for a Broadcaster's event lifecycle.
BroadcasterListenerAdapter An implementation of BroadcasterListener.

Classes in org.atmosphere.cpr used by org.atmosphere.lifecycle

Class and Description
AtmosphereResource An AtmosphereResource encapsulates the mechanism to AtmosphereResource.suspend(), AtmosphereResource.resume() and broadcast (AtmosphereResource.getBroadcaster()) messages among suspended resources.
Broadcaster A Broadcaster is responsible for delivering messages to its subscribed AtmosphereResources, which are representing suspended responses.
BroadcasterListener A listener for a Broadcaster's event lifecycle.
BroadcasterListenerAdapter An implementation of BroadcasterListener.
DefaultBroadcaster The default Broadcaster implementation.

Classes in org.atmosphere.cpr used by org.atmosphere.pool

Class and Description
AtmosphereConfig This class contains information about the current state of the AtmosphereFramework.
AtmosphereResource An AtmosphereResource encapsulates the mechanism to AtmosphereResource.suspend(), AtmosphereResource.resume() and broadcast (AtmosphereResource.getBroadcaster()) messages among suspended resources.
Broadcaster A Broadcaster is responsible for delivering messages to its subscribed AtmosphereResources, which are representing suspended responses.
BroadcasterFactory Factory for Broadcaster used by Atmosphere when creating broadcasters.
DefaultBroadcasterFactory This class is responsible for creating Broadcaster instances.

Classes in org.atmosphere.cpr used by org.atmosphere.util

Class and Description
AnnotationProcessor An annotation processor for configuring the AtmosphereFramework.
AsyncIOWriter An Asynchronous I/O Writer is used by a AtmosphereResponse when writing data.
AsyncIOWriterAdapter Adapter class for AsyncIOWriter.
AtmosphereConfig This class contains information about the current state of the AtmosphereFramework.
AtmosphereFramework.MetaServiceAction This enumeration represents all possible actions to specify in a meta service file.
AtmosphereHandler Implementation of AtmosphereHandler allows creation of event-driven web applications which are hosted in the browser.
AtmosphereRequest An Atmosphere request representation.
AtmosphereResource An AtmosphereResource encapsulates the mechanism to AtmosphereResource.suspend(), AtmosphereResource.resume() and broadcast (AtmosphereResource.getBroadcaster()) messages among suspended resources.
AtmosphereResource.TRANSPORT
AtmosphereResourceEvent An AtmosphereResourceEvent is created every time an event occurs, like when a Broadcaster.broadcast(java.lang.Object) is executed, when a browser remotely closes the connection or when a suspended resource times out or gets resumed.
AtmosphereResponse An Atmosphere's response representation.
Broadcaster A Broadcaster is responsible for delivering messages to its subscribed AtmosphereResources, which are representing suspended responses.
BroadcasterConfig Handle Broadcaster configuration like ExecutorService and BroadcastFilter.
BroadcastFilter Transform a message before it get broadcasted to AtmosphereHandler.onStateChange(org.atmosphere.cpr.AtmosphereResourceEvent).
BroadcastFilter.BroadcastAction Simple class that tells the Broadcaster to broadcast or not the transformed value.
DefaultBroadcaster The default Broadcaster implementation.
Deliver A Deliver is an Broadcaster's internal token that is created before the message gets Broadcaster.

Classes in org.atmosphere.cpr used by org.atmosphere.websocket

Class and Description
AsyncIOWriter An Asynchronous I/O Writer is used by a AtmosphereResponse when writing data.
AsyncIOWriterAdapter Adapter class for AsyncIOWriter.
AtmosphereConfig This class contains information about the current state of the AtmosphereFramework.
AtmosphereInterceptorWriter An AsyncIOWriter that delegates the write operation to its AsyncIOInterceptor.
AtmosphereRequest An Atmosphere request representation.
AtmosphereResource An AtmosphereResource encapsulates the mechanism to AtmosphereResource.suspend(), AtmosphereResource.resume() and broadcast (AtmosphereResource.getBroadcaster()) messages among suspended resources.
AtmosphereResourceEvent An AtmosphereResourceEvent is created every time an event occurs, like when a Broadcaster.broadcast(java.lang.Object) is executed, when a browser remotely closes the connection or when a suspended resource times out or gets resumed.
AtmosphereResourceEventListener Receive notifications when resume, client disconnect or broadcast events occur.
AtmosphereResourceHeartbeatEventListener Receive notifications when heartbeat events occur.
AtmosphereResponse An Atmosphere's response representation.
Broadcaster A Broadcaster is responsible for delivering messages to its subscribed AtmosphereResources, which are representing suspended responses.
KeepOpenStreamAware The KeepOpenStreamAware interface is used by a class implementing the AsyncIOWriter interface to indicate the closing of the underlining stream is managed elsewhere and invoking the AsyncIOWriter.close(AtmosphereResponse) method does not close the stream.

Classes in org.atmosphere.cpr used by org.atmosphere.websocket.protocol

Class and Description
AtmosphereConfig This class contains information about the current state of the AtmosphereFramework.
AtmosphereRequest An Atmosphere request representation.
AtmosphereRequestImpl.Builder