Package org.atmosphere.cpr

Interface Summary
ApplicationConfig Web.xml init-param configuration supported by Atmosphere.
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.
AsyncSupportResolver This interface is used by AtmosphereFramework to determine which AsyncSupport instance should be used
AtmosphereEventLifecycle Simple life cycle interface for processing AtmosphereResourceEventListener.
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.
AtmosphereResource A AtmosphereResource encapsulates the mechanism to AtmosphereResource.suspend(), AtmosphereResource.resume() and broadcast (AtmosphereResource.getBroadcaster()) messages among suspended response.
AtmosphereResourceEvent An AtmosphereResourceEvent is created every time an event occurs like when a Broadcaster.broadcast(java.lang.Object) is executed, when a Browser close remotely close the connection or when a suspended times out or gets resumed.
AtmosphereResourceEventListener Receive notification when a resume, client disconnect or broadcast events occurs.
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 AtmosphereResource, which are representing a suspended response.
BroadcasterCache A BroadcasterCache is used to persist broadcasted Object Broadcaster.broadcast(Object).
BroadcasterLifeCyclePolicyListener Simple listener to be used to track BroadcasterLifeCyclePolicy events.
BroadcastFilter Transform a message of type 'E" before it get broadcasted to AtmosphereHandler.onStateChange(org.atmosphere.cpr.AtmosphereResourceEvent)

See XSSHtmlFilter for an example.

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 object.
HeaderConfig This interface contains all Atmosphere headers shared between the client and the server.
PerRequestBroadcastFilter A markable interface that can be used in conjunction with BroadcastFilter to filter message per request.
Serializer Serialize the Object the result of invoking Broadcaster.broadcast(T).
 

Class Summary
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.
AsynchronousProcessor.AsynchronousProcessorHook An Callback class that can be used by Framework integrator to handle the close/timedout/resume life cycle of an AtmosphereResource.
AsyncIOWriterAdapter Adapter class for AsyncIOWriter.
AtmosphereConfig  
AtmosphereFilter Atmosphere supports for Filter, delegating all works to AtmosphereServlet.
AtmosphereFramework The AtmosphereFramework is the entry point for the framework.
AtmosphereFramework.AtmosphereHandlerWrapper  
AtmosphereRequest An Atmosphere request representation.
AtmosphereRequest.Builder  
AtmosphereResourceEventImpl AtmosphereResourceEvent implementation for Servlet Container.
AtmosphereResourceEventListenerAdapter An implementation of AtmosphereResourceEventListener with just log event as trace.
AtmosphereResourceImpl AtmosphereResource implementation for supporting AtmosphereRequest and AtmosphereRequest.
AtmosphereResponse An Atmosphere's response representation.
AtmosphereResponse.Builder  
AtmosphereServlet 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.
BroadcasterConfig Handle Broadcaster configuration like ExecutorService and BroadcastFilter
BroadcasterConfig.DefaultBroadcasterCache  
BroadcasterFactory Broadcaster factory used by Atmosphere when creating broadcaster.
BroadcasterFuture<E> Simple Future that can be used when awaiting for a Broadcaster to finish it's broadcast operations to AtmosphereHandler
BroadcasterLifeCyclePolicy This class can be used to configure the life cycle of a Broadcaster, e.g when a broadcaster gets destroyed Broadcaster.destroy() or when it's associated resources get released Broadcaster.releaseExternalResources().
BroadcasterLifeCyclePolicy.Builder  
BroadcastFilter.BroadcastAction Simple class that tells the Broadcaster to broadcast or not the transformed value.
DefaultAsyncSupportResolver This is the default implementation of @link {AsyncSupportResolver}
DefaultBroadcaster Broadcaster implementation.
DefaultBroadcaster.AsyncWriteToken  
DefaultBroadcaster.Entry  
DefaultBroadcasterFactory This class is responsible for creating Broadcaster instance.
Meteor A Meteor is a simple class that can be used from a Servlet to suspend, broadcast and resume a response.
MeteorServlet Simple Servlet to use when Atmosphere Meteor are used.
SessionTimeoutRestorer Capable of restoring HTTP session timeout to given value.
SessionTimeoutSupport Allows invalidating and restoring HTTP session timeout.
 

Enum Summary
Action.TYPE The action's type.
AtmosphereResource.TRANSPORT  
Broadcaster.POLICY  
Broadcaster.SCOPE  
BroadcasterCache.STRATEGY  
BroadcasterLifeCyclePolicy.ATMOSPHERE_RESOURCE_POLICY  
BroadcastFilter.BroadcastAction.ACTION  
 

Exception Summary
AtmosphereMappingException Throw when AsynchronousProcessor is unable to map the request to an AtmosphereHandler
DefaultBroadcasterFactory.BroadcasterCreationException  
 



Copyright © 2012. All Rights Reserved.