org.eclipse.scada.da.connection.provider.internal

Class LazyConnectionWrapper

java.lang.Object

org.eclipse.scada.da.connection.provider.internal.LazyConnectionWrapper

All Implemented Interfaces:

Connection, StatisticsProvider

public abstract class LazyConnectionWrapper
extends Object
implements Connection, StatisticsProvider

Constructor Summary

Constructors

Constructor and Description
LazyConnectionWrapper(Connection connection, Integer lingeringTimeout)

Method Summary

Methods

Modifier and Type	Method and Description
void	addConnectionStateListener(ConnectionStateListener connectionStateListener)
void	addPrivilegeListener(PrivilegeListener listener) Add a listener to the privileges of the session
void	browse(Location location, BrowseOperationCallback callback) Browse a server folder for items.
void	connect() Start the connection
void	connect(CallbackHandler callbackHandler) Start the connection with a callback handler
void	disconnect() Stop the connection
void	dispose() Dispose the connection
ConnectionInformation	getConnectionInformation()
ScheduledExecutorService	getExecutor() Retrieve the executor that is currently set
Set<String>	getPrivileges() Return the list of currently granted privileges.
Map<String,String>	getSessionProperties() Return the session properties as provided by the server.
ConnectionState	getState() Get the current connection state
Collection<StatisticEntry>	getStatistics()
protected abstract void	performConnect()
protected abstract void	performDisconnect()
void	removeConnectionStateListener(ConnectionStateListener connectionStateListener)
void	removePrivilegeListener(PrivilegeListener listener)
void	setCallbackFactory(CallbackFactory callbackFactory)
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 java.lang.Object

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

Constructor Detail

LazyConnectionWrapper

public LazyConnectionWrapper(Connection connection,
                     Integer lingeringTimeout)

Method Detail

setCallbackFactory

public void setCallbackFactory(CallbackFactory callbackFactory)

Specified by:

setCallbackFactory in interface Connection

connect

public void connect()

Description copied from interface: Connection

Start the connection

Specified by:

connect in interface Connection

connect

public void connect(CallbackHandler callbackHandler)

Description copied from interface: Connection

Start the connection with a callback handler

Specified by:

connect in interface Connection

disconnect

public void disconnect()

Description copied from interface: Connection

Stop the connection

Specified by:

disconnect in interface Connection

dispose

public void dispose()

Description copied from interface: Connection

Dispose the connection

A dispose will also act as a disconnect.

Connections must be disposed in order to clean up all resources. In the past the Connection.disconnect() call was enough and, if possible, most resources (sockets) should be closed when disconnecting. Still some resources can be re-used and these need to be cleaned up in the Connection.dispose() call.

Specified by:

dispose in interface Connection

addConnectionStateListener

public void addConnectionStateListener(ConnectionStateListener connectionStateListener)

Specified by:

addConnectionStateListener in interface Connection

removeConnectionStateListener

public void removeConnectionStateListener(ConnectionStateListener connectionStateListener)

Specified by:

removeConnectionStateListener in interface Connection

getState

public ConnectionState getState()

Description copied from interface: Connection

Get the current connection state

Specified by:

getState in interface Connection

Returns:

The current connection state

getConnectionInformation

public ConnectionInformation getConnectionInformation()

Specified by:

getConnectionInformation in interface Connection

getSessionProperties

public Map<String,String> getSessionProperties()

Description copied from interface: Connection

Return the session properties as provided by the server. The session properties are only valid if the connection is in the state ConnectionState.BOUND

Specified by:

getSessionProperties in interface Connection

Returns:

the connection properties

addPrivilegeListener

public void addPrivilegeListener(PrivilegeListener listener)

Description copied from interface: Connection

Add a listener to the privileges of the session

When adding a new listener it will receive an initial call with the current privileges.

Specified by:

addPrivilegeListener in interface Connection

removePrivilegeListener

public void removePrivilegeListener(PrivilegeListener listener)

Specified by:

removePrivilegeListener in interface Connection

getPrivileges

public Set<String> getPrivileges()

Description copied from interface: Connection

Return the list of currently granted privileges.

Specified by:

getPrivileges in interface Connection

Returns:

the list of current privileges. Must never return null.

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

performConnect

protected abstract void performConnect()

performDisconnect

protected abstract void performDisconnect()

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

getStatistics

public Collection<StatisticEntry> getStatistics()

Specified by:

getStatistics in interface StatisticsProvider