org.eclipse.scada.da.client.sfp

Class ConnectionImpl

java.lang.Object

org.eclipse.scada.core.client.common.BaseConnection

org.eclipse.scada.core.client.common.ClientBaseConnection

org.eclipse.scada.da.client.sfp.ConnectionImpl

All Implemented Interfaces:

Connection, StatisticsProvider

public class ConnectionImpl
extends ClientBaseConnection
implements Connection

Field Summary

Fields inherited from class org.eclipse.scada.core.client.common.ClientBaseConnection

callbackFactory, connectCallbackHandler

Fields inherited from class org.eclipse.scada.core.client.common.BaseConnection

connectionInformation, executor, statistics

Constructor Summary

Constructors

Constructor and Description
ConnectionImpl(ConnectionInformation connectionInformation)

Method Summary

Methods

Modifier and Type	Method and Description
void	browse(Location location, BrowseOperationCallback callback) Browse a server folder for items.
ScheduledExecutorService	getExecutor() Retrieve the executor that is currently set
protected void	handleMessage(Object message) Handle a message that came in by the current session.
protected void	onConnectionClosed() Called when the connection got closed
protected void	onConnectionConnected() Called when the connection got connected
FolderListener	setFolderListener(Location location, FolderListener listener) Set the listener for this location.
ItemUpdateListener	setItemUpdateListener(String itemId, ItemUpdateListener listener) Set the listener for this item.
NotifyFuture<WriteResult>	startWrite(String itemId, Variant value, OperationParameters operationParameters, CallbackHandler callbackHandler)
NotifyFuture<WriteAttributeResults>	startWriteAttributes(String itemId, Map<String,Variant> attributes, OperationParameters operationParameters, CallbackHandler callbackHandler)
void	subscribeFolder(Location location)
void	subscribeItem(String itemId)
void	unsubscribeFolder(Location location)
void	unsubscribeItem(String itemId)
void	write(String itemId, Variant value, OperationParameters operationParameters, WriteOperationCallback callback)
void	writeAttributes(String itemId, Map<String,Variant> attributes, OperationParameters operationParameters, WriteAttributeOperationCallback callback)

Methods inherited from class org.eclipse.scada.core.client.common.ClientBaseConnection

addConnectionStateListener, addPrivilegeListener, connect, connect, disconnect, dispose, firePrivilegeChange, getPrivileges, getSession, getSslSession, getState, handleConnectComplete, isDisposed, messageReceived, onConnectionBound, performClosed, performDisconnected, performOpened, removeConnectionStateListener, removePrivilegeListener, sendMessage, sendMessageChecked, setCallbackFactory, setState, switchState

Methods inherited from class org.eclipse.scada.core.client.common.BaseConnection

getConnectionInformation, getSessionProperties, getStatistics, setSessionProperties

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.client.Connection

addConnectionStateListener, addPrivilegeListener, connect, connect, disconnect, dispose, getConnectionInformation, getPrivileges, getSessionProperties, getState, removeConnectionStateListener, removePrivilegeListener, setCallbackFactory

Constructor Detail

ConnectionImpl

public ConnectionImpl(ConnectionInformation connectionInformation)
               throws Exception

Throws:

Exception

Method Detail

onConnectionConnected

protected void onConnectionConnected()

Description copied from class: ClientBaseConnection

Called when the connection got connected

This method is called while the connection lock is held.

The default implementation switches directly to ConnectionState.BOUND

Overrides:

onConnectionConnected in class ClientBaseConnection

handleMessage

protected void handleMessage(Object message)

Description copied from class: ClientBaseConnection

Handle a message that came in by the current session.

Note that the method is called while holding the lock the connection itself.

Specified by:

handleMessage in class ClientBaseConnection

Parameters:

message - the received message

onConnectionClosed

protected void onConnectionClosed()

Description copied from class: ClientBaseConnection

Called when the connection got closed

This method is called while the connection lock is held.

The default implementation does nothing.

Overrides:

onConnectionClosed in class ClientBaseConnection

browse

public void browse(Location location,
          BrowseOperationCallback callback)

Description copied from interface: Connection

Browse a server folder for items. The operation will return immediately.

Parameters:

location - The path to browse

callback - The callback that shall receive notifications of the operation

write

public void write(String itemId,
         Variant value,
         OperationParameters operationParameters,
         WriteOperationCallback callback)

writeAttributes

public void writeAttributes(String itemId,
                   Map<String,Variant> attributes,
                   OperationParameters operationParameters,
                   WriteAttributeOperationCallback callback)

startWrite

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

startWriteAttributes

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

subscribeFolder

public void subscribeFolder(Location location)
                     throws NoConnectionException,
                            OperationException

Throws:

NoConnectionException

OperationException

unsubscribeFolder

public void unsubscribeFolder(Location location)
                       throws NoConnectionException,
                              OperationException

Throws:

NoConnectionException

OperationException

setFolderListener

public FolderListener setFolderListener(Location location,
                               FolderListener listener)

Description copied from interface: Connection

Set the listener for this location.

Parameters:

location - The location for which to set the listener

listener - The listener to set

Returns:

The previous set listener or null if there was no previous listener

subscribeItem

public void subscribeItem(String itemId)
                   throws NoConnectionException,
                          OperationException

Throws:

NoConnectionException

OperationException

unsubscribeItem

public void unsubscribeItem(String itemId)
                     throws NoConnectionException,
                            OperationException

Throws:

NoConnectionException

OperationException

setItemUpdateListener

public ItemUpdateListener setItemUpdateListener(String itemId,
                                       ItemUpdateListener listener)

Description copied from interface: Connection

Set the listener for this item.

Parameters:

itemId - The item for which to set the listener

listener - The listener to set

Returns:

The previous set listener or null if there was no previous listener

getExecutor

public ScheduledExecutorService getExecutor()

Description copied from interface: Connection

Retrieve the executor that is currently set

Returns:

the currently used executor. Implementations must never return null