org.eclipse.scada.da.server.proxy.connection

Class ProxyGroup

java.lang.Object

org.eclipse.scada.da.server.proxy.connection.ProxyGroup

All Implemented Interfaces:

LifecycleAware

public class ProxyGroup
extends Object
implements LifecycleAware

Author:

Juergen Rose <juergen.rose@th4-systems.com>

Constructor Summary

Constructors

Constructor and Description
ProxyGroup(Hive hive, ProxyPrefixName prefix)

Method Summary

Modifier and Type	Method and Description
void	addConnection(Connection connection, String id, ProxyPrefixName prefix, FolderCommon connectionFolder)
void	addConnectionStateListener(ConnectionStateListener connectionStateListener)
void	connectCurrentConnection()
String	convertToOriginalId(String itemId)
String	convertToProxyId(String itemId)
void	disconnectCurrentConnection()
FolderCommon	getConnectionFolder()
ProxySubConnectionId	getCurrentConnection()
ProxyPrefixName	getPrefix()
Map<String,ProxyDataItem>	getRegisteredItems()
String	getSeparator()
Map<ProxySubConnectionId,ProxySubConnection>	getSubConnections()
int	getWait()
ProxyDataItem	realizeItem(String id)
void	removeConnectionStateListener(ConnectionStateListener connectionStateListener)
void	setConnectionFolder(FolderCommon connectionFolder)
void	setPrefix(ProxyPrefixName prefix)
void	setWait(int wait)
void	start()
void	stop()
void	switchTo(ProxySubConnectionId newConnectionId)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyGroup

public ProxyGroup(Hive hive,
                  ProxyPrefixName prefix)

Parameters:

hive -

prefix -

Method Detail

start

public void start()

Specified by:

start in interface LifecycleAware

stop

public void stop()

Specified by:

stop in interface LifecycleAware

getConnectionFolder

public FolderCommon getConnectionFolder()

Returns:

folder which holds items and connection information

setConnectionFolder

public void setConnectionFolder(FolderCommon connectionFolder)

Parameters:

connectionFolder -

addConnection

public void addConnection(Connection connection,
                          String id,
                          ProxyPrefixName prefix,
                          FolderCommon connectionFolder)
                   throws InvalidOperationException,
                          NullValueException,
                          NotConvertableException

Parameters:

connection -

id -

prefix -

folderCommon -

Throws:

InvalidOperationException

NullValueException

NotConvertableException

addConnectionStateListener

public void addConnectionStateListener(ConnectionStateListener connectionStateListener)

Parameters:

connectionStateListener -

getCurrentConnection

public ProxySubConnectionId getCurrentConnection()

Returns:

name of currently active connection

getPrefix

public ProxyPrefixName getPrefix()

Returns:

item prefix for this proxy, which will replace original prefix

getRegisteredItems

public Map<String,ProxyDataItem> getRegisteredItems()

Returns:

all available items which are already subscribed

getSeparator

public String getSeparator()

Returns:

separator which separates prefix from rest of item name

getSubConnections

public Map<ProxySubConnectionId,ProxySubConnection> getSubConnections()

Returns:

map with all added subconnections

getWait

public int getWait()

Returns:

time how long proxy should wait if subconnection is lost, before item is set on error

convertToOriginalId

public String convertToOriginalId(String itemId)

Parameters:

itemId -

Returns:

original item id

convertToProxyId

public String convertToProxyId(String itemId)

Parameters:

itemId - the item id to convert (from the original source)

Returns:

return name of item in proxy or null if the item does not match the proxy group

disconnectCurrentConnection

public void disconnectCurrentConnection()

connectCurrentConnection

public void connectCurrentConnection()

realizeItem

public ProxyDataItem realizeItem(String id)

Parameters:

id -

Returns:

creates item and puts it in map

removeConnectionStateListener

public void removeConnectionStateListener(ConnectionStateListener connectionStateListener)

Parameters:

connectionStateListener -

setPrefix

public void setPrefix(ProxyPrefixName prefix)

Parameters:

prefix -

setWait

public void setWait(int wait)

Parameters:

wait -

switchTo

public void switchTo(ProxySubConnectionId newConnectionId)

Parameters:

newConnectionId -