Package org.atmosphere.cpr

Class BroadcastFilterAdapter

java.lang.Object

org.atmosphere.cpr.BroadcastFilterAdapter

All Implemented Interfaces:

BroadcastFilter, PerRequestBroadcastFilter

public class BroadcastFilterAdapter
extends Object
implements PerRequestBroadcastFilter

Adapter for PerRequestBroadcastFilter. Both methods return BroadcastFilter.BroadcastAction.ACTION.CONTINUE with the message.

Author:

Jeanfrancois Arcand

Nested Class Summary

Nested classes/interfaces inherited from interface org.atmosphere.cpr.BroadcastFilter

BroadcastFilter.BroadcastAction

Field Summary

Fields inherited from interface org.atmosphere.cpr.BroadcastFilter

VOID_ATMOSPHERE_RESOURCE_UUID

Constructor Summary

Constructors

Constructor	Description
BroadcastFilterAdapter()

Method Summary

Modifier and Type	Method	Description
BroadcastFilter.BroadcastAction	filter(String broadcasterId, Object originalMessage, Object message)	Transform or filter a message.
BroadcastFilter.BroadcastAction	filter(String broadcasterId, AtmosphereResource r, Object originalMessage, Object message)	Transform or filter a message per AtmosphereResource.

Methods inherited from class java.lang.Object

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

Constructor Details

BroadcastFilterAdapter

public BroadcastFilterAdapter()

Method Details

filter

public BroadcastFilter.BroadcastAction filter(String broadcasterId,
 AtmosphereResource r,
 Object originalMessage,
 Object message)

Description copied from interface: PerRequestBroadcastFilter

Transform or filter a message per AtmosphereResource. Be careful when setting headers on the AtmosphereResponse as the headers may have been already sent back to the browser.

Specified by:

filter in interface PerRequestBroadcastFilter

Parameters:

broadcasterId - the Broadcaster.getID()

r - the AtmosphereResource

originalMessage - The original message used when calling Broadcaster.broadcast(Object)

message - a message

Returns:

a BroadcastFilter.BroadcastAction

filter

public BroadcastFilter.BroadcastAction filter(String broadcasterId,
 Object originalMessage,
 Object message)

Description copied from interface: BroadcastFilter

Transform or filter a message. Return BroadcastAction(ACTION.ABORT, message) Broadcaster to discard the message, eg. to not broadcast it.

Specified by:

filter in interface BroadcastFilter

Parameters:

broadcasterId - the Broadcaster.getID() calling this object

originalMessage - The original message which was Broadcaster.broadcast(Object);

message - The transformed or not message.

Returns:

a transformed message.