Package org.atmosphere.interceptor

Class AtmosphereResourceStateRecovery

java.lang.Object

org.atmosphere.interceptor.AtmosphereResourceStateRecovery

All Implemented Interfaces:

AtmosphereInterceptor, AtmosphereConfigAware

public class AtmosphereResourceStateRecovery
extends java.lang.Object
implements AtmosphereInterceptor

This interceptor associates a AtmosphereResource to all Broadcaster the resource was added before the underlying connection got closed and resume. This allow an application to restore the state of the client before the disconnection occurred, and for the long-polling transport to return to it's previous state.

Author:

Jeanfrancois Arcand

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AtmosphereResourceStateRecovery.B
static class	AtmosphereResourceStateRecovery.BroadcasterTracker
static class	AtmosphereResourceStateRecovery.OnAlwaysSuspend

Constructor Summary

Constructors

Constructor	Description
AtmosphereResourceStateRecovery()

Method Summary

Modifier and Type	Method	Description
void	configure(AtmosphereConfig config)	Configure an AtmosphereFramework object.
void	destroy()	Clean the AtmosphereInterceptor when removed or when the Atmosphere is undeployed.
Action	inspect(AtmosphereResource r)	Invoked before an AtmosphereResource gets dispatched to AtmosphereHandler.
void	postInspect(AtmosphereResource r)	Invoked after an AtmosphereResource gets dispatched to AtmosphereHandler.
java.util.List<java.lang.Object>	retrieveCache(AtmosphereResource r, AtmosphereResourceStateRecovery.BroadcasterTracker tracker, boolean force)
protected void	startStateTracker()
java.util.concurrent.ConcurrentHashMap<java.lang.String,AtmosphereResourceStateRecovery.BroadcasterTracker>	states()
long	timeout()
AtmosphereResourceStateRecovery	timeout(long timeout)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AtmosphereResourceStateRecovery

public AtmosphereResourceStateRecovery()

Method Detail

configure

public void configure(AtmosphereConfig config)

Description copied from interface: AtmosphereConfigAware

Configure an AtmosphereFramework object.

Specified by:

configure in interface AtmosphereConfigAware

Parameters:

config - AtmosphereConfig

timeout

public AtmosphereResourceStateRecovery timeout(long timeout)

timeout

public long timeout()

startStateTracker

protected void startStateTracker()

inspect

public Action inspect(AtmosphereResource r)

Description copied from interface: AtmosphereInterceptor

Invoked before an AtmosphereResource gets dispatched to AtmosphereHandler.

Specified by:

inspect in interface AtmosphereInterceptor

Parameters:

r - a AtmosphereResource

Returns:

Action.CONTINUE or Action.SUSPEND to dispatch the AtmosphereResource to other AtmosphereInterceptor or AtmosphereHandler. Return Action.TYPE.CANCELLED to stop the processing.

postInspect

public void postInspect(AtmosphereResource r)

Description copied from interface: AtmosphereInterceptor

Invoked after an AtmosphereResource gets dispatched to AtmosphereHandler.

Specified by:

postInspect in interface AtmosphereInterceptor

Parameters:

r - a AtmosphereResource

destroy

public void destroy()

Description copied from interface: AtmosphereInterceptor

Clean the AtmosphereInterceptor when removed or when the Atmosphere is undeployed.

Specified by:

destroy in interface AtmosphereInterceptor

states

public java.util.concurrent.ConcurrentHashMap<java.lang.String,AtmosphereResourceStateRecovery.BroadcasterTracker> states()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

retrieveCache

public java.util.List<java.lang.Object> retrieveCache(AtmosphereResource r,
                                                      AtmosphereResourceStateRecovery.BroadcasterTracker tracker,
                                                      boolean force)