org.eclipse.scada.core.subscription

Class ListenableSubscriptionManager<T>

java.lang.Object

org.eclipse.scada.core.subscription.SubscriptionManager<T>

org.eclipse.scada.core.subscription.ListenableSubscriptionManager<T>

Type Parameters:

T - The topic type

public class ListenableSubscriptionManager<T>
extends SubscriptionManager<T>

Listen to the active subscriptions

All events are emitted from the domain of the executor

Constructor Summary

Constructors

Constructor and Description
ListenableSubscriptionManager(Executor executor)
ListenableSubscriptionManager(Executor executor, SubscriptionValidator<T> validator)

Method Summary

Methods

Modifier and Type	Method and Description
void	addManagerListener(SubscriptionManagerListener<T> listener) Add a listener to the manager
void	dispose()
protected void	fireAdded(List<SubscriptionManagerListener<T>> listeners, Set<T> topic)
protected void	fireRemoved(List<SubscriptionManagerListener<T>> listeners, Set<T> topic)
Set<T>	getAllSubscribedTopics()
void	removeManagerListener(SubscriptionManagerListener<T> listener)
protected void	topicSubscriptionAdded(T topic) Gets called when somebody subscribed to a topic that was not subscribed before
protected void	topicSubscriptionRemoved(T topic) Get called when somebody unsubscribed from a topic and it was the last subscription

Methods inherited from class org.eclipse.scada.core.subscription.SubscriptionManager

getAllGrantedTopics, getSubscriptionCount, setSource, subscribe, subscribe, unsubscribe, unsubscribeAll

Methods inherited from class java.lang.Object

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

Constructor Detail

ListenableSubscriptionManager

public ListenableSubscriptionManager(Executor executor)

ListenableSubscriptionManager

public ListenableSubscriptionManager(Executor executor,
                             SubscriptionValidator<T> validator)

Method Detail

topicSubscriptionAdded

protected void topicSubscriptionAdded(T topic)

Description copied from class: SubscriptionManager

Gets called when somebody subscribed to a topic that was not subscribed before

Overrides:

topicSubscriptionAdded in class SubscriptionManager<T>

Parameters:

topic - the topic

topicSubscriptionRemoved

protected void topicSubscriptionRemoved(T topic)

Description copied from class: SubscriptionManager

Get called when somebody unsubscribed from a topic and it was the last subscription

Overrides:

topicSubscriptionRemoved in class SubscriptionManager<T>

Parameters:

topic - the topic

addManagerListener

public void addManagerListener(SubscriptionManagerListener<T> listener)

Add a listener to the manager

Adding the listener to the manager will trigger an initial call to SubscriptionManagerListener.subscriptionsAdded(Set) with the currently open topics.

Parameters:

listener - the listener to add

removeManagerListener

public void removeManagerListener(SubscriptionManagerListener<T> listener)

fireAdded

protected void fireAdded(List<SubscriptionManagerListener<T>> listeners,
             Set<T> topic)

fireRemoved

protected void fireRemoved(List<SubscriptionManagerListener<T>> listeners,
               Set<T> topic)

getAllSubscribedTopics

public Set<T> getAllSubscribedTopics()

dispose

public void dispose()