org.eclipse.scada.da.server.common.impl

Class SessionCommon

java.lang.Object

org.eclipse.scada.core.server.common.session.AbstractSessionImpl

org.eclipse.scada.da.server.common.impl.SessionCommon

All Implemented Interfaces:

Session, SubscriptionListener<String>, DataItemSubscriptionListener

public class SessionCommon
extends AbstractSessionImpl
implements Session, DataItemSubscriptionListener

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.scada.core.server.common.session.AbstractSessionImpl

AbstractSessionImpl.DisposeListener

Nested classes/interfaces inherited from interface org.eclipse.scada.core.server.Session

Session.SessionListener

Constructor Summary

Constructors

Constructor and Description
SessionCommon(HiveCommon hive, UserInformation userInformation, Map<String,String> properties)

Method Summary

Modifier and Type	Method and Description
void	addFuture(NotifyFuture<?> future) Add a future to the session.
void	dataChanged(DataItem item, Variant value, Map<String,Variant> attributes, boolean cache)
void	dispose() Dispose the session
SessionCommonData	getData()
FolderListener	getFolderListener()
HiveCommon	getHive()
ItemChangeListener	getListener()
void	removeFuture(NotifyFuture<?> future)
void	setListener(FolderListener folderListener)
void	setListener(ItemChangeListener listener)
void	updateStatus(String topic, SubscriptionState subscriptionState) The subscription status update method.

Methods inherited from class org.eclipse.scada.core.server.common.session.AbstractSessionImpl

addDisposeListener, addSessionListener, firePrivilegeChange, getPrivileges, getProperties, getUserInformation, removeDisposeListener, removeSessionListener, setPrivileges, wrapCallbackHandler

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.scada.core.server.Session

addSessionListener, getPrivileges, getProperties, removeSessionListener

Constructor Detail

SessionCommon

public SessionCommon(HiveCommon hive,
                     UserInformation userInformation,
                     Map<String,String> properties)

Method Detail

getHive

public HiveCommon getHive()

setListener

public void setListener(ItemChangeListener listener)

getListener

public ItemChangeListener getListener()

getData

public SessionCommonData getData()

getFolderListener

public FolderListener getFolderListener()

setListener

public void setListener(FolderListener folderListener)

updateStatus

public void updateStatus(String topic,
                         SubscriptionState subscriptionState)

Description copied from interface: SubscriptionListener

The subscription status update method. It is called by the SubscriptionSource whenever the subscription changed.

Specified by:

updateStatus in interface SubscriptionListener<String>

Parameters:

topic - The topic that is notified

subscriptionState - The new status of the subscription

dataChanged

public void dataChanged(DataItem item,
                        Variant value,
                        Map<String,Variant> attributes,
                        boolean cache)

Specified by:

dataChanged in interface DataItemSubscriptionListener

addFuture

public void addFuture(NotifyFuture<?> future)
               throws InvalidSessionException

Add a future to the session.

The future will be canceled when the session is completed. The session subscribes to the future state in order to remove the future from the session one it is completed.

Parameters:

future - the future to add

Throws:

InvalidSessionException - in case the session was already disposed

removeFuture

public void removeFuture(NotifyFuture<?> future)

dispose

public void dispose()

Dispose the session

Overrides:

dispose in class AbstractSessionImpl