Package org.atmosphere.cpr
package org.atmosphere.cpr
-
ClassDescriptionAn Action is used by
AtmosphereInterceptor,AsyncSupportandAtmosphereFrameworkto determine what to do with a request, e.g suspend it, resume it, etc.The action's type.A class that handles the results of an annotation scan.An annotation processor for configuring theAtmosphereFramework.A ServletContainerInitializer that scans for annotations, and places them in a map keyed by annotation type in the servlet context.Web.xml init-param configuration supported by Atmosphere.Base class which implement the semantics of suspending and resuming of a Comet/WebSocket Request.A filter-like API that allow anAtmosphereInterceptorto intercept the response before it gets written back to the client.An Adapter forAsyncIOInterceptor.An Asynchronous I/O Writer is used by aAtmosphereResponsewhen writing data.Adapter class forAsyncIOWriter.AsyncSupport<E extends AtmosphereResource>Atmosphere's supported WebServer must implement this interface in order to be auto detected by theAtmosphereFramework.A listener that can be used to trackAsyncSupportevents like SUSPEND, RESUME, TIMEOUT, DESTROYED and CLOSEDA default implementation ofAsyncSupportListenerThis interface is used byAtmosphereFrameworkto determine which AsyncSupport instance should be usedThis class contains information about the current state of theAtmosphereFramework.A shutdown hook that will be called when theAtmosphereFramework.destroy()method gets invoked.A Startup hook that will be called when theAtmosphereFramework.init()method complete.Atmosphere has support forFilters, delegating all work toAtmosphereServlet.TheAtmosphereFrameworkis the entry point for the framework.This enumeration represents all possible actions to specify in a meta service file.Lifecycle listener forAtmosphereFrameworkAdapter forAtmosphereFrameworkListenerImplementation ofAtmosphereHandlerallows creation of event-driven web applications which are hosted in the browser.Intercept the dispatch ofAtmosphereResourcebefore they get dispatched toAtmosphereHandlers.A SimpleAtmosphereInterceptorthat creates anAtmosphereInterceptorWriterand sets it as the defaultAsyncIOWriteron anAtmosphereResponse.AnAsyncIOWriterthat delegates the write operation to itsAsyncIOInterceptor.Thrown whenAsynchronousProcessoris unable to map the request to anAtmosphereHandler.Customization point for Atmosphere to instantiate classes.An Atmosphere request representation.An Atmosphere request representation.AnAtmosphereResourceencapsulates the mechanism toAtmosphereResource.suspend(),AtmosphereResource.resume()and broadcast (AtmosphereResource.getBroadcaster()) messages among suspended resources.An AtmosphereResourceEvent is created every time an event occurs, like when aBroadcaster.broadcast(java.lang.Object)is executed, when a browser remotely closes the connection or when a suspended resource times out or gets resumed.AtmosphereResourceEventimplementation.Receive notifications when resume, client disconnect or broadcast events occur.An implementation ofAtmosphereResourceEventListenerwhich just log events with log level TRACE.On Broadcast's ListenerOn Close's ListenerOn Disconnect's ListenerOn Heartbeat's ListenerOn PreSuspend's ListenerOn Resume's ListenerOn Suspend's ListenerOn Throwable's ListenerA Factory used to manageAtmosphereResourceinstances.An interface to use in order to retrieve anAtmosphereResourceinside a cluster.Receive notifications when heartbeat events occur.Listener for whenAtmosphereResourcegets suspended and disconnected.Adapter forAtmosphereResourceListenerThe AtmosphereResourceSession is managed by theAtmosphereResourceSessionFactory.Factory forAtmosphereResourceSessioninstancesAn Atmosphere's response representation.An Atmosphere's response representation.AtmosphereServlet that use Servlet 3.0 Async API when available, and fallback to native comet support if not available.Simple interface that can be used to wrap aServletfrom anAtmosphereHandler.An AtmosphereSession allow an application to keep track of the AtmosphereResource associated with a remote client.A Broadcaster is responsible for delivering messages to its subscribedAtmosphereResources, which are representing suspended responses.A BroadcasterCache is a cache for broadcasted messages.Listener forBroadcasterCacheManipulate the message before and after they are getting filtered byBroadcastFilterFactory forBroadcasterused by Atmosphere when creating broadcasters.SimpleFuturethat can be used when awaiting for aBroadcasterto finish its broadcast operation toAtmosphereHandler.This class can be used to configure the life cycle of aBroadcaster, eg.Simple listener to be used to trackBroadcasterLifeCyclePolicyevents.Simple adapter listener to be used to trackBroadcasterLifeCyclePolicyevents.A listener for aBroadcaster's event lifecycle.Throw this exception to interrupt theBroadcaster.destroy()operation.An implementation ofBroadcasterListener.Transform a message before it get broadcasted toAtmosphereHandler.onStateChange(org.atmosphere.cpr.AtmosphereResourceEvent).Simple class that tells theBroadcasterto broadcast or not the transformed value.Adapter forPerRequestBroadcastFilter.Add lifecycle method to theBroadcastFilterinterface.SpecializeBroadcastFilterused when clustering is enabled.The CompletionAware interface is used by a class implementing theAtmosphereResponseinterface to be notified when writing to the response has been completed.Initializer for the AtmosphereFramework per servlet instance, this initializer is called during web-application startup lifecycle (since Servlet 3.0).AnAnnotationProcessorthat selects between a ServletContextInitializer based scanner, and a bytecode based scanner based on .This is the default implementation of @link {AsyncSupportResolver}.A Factory used to manageAtmosphereResourceinstances.The defaultBroadcasterimplementation.This class is responsible for creatingBroadcasterinstances.Broadcast events to all or a subset of availableBroadcasters based on theirBroadcaster.getID()value.A Deliver is anBroadcaster's internal token that is created before the message gets Broadcaster.Request attribute a framework integrator can use to lookup Atmosphere internal objects.This interface contains all Atmosphere headers shared between the client and the server.Specifies to the observable thatAtmosphereResourceHeartbeatEventListener.onHeartbeat(org.atmosphere.cpr.AtmosphereResourceEvent)should be invoked when it fires event to observers.The KeepOpenStreamAware interface is used by a class implementing theAsyncIOWriterinterface to indicate the closing of the underlining stream is managed elsewhere and invoking theAsyncIOWriter.close(AtmosphereResponse)method does not close the stream.Broadcast events to all or a subset of availableBroadcasters based on theirBroadcaster.getID()value.Cache message if noBroadcastermaps theMetaBroadcaster.broadcastTo(String, Object)Flush the cache every 30 seconds.AMeteoris a simple class that can be used from aServletto suspend, broadcast and resume responses.Simple Servlet to use when AtmosphereMeteorare used.An extendedBroadcastFilterthat can be used to filter based onAtmosphereResource.Serialize theObjectthat was used as parameter toBroadcaster.broadcast(java.lang.Object).Capable of restoring HTTP session timeout to given value.Allows invalidating and restoring HTTP session timeout.Universe contains static reference to Atmosphere's Factories.Factory forWebSocketProcessor.