Package org.atmosphere.room

Class RoomProtocolInterceptor

java.lang.Object

org.atmosphere.cpr.AtmosphereInterceptorAdapter

org.atmosphere.room.RoomProtocolInterceptor

All Implemented Interfaces:

AtmosphereInterceptor, AtmosphereConfigAware, InvokationOrder

public class RoomProtocolInterceptor
extends AtmosphereInterceptorAdapter

Bridges the atmosphere.js client room protocol to the server-side Room API. Intercepts JSON messages from clients, decodes them via RoomProtocolCodec, and routes them to the appropriate Room operations.

This interceptor runs with InvokationOrder.PRIORITY.BEFORE_DEFAULT priority so it processes messages before BroadcastOnPostAtmosphereInterceptor.

Register manually or annotate with AtmosphereInterceptorService for auto-scanning:

 framework.interceptor(new RoomProtocolInterceptor());
 

Since:

4.0

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
RoomProtocolInterceptor()

Method Summary

Modifier and Type	Method	Description
void	configure(AtmosphereConfig config)	Configure an AtmosphereFramework object.
Action	inspect(AtmosphereResource r)	Invoked before an AtmosphereResource gets dispatched to AtmosphereHandler.
InvokationOrder.PRIORITY	priority()	Return the priority an AtmosphereInterceptor must be executed.
String	toString()

Methods inherited from class org.atmosphere.cpr.AtmosphereInterceptorAdapter

destroy, postInspect

Methods inherited from class java.lang.Object

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

Constructor Details

RoomProtocolInterceptor

public RoomProtocolInterceptor()

Method Details

configure

public void configure(AtmosphereConfig config)

Description copied from interface: AtmosphereConfigAware

Configure an AtmosphereFramework object.

Specified by:

configure in interface AtmosphereConfigAware

Overrides:

configure in class AtmosphereInterceptorAdapter

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

Overrides:

inspect in class AtmosphereInterceptorAdapter

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.

priority

public InvokationOrder.PRIORITY priority()

Description copied from interface: InvokationOrder

Return the priority an AtmosphereInterceptor must be executed.

Specified by:

priority in interface InvokationOrder

Overrides:

priority in class AtmosphereInterceptorAdapter

Returns:

PRIORITY

toString

public String toString()

Overrides:

toString in class AtmosphereInterceptorAdapter