org.atmosphere.cpr
Interface BroadcastFilter

All Known Subinterfaces:

BroadcastFilterLifecycle, ClusterBroadcastFilter, PerRequestBroadcastFilter

All Known Implementing Classes:

FormParamFilter, JSONPTransportFilter, StringFilterAggregator, TrackMessageSizeFilter, XSSHtmlFilter

public interface BroadcastFilter

Transform a message of type 'E" before it get broadcasted to AtmosphereHandler.onStateChange(org.atmosphere.cpr.AtmosphereResourceEvent)

See XSSHtmlFilter for an example.

Author:

Jeanfrancois Arcand

Nested Class Summary

static class

BroadcastFilter.BroadcastAction Simple class that tells the Broadcaster to broadcast or not the transformed value.

Method Summary

BroadcastFilter.BroadcastAction

filter(Object originalMessage, Object message) Transform or Filter a message.

Method Detail

filter

BroadcastFilter.BroadcastAction filter(Object originalMessage,
                                       Object message)

Transform or Filter a message. Return null to tell the associated Broadcaster to discard the message, e.g to not broadcast it.

Parameters:

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

message - Object a message

Returns:

a transformed message.