Package org.atmosphere.room

Class RoomInterceptor

java.lang.Object

org.atmosphere.cpr.AtmosphereInterceptorAdapter

org.atmosphere.room.RoomInterceptor

All Implemented Interfaces:

AtmosphereInterceptor, AtmosphereConfigAware, InvokationOrder

public class RoomInterceptor
extends AtmosphereInterceptorAdapter

Interceptor that auto-joins resources to rooms based on URL path.

Given a base path (default /room/), any request to /room/lobby will auto-join the resource to a room named "lobby".

 // Configure with framework
 RoomManager rooms = RoomManager.create(framework);
 framework.interceptor(new RoomInterceptor(rooms));

 // Or with a custom base path
 framework.interceptor(new RoomInterceptor(rooms, "/chat/"));
 

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
RoomInterceptor(RoomManager roomManager)
RoomInterceptor(RoomManager roomManager, String basePath)

Method Summary

Modifier and Type	Method	Description
Action	inspect(AtmosphereResource r)	Invoked before an AtmosphereResource gets dispatched to AtmosphereHandler.
String	toString()

Methods inherited from class org.atmosphere.cpr.AtmosphereInterceptorAdapter

configure, destroy, postInspect, priority

Methods inherited from class java.lang.Object

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

Constructor Details

RoomInterceptor

public RoomInterceptor(RoomManager roomManager)

RoomInterceptor

public RoomInterceptor(RoomManager roomManager,
 String basePath)

Method Details

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.

toString

public String toString()

Overrides:

toString in class AtmosphereInterceptorAdapter