org.eclipse.scada.da.client

Interface Connection

All Superinterfaces:

Connection

public interface Connection
extends Connection

A DataAccess (DA) connection.

Author:

Jens Reimann <jens.reimann@th4-systems.com>

Method Summary

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
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) Deprecated. use startWrite(String, Variant, OperationParameters, CallbackHandler) instead
void	writeAttributes(String itemId, Map<String,Variant> attributes, OperationParameters operationParameters, WriteAttributeOperationCallback callback) Deprecated. use startWriteAttributes(String, Map, OperationParameters, CallbackHandler) instead

Methods inherited from interface org.eclipse.scada.core.client.Connection

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

Method Detail

browse

void browse(Location location,
            BrowseOperationCallback callback)

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

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

Deprecated. use startWrite(String, Variant, OperationParameters, CallbackHandler) instead

writeAttributes

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

Deprecated. use startWriteAttributes(String, Map, OperationParameters, CallbackHandler) instead

startWrite

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

startWriteAttributes

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

subscribeFolder

void subscribeFolder(Location location)
              throws NoConnectionException,
                     OperationException

Throws:

NoConnectionException

OperationException

unsubscribeFolder

void unsubscribeFolder(Location location)
                throws NoConnectionException,
                       OperationException

Throws:

NoConnectionException

OperationException

setFolderListener

FolderListener setFolderListener(Location location,
                                 FolderListener listener)

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

void subscribeItem(String itemId)
            throws NoConnectionException,
                   OperationException

Throws:

NoConnectionException

OperationException

unsubscribeItem

void unsubscribeItem(String itemId)
              throws NoConnectionException,
                     OperationException

Throws:

NoConnectionException

OperationException

setItemUpdateListener

ItemUpdateListener setItemUpdateListener(String itemId,
                                         ItemUpdateListener listener)

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

ScheduledExecutorService getExecutor()

Retrieve the executor that is currently set

Returns:

the currently used executor. Implementations must never return null