org.thales.punch.libraries.storm.util

Class WhiteBoard

java.lang.Object

org.thales.punch.libraries.storm.util.WhiteBoard

All Implemented Interfaces:

IWhiteBoard

public class WhiteBoard
extends Object
implements IWhiteBoard

The WhiteBoard is in charge of maintain subscriptions used by consumer (HttpSpout) and producer (WhiteBoardBolt) to communicate. The consumer subscribes to the shared whiteboard (static) when it receives data and the producer publishes to the whiteboard when it receives corresponding data.

Field Summary

Fields

Modifier and Type	Field and Description
Subscriptions	subscriptions

Method Summary

Modifier and Type	Method and Description
static WhiteBoard	getInstance() The getInstance method is in charge of returning the singleton static instance of the whiteboard object.
void	publish(String key, Object result) The publish method is called by the producer when it receives data to call back the consumer.
void	subscribe(String key, ISubscription s) The subscribe method is called by the consumer when it receives data.
void	unsubscribe(String key) The unsubscribe method is called by the producer when the subscription does not need to be maintained, its role is over.

Methods inherited from class java.lang.Object

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

Field Detail

subscriptions

public Subscriptions subscriptions

Method Detail

getInstance

public static WhiteBoard getInstance()

The getInstance method is in charge of returning the singleton static instance of the whiteboard object.

Returns:

the whiteboard instance

subscribe

public void subscribe(String key,
                      ISubscription s)

The subscribe method is called by the consumer when it receives data.

Specified by:

subscribe in interface IWhiteBoard

Parameters:

key - the unique id of the subscription

s - the subscription containing a callback

publish

public void publish(String key,
                    Object result)

The publish method is called by the producer when it receives data to call back the consumer.

Specified by:

publish in interface IWhiteBoard

Parameters:

key - the unique id of the subscription

result - the subscription containing a callback

unsubscribe

public void unsubscribe(String key)

The unsubscribe method is called by the producer when the subscription does not need to be maintained, its role is over.

Specified by:

unsubscribe in interface IWhiteBoard

Parameters:

key - the unique id of the subscription