Package org.atmosphere.cpr

Class AtmosphereInterceptorAdapter

java.lang.Object

org.atmosphere.cpr.AtmosphereInterceptorAdapter

All Implemented Interfaces:

AtmosphereInterceptor, AtmosphereConfigAware, InvokationOrder

Direct Known Subclasses:

AndroidAtmosphereInterceptor, AtmosphereTracing, AuthInterceptor, BackpressureInterceptor, BroadcastOnPostAtmosphereInterceptor, CacheHeadersInterceptor, CorsInterceptor, HeartbeatInterceptor, IdleResourceInterceptor, JavaScriptProtocol, MDCInterceptor, MessageAckInterceptor, NginxInterceptor, OnDisconnectInterceptor, PaddingAtmosphereInterceptor, RateLimitingInterceptor, RoomInterceptor, RoomProtocolInterceptor, ServiceInterceptor, SessionCreationInterceptor, SimpleRestInterceptor, SSEAtmosphereInterceptor, SuspendTrackerInterceptor, TrackMessageSizeB64Interceptor, TrackMessageSizeInterceptor, WebSocketMessageSuspendInterceptor

public abstract class AtmosphereInterceptorAdapter
extends Object
implements AtmosphereInterceptor, InvokationOrder

A Simple AtmosphereInterceptor that creates an AtmosphereInterceptorWriter and sets it as the default AsyncIOWriter on an AtmosphereResponse.

Nested Class Summary

Nested classes/interfaces inherited from interface org.atmosphere.interceptor.InvokationOrder

InvokationOrder.PRIORITY

Field Summary

Fields inherited from interface org.atmosphere.interceptor.InvokationOrder

AFTER_DEFAULT, BEFORE_DEFAULT, FIRST_BEFORE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
AtmosphereInterceptorAdapter()

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.
InvokationOrder.PRIORITY	priority()	Return the priority an AtmosphereInterceptor must be executed.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

AtmosphereInterceptorAdapter

public AtmosphereInterceptorAdapter()

Method Details

configure

public void configure(AtmosphereConfig config)

Description copied from interface: AtmosphereConfigAware

Configure an AtmosphereFramework object.

Specified by:

configure in interface AtmosphereConfigAware

Parameters:

config - AtmosphereConfig

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

priority

public InvokationOrder.PRIORITY priority()

Description copied from interface: InvokationOrder

Return the priority an AtmosphereInterceptor must be executed.

Specified by:

priority in interface InvokationOrder

Returns:

PRIORITY

toString

public String toString()

Overrides:

toString in class Object