eu.hgross.blaubot.util

Class ChannelSubscriptionListener

java.lang.Object

eu.hgross.blaubot.util.ChannelSubscriptionListener

All Implemented Interfaces:

ILifecycleListener, IBlaubotAdminMessageListener

public class ChannelSubscriptionListener
extends java.lang.Object
implements IBlaubotAdminMessageListener, ILifecycleListener

Keeps track of subscriptions to channels by checking admin messages and the LifeCycleListeners. It can be used to sniff the current subscriptions and channels out of the admin messages and eventing system at runtime.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ChannelSubscriptionListener.SubscriptionChangeListener

Constructor Summary

Constructors

Constructor and Description
ChannelSubscriptionListener()

Method Summary

Modifier and Type	Method and Description
void	addSubscriptionChangeListener(ChannelSubscriptionListener.SubscriptionChangeListener changeListener) Adds a listener to be informed when the subscriptions change.
java.util.Set<java.lang.Short>	getChannels() The set of known channels that are used
java.util.Set<java.lang.String>	getSubscribersOfChannel(short channelId) creates a set of the known subscribers to a specific channel id.
void	onAdminMessage(AbstractAdminMessage adminMessage) Called when an admin message was received
void	onConnected() Triggered when the Blaubot instance becomes part of a blaubot kingdom.
void	onDeviceJoined(IBlaubotDevice blaubotDevice) Triggered when another Blaubot instance on another IBlaubotDevice joined the network.
void	onDeviceLeft(IBlaubotDevice blaubotDevice) Triggered when an IBlaubotDevice left the blaubot kingdom.
void	onDisconnected() Triggered when the Blaubot instance is no longer part of a blaubot kingdom.
void	onKingDeviceChanged(IBlaubotDevice oldKing, IBlaubotDevice newKing) Triggered when the king device was changed.
void	onPrinceDeviceChanged(IBlaubotDevice oldPrince, IBlaubotDevice newPrince) Triggered when a prince nomination was completed.
void	removeSubscriptionChangeListener(ChannelSubscriptionListener.SubscriptionChangeListener changeListener) Removes a formerly added listener

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelSubscriptionListener

public ChannelSubscriptionListener()

Method Detail

getChannels

public java.util.Set<java.lang.Short> getChannels()

The set of known channels that are used

Returns:

list of channels that we know of

getSubscribersOfChannel

public java.util.Set<java.lang.String> getSubscribersOfChannel(short channelId)

creates a set of the known subscribers to a specific channel id.

Parameters:

channelId - the channel to retrieve the list of subscribers for

Returns:

the set of subscribers for the given channel id

onAdminMessage

public void onAdminMessage(AbstractAdminMessage adminMessage)

Description copied from interface: IBlaubotAdminMessageListener

Called when an admin message was received

Specified by:

onAdminMessage in interface IBlaubotAdminMessageListener

Parameters:

adminMessage - the received admin message

onConnected

public void onConnected()

Description copied from interface: ILifecycleListener

Triggered when the Blaubot instance becomes part of a blaubot kingdom.

Specified by:

onConnected in interface ILifecycleListener

onDisconnected

public void onDisconnected()

Description copied from interface: ILifecycleListener

Triggered when the Blaubot instance is no longer part of a blaubot kingdom.

Specified by:

onDisconnected in interface ILifecycleListener

onDeviceJoined

public void onDeviceJoined(IBlaubotDevice blaubotDevice)

Description copied from interface: ILifecycleListener

Triggered when another Blaubot instance on another IBlaubotDevice joined the network. It is guaranteed that for one specific IBlaubotDevice ILifecycleListener.onDeviceJoined(IBlaubotDevice) is never called twice without a triggered ILifecycleListener.onDeviceLeft(IBlaubotDevice) in between.

Specified by:

onDeviceJoined in interface ILifecycleListener

Parameters:

blaubotDevice - the joined device

onDeviceLeft

public void onDeviceLeft(IBlaubotDevice blaubotDevice)

Description copied from interface: ILifecycleListener

Triggered when an IBlaubotDevice left the blaubot kingdom.

Specified by:

onDeviceLeft in interface ILifecycleListener

Parameters:

blaubotDevice - the device that just left

onPrinceDeviceChanged

public void onPrinceDeviceChanged(IBlaubotDevice oldPrince,
                                  IBlaubotDevice newPrince)

Description copied from interface: ILifecycleListener

Triggered when a prince nomination was completed.

Specified by:

onPrinceDeviceChanged in interface ILifecycleListener

Parameters:

oldPrince - the old prince (may be null, in case no prince was nominated previously)

newPrince - the new prince (may be null, in case there is no device to be prince)

onKingDeviceChanged

public void onKingDeviceChanged(IBlaubotDevice oldKing,
                                IBlaubotDevice newKing)

Description copied from interface: ILifecycleListener

Triggered when the king device was changed. Both params may be null, if there was no king before or is no king now.

Specified by:

onKingDeviceChanged in interface ILifecycleListener

Parameters:

oldKing - the old king

newKing - the new king

addSubscriptionChangeListener

public void addSubscriptionChangeListener(ChannelSubscriptionListener.SubscriptionChangeListener changeListener)

Adds a listener to be informed when the subscriptions change.

Parameters:

changeListener - the listener to be added

removeSubscriptionChangeListener

public void removeSubscriptionChangeListener(ChannelSubscriptionListener.SubscriptionChangeListener changeListener)

Removes a formerly added listener

Parameters:

changeListener - the listener to be removed