org.eclipse.scada.core.subscription

Class SubscriptionManager

java.lang.Object

org.eclipse.scada.core.subscription.SubscriptionManager

public class SubscriptionManager
extends java.lang.Object

Manage subscriptions.

Constructor Summary

Constructors

Constructor and Description
SubscriptionManager()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.lang.Object>	getAllGrantedTopics() Get all topic whose subscription is in granted state.
int	getSubscriptionCount() Get the number of subscriptions currently registered
void	setSource(java.lang.Object topic, SubscriptionSource source) Set a source for a topic.
void	setValidator(SubscriptionValidator validator)
void	subscribe(java.lang.Object topic, SubscriptionListener listener) Subscribe to a topic.
void	subscribe(java.lang.Object topic, SubscriptionListener listener, java.lang.Object hint) Subscribe to a topic with a hint
void	unsubscribe(java.lang.Object topic, SubscriptionListener listener)
void	unsubscribeAll(SubscriptionListener listener) Unsibscribe from all subscriptions that the listener has subscribed to

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionManager

public SubscriptionManager()

Method Detail

unsubscribeAll

public void unsubscribeAll(SubscriptionListener listener)

Unsibscribe from all subscriptions that the listener has subscribed to

Parameters:

listener - the listener to unsubscribe

subscribe

public void subscribe(java.lang.Object topic,
             SubscriptionListener listener)
               throws ValidationException

Subscribe to a topic.

Parameters:

topic - The topic to which the subscription should be made

listener - The listener which will receive the events

Throws:

ValidationException - thrown if the subscription cannot be established (e.g. the topic is invalid)

subscribe

public void subscribe(java.lang.Object topic,
             SubscriptionListener listener,
             java.lang.Object hint)
               throws ValidationException

Subscribe to a topic with a hint

Parameters:

topic - The topic to which the subscription should be made

listener - The listener which will receive the events

hint - The hint is specific to the topic

Throws:

ValidationException - thrown if the subscription cannot be established (e.g. the topic is invalid)

unsubscribe

public void unsubscribe(java.lang.Object topic,
               SubscriptionListener listener)

setValidator

public void setValidator(SubscriptionValidator validator)

setSource

public void setSource(java.lang.Object topic,
             SubscriptionSource source)

Set a source for a topic. This will cause all granted subscriptions to switch to connected for this source

Parameters:

topic - the topic

source - the source to set

getSubscriptionCount

public int getSubscriptionCount()

Get the number of subscriptions currently registered

Returns:

the number of subscriptions

getAllGrantedTopics

public java.util.List<java.lang.Object> getAllGrantedTopics()

Get all topic whose subscription is in granted state.

Returns:

The list of topics whose subscription is in granted state.