org.eclipse.scada.da.server.exporter.common

Class AbstractSubscriptionManager

java.lang.Object

org.eclipse.scada.da.server.exporter.common.AbstractSubscriptionManager

Direct Known Subclasses:

AggregatingSubscriptionManager, SingleSubscriptionManager

public abstract class AbstractSubscriptionManager
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,DataItemValue>	cache
protected boolean	started

Constructor Summary

Constructors

Constructor and Description
AbstractSubscriptionManager(HiveSource hiveSource, Properties properties, ScheduledExecutorService executor, String logName) Create a new subscription manager

Method Summary

Modifier and Type	Method and Description
protected void	bind(Hive hive)
protected void	clearCache()
Map<String,DataItemValue>	getCacheCopy()
DataItemValue	getCacheValue(String itemId)
SortedMap<String,DataItemValue>	getSortedCacheCopy()
protected void	handleCreateSessionResult(Future<Session> future)
protected void	handleDataChanged(String itemId, Variant value, Map<String,Variant> attributes, boolean cache)
protected void	handleSubscriptionChanged(String itemId, SubscriptionState subscriptionState)
protected void	performSetHive(Hive hive)
protected void	putState(String itemId, DataItemValue value)
void	start()
void	stop()
protected void	subscribe(String itemId) Subscribe to an item
protected void	subscribeAll(Set<String> itemIds) Subscribe to multiple items
protected void	unbind()
protected void	unsubscribe(String itemId)
NotifyFuture<WriteAttributeResults>	writeAttributes(String itemId, Map<String,Variant> attributes, OperationParameters operationParameters, CallbackHandler callbackHandler)
NotifyFuture<WriteResult>	writeValue(String itemId, Variant value, OperationParameters operationParameters, CallbackHandler callbackHandler)

Methods inherited from class java.lang.Object

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

Field Detail

cache

protected final Map<String,DataItemValue> cache

started

protected volatile boolean started

Constructor Detail

AbstractSubscriptionManager

public AbstractSubscriptionManager(HiveSource hiveSource,
                                   Properties properties,
                                   ScheduledExecutorService executor,
                                   String logName)

Create a new subscription manager

Parameters:

hiveSource - the source of the hive to attach to

properties - the hive connection properties

logName - An optional name of the actor, which will be used for logging

Method Detail

start

public void start()

stop

public void stop()

performSetHive

protected void performSetHive(Hive hive)

bind

protected void bind(Hive hive)

unbind

protected void unbind()

handleCreateSessionResult

protected void handleCreateSessionResult(Future<Session> future)

subscribe

protected void subscribe(String itemId)

Subscribe to an item

Subscriptions may only be made after the manager was started using start().

Parameters:

itemId - id of the item to subscribe to

subscribeAll

protected void subscribeAll(Set<String> itemIds)

Subscribe to multiple items

Subscriptions may only be made after the manager was started using start().

Parameters:

itemIds - the ids of the items to subscribe to

unsubscribe

protected void unsubscribe(String itemId)

clearCache

protected void clearCache()

putState

protected void putState(String itemId,
                        DataItemValue value)

getCacheCopy

public Map<String,DataItemValue> getCacheCopy()

getSortedCacheCopy

public SortedMap<String,DataItemValue> getSortedCacheCopy()

getCacheValue

public DataItemValue getCacheValue(String itemId)

handleDataChanged

protected void handleDataChanged(String itemId,
                                 Variant value,
                                 Map<String,Variant> attributes,
                                 boolean cache)

handleSubscriptionChanged

protected void handleSubscriptionChanged(String itemId,
                                         SubscriptionState subscriptionState)

writeValue

public NotifyFuture<WriteResult> writeValue(String itemId,
                                            Variant value,
                                            OperationParameters operationParameters,
                                            CallbackHandler callbackHandler)

writeAttributes

public NotifyFuture<WriteAttributeResults> writeAttributes(String itemId,
                                                           Map<String,Variant> attributes,
                                                           OperationParameters operationParameters,
                                                           CallbackHandler callbackHandler)