org.atmosphere.stomp

Class StompBroadcastFilter

java.lang.Object

org.atmosphere.stomp.StompBroadcastFilter

All Implemented Interfaces:

org.atmosphere.cpr.BroadcastFilter, org.atmosphere.cpr.BroadcastFilterLifecycle, org.atmosphere.cpr.PerRequestBroadcastFilter

public class StompBroadcastFilter
extends Object
implements org.atmosphere.cpr.PerRequestBroadcastFilter, org.atmosphere.cpr.BroadcastFilterLifecycle

This filter transforms the broadcasted String considered as STOMP body to a message. A specific frame will be created and broadcasted for each subscription for the mapping (the broadcaster ID).

Since:

0.1

Version:

1.0

Author:

Guillaume DROUET

Nested Class Summary

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

org.atmosphere.cpr.BroadcastFilter.BroadcastAction

Field Summary

Fields inherited from interface org.atmosphere.cpr.BroadcastFilter

VOID_ATMOSPHERE_RESOURCE_UUID

Constructor Summary

Constructors

Constructor and Description
StompBroadcastFilter() Builds a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy()
org.atmosphere.cpr.BroadcastFilter.BroadcastAction	filter(String broadcasterId, org.atmosphere.cpr.AtmosphereResource atmosphereResource, Object originalMessage, Object message)
org.atmosphere.cpr.BroadcastFilter.BroadcastAction	filter(String broadcasterId, Object originalMessage, Object message)
void	init(org.atmosphere.cpr.AtmosphereConfig config)

Methods inherited from class java.lang.Object

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

Constructor Detail

StompBroadcastFilter

public StompBroadcastFilter()

Builds a new instance.

Method Detail

filter

public org.atmosphere.cpr.BroadcastFilter.BroadcastAction filter(String broadcasterId,
                                                        org.atmosphere.cpr.AtmosphereResource atmosphereResource,
                                                        Object originalMessage,
                                                        Object message)

Specified by:

filter in interface org.atmosphere.cpr.PerRequestBroadcastFilter

filter

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

Specified by:

filter in interface org.atmosphere.cpr.BroadcastFilter

init

public void init(org.atmosphere.cpr.AtmosphereConfig config)

Specified by:

init in interface org.atmosphere.cpr.BroadcastFilterLifecycle

destroy

public void destroy()

Specified by:

destroy in interface org.atmosphere.cpr.BroadcastFilterLifecycle