org.atmosphere.cpr

Interface AtmosphereInterceptor

All Known Implementing Classes:

AndroidAtmosphereInterceptor, AtmosphereHandlerServiceInterceptor, AtmosphereInterceptorAdapter, AtmosphereResourceLifecycleInterceptor, AtmosphereResourceStateRecovery, BroadcastOnPostAtmosphereInterceptor, CorsInterceptor, DefaultHeadersInterceptor, HeartbeatInterceptor, JavaScriptProtocol, JSONPAtmosphereInterceptor, ManagedServiceInterceptor, MeteorServiceInterceptor, NginxInterceptor, OnDisconnectInterceptor, PaddingAtmosphereInterceptor, SessionCreationInterceptor, ShiroInterceptor, SSEAtmosphereInterceptor, SuspendTrackerInterceptor, TrackMessageSizeB64Interceptor, TrackMessageSizeInterceptor, WebSocketMessageSuspendInterceptor

public interface AtmosphereInterceptor

Intercept the dispatch of AtmosphereResource before they get dispatched to AtmosphereHandlers. An implementation of this class can intercept the dispatch and modify the AtmosphereResource and its associated AtmosphereRequest and AtmosphereResponse.

This class can be used to implement custom protocols like Server-Side Events, Socket.IO, etc.

Author:

Jeanfrancois Arcand

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(AtmosphereConfig config) Allow this object to configure its state when initialized.
Action	inspect(AtmosphereResource r) Invoked before an AtmosphereResource gets dispatched to AtmosphereHandler.
void	postInspect(AtmosphereResource r) Invoked after an AtmosphereResource gets dispatched to AtmosphereHandler.

Method Detail

configure

void configure(AtmosphereConfig config)

Allow this object to configure its state when initialized.

Parameters:

config - an AtmosphereConfig

inspect

Action inspect(AtmosphereResource r)

Invoked before an AtmosphereResource gets dispatched to AtmosphereHandler.

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

void postInspect(AtmosphereResource r)

Invoked after an AtmosphereResource gets dispatched to AtmosphereHandler.

Parameters:

r - a AtmosphereResource