Package org.atmosphere.cpr

Interface Summary

Interface	Description
AnnotationProcessor	An annotation processor for configuring the AtmosphereFramework.
ApplicationConfig	Web.xml init-param configuration supported by Atmosphere.
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.
AsyncSupport<E extends AtmosphereResource>	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.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.
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.
AtmosphereObjectFactory	Customization point for Atmosphere to instantiate classes.
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.
AtmosphereResourceSession	The AtmosphereResourceSession is managed by the AtmosphereResourceSessionFactory.
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.
BroadcasterCache	A BroadcasterCache is a cache for broadcasted messages.
BroadcasterLifeCyclePolicyListener	Simple listener to be used to track BroadcasterLifeCyclePolicy events.
BroadcasterListener	A listener for a Broadcaster's event lifecycle.
BroadcastFilter	Transform a message before it get broadcasted to AtmosphereHandler.onStateChange(org.atmosphere.cpr.AtmosphereResourceEvent).
BroadcastFilterLifecycle	Add lifecycle method to the BroadcastFilter interface.
ClusterBroadcastFilter	Specialize BroadcastFilter used when clustering is enabled.
FrameworkConfig	Request attribute a framework integrator can use to lookup Atmosphere internal objects.
HeaderConfig	This interface contains all Atmosphere headers shared between the client and the server.
MetaBroadcaster.MetaBroadcasterCache	Cache message if no Broadcaster maps the MetaBroadcaster.broadcastTo(String, Object)
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).

Class Summary

Class	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.
AnnotationHandler	A class that handles the results of an annotation scan.
AnnotationScanningServletContainerInitializer	A ServletContainerInitializer that scans for annotations, and places them in a map keyed by annotation type in the servlet context.
AsynchronousProcessor	Base class which implement the semantics of suspending and resuming of a Comet/WebSocket Request.
AsynchronousProcessor.AsynchronousProcessorHook	A callback class that can be used by Framework integrator to handle the close/timedout/resume life cycle of an AtmosphereResource.
AsyncIOInterceptorAdapter	An Adapter for AsyncIOInterceptor.
AsyncIOWriterAdapter	Adapter class for AsyncIOWriter.
AsyncSupportListenerAdapter	A default implementation of AsyncSupportListener
AtmosphereConfig	This class contains information about the current state of the AtmosphereFramework.
AtmosphereFilter	Atmosphere has support for Filters, delegating all work to AtmosphereServlet.
AtmosphereFramework	The AtmosphereFramework is the entry point for the framework.
AtmosphereFramework.AtmosphereHandlerWrapper
AtmosphereFramework.DefaultAtmosphereObjectFactory
AtmosphereInitializer
AtmosphereInterceptorAdapter	A Simple AtmosphereInterceptor that creates an AtmosphereInterceptorWriter and sets it as the default AsyncIOWriter on an AtmosphereResponse.
AtmosphereInterceptorWriter	An AsyncIOWriter that delegates the write operation to its AsyncIOInterceptor.
AtmosphereRequest	An Atmosphere request representation.
AtmosphereRequest.Body
AtmosphereRequest.Builder
AtmosphereResourceEventImpl	AtmosphereResourceEvent implementation.
AtmosphereResourceEventListenerAdapter	An implementation of AtmosphereResourceEventListener which just log events with log level TRACE.
AtmosphereResourceEventListenerAdapter.OnBroadcast	On Broadcast's Listener
AtmosphereResourceEventListenerAdapter.OnClose	On Close's Listener
AtmosphereResourceEventListenerAdapter.OnDisconnect	On Disconnect's Listener
AtmosphereResourceEventListenerAdapter.OnPreSuspend	On PreSuspend's Listener
AtmosphereResourceEventListenerAdapter.OnResume	On Resume's Listener
AtmosphereResourceEventListenerAdapter.OnSuspend	On Suspend's Listener
AtmosphereResourceEventListenerAdapter.OnThrowable	On Throwable's Listener
AtmosphereResourceFactory	A Factory used to manage AtmosphereResource instances.
AtmosphereResourceImpl	AtmosphereResource implementation for supporting AtmosphereRequest and AtmosphereResponse.
AtmosphereResourceSessionFactory	Factory for AtmosphereResourceSession instances
AtmosphereResponse	An Atmosphere's response representation.
AtmosphereResponse.Builder
AtmosphereServlet	AtmosphereServlet that use Servlet 3.0 Async API when available, and fallback to native comet support if not available.
AtmosphereSession	An AtmosphereSession allow an application to keep track of the AtmosphereResource associated with a remote client.
BroadcasterConfig	Handle Broadcaster configuration like ExecutorService and BroadcastFilter.
BroadcasterFactory	Factory for Broadcaster used by Atmosphere when creating broadcasters.
BroadcasterFuture<E>	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.Builder
BroadcasterLifeCyclePolicyListenerAdapter	Simple adapter listener to be used to track BroadcasterLifeCyclePolicy events.
BroadcasterListenerAdapter	An implementation of BroadcasterListener.
BroadcastFilter.BroadcastAction	Simple class that tells the Broadcaster to broadcast or not the transformed value.
BroadcastFilterAdapter	Adapter for PerRequestBroadcastFilter.
DefaultAnnotationProcessor	An AnnotationProcessor that selects between a ServletContextInitializer based scanner, and a bytecode based scanner based on .
DefaultAsyncSupportResolver	This is the default implementation of @link {AsyncSupportResolver}.
DefaultAtmosphereResourceSession
DefaultAtmosphereResourceSessionFactory
DefaultBroadcaster	The default Broadcaster implementation.
DefaultBroadcaster.AsyncWriteToken
DefaultBroadcasterFactory	This class is responsible for creating Broadcaster instances.
Entry
MetaBroadcaster	Broadcast events to all or a subset of available Broadcasters based on their Broadcaster.getID() value.
MetaBroadcaster.NoCache
MetaBroadcaster.ThirtySecondsCache	Flush the cache every 30 seconds.
Meteor	A Meteor is a simple class that can be used from a Servlet to suspend, broadcast and resume responses.
MeteorServlet	Simple Servlet to use when Atmosphere Meteor are used.
SessionSupport
SessionTimeoutRestorer	Capable of restoring HTTP session timeout to given value.
SessionTimeoutSupport	Allows invalidating and restoring HTTP session timeout.
WebSocketProcessorFactory	Factory for WebSocketProcessor.

Enum Summary

Enum	Description
Action.TYPE	The action's type.
AtmosphereResource.TRANSPORT
Broadcaster.POLICY
Broadcaster.SCOPE
BroadcasterLifeCyclePolicy.ATMOSPHERE_RESOURCE_POLICY
BroadcastFilter.BroadcastAction.ACTION
Entry.TYPE

Exception Summary

Exception	Description
AtmosphereMappingException	Thrown when AsynchronousProcessor is unable to map the request to an AtmosphereHandler.
BroadcasterListener.BroadcastListenerException	Throw this exception to interrupt the Broadcaster.destroy() operation.
DefaultBroadcasterFactory.BroadcasterCreationException