org.eclipse.scada.da.client.net

Class Connection

java.lang.Object

org.eclipse.scada.core.client.net.ConnectionBase

org.eclipse.scada.core.client.net.SessionConnectionBase

org.eclipse.scada.da.client.net.Connection

All Implemented Interfaces:

org.apache.mina.core.service.IoHandler, Connection, StatisticsProvider

public class Connection
extends SessionConnectionBase
implements Connection

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Connection.WriteAttributeOperationFuture
static class	Connection.WriteOperationFuture

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION

Fields inherited from class org.eclipse.scada.core.client.net.SessionConnectionBase

executor, SESSION_CLIENT_VERSION

Fields inherited from class org.eclipse.scada.core.client.net.ConnectionBase

messenger, session, statistics

Constructor Summary

Constructors

Constructor and Description
Connection(ConnectionInformation connectionInformantion)

Method Summary

Methods

Modifier and Type	Method and Description
void	browse(Location location, BrowseOperationCallback callback) Browse a server folder for items.
Entry[]	browse(Location location, int timeout)
protected Entry[]	completeBrowse(LongRunningOperation operation)
protected void	completeWrite(LongRunningOperation operation)
WriteAttributeResults	completeWriteAttributes(LongRunningOperation operation)
ScheduledExecutorService	getExecutor() Retrieve the executor that is currently set
String	getRequiredVersion()
protected void	onConnectionClosed()
protected void	performSubscriptionChange(Message message)
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 item, Variant value, OperationParameters operationParameters, WriteOperationCallback callback)
void	writeAttributes(String item, Map<String,Variant> attributes, OperationParameters operationParameters, WriteAttributeOperationCallback callback)

Methods inherited from class org.eclipse.scada.core.client.net.SessionConnectionBase

addPrivilegeListener, dispose, getPrivileges, handlePrivChange, modifyFilterChain, onConnectionEstablished, processSessionReply, removePrivilegeListener, requestSession

Methods inherited from class org.eclipse.scada.core.client.net.ConnectionBase

addConnectionStateListener, cancelConnection, connect, connect, connectFailed, disconnect, disconnect, exceptionCaught, finalize, getConnectionInformation, getConnectTimeout, getIntProperty, getMessageTimeout, getPingPeriod, getSessionProperties, getSocketReceiveBufferSize, getSocketSendBufferSize, getState, getStatistics, isConnected, messageReceived, messageSent, onConnectionBound, performConnect, performLookup, removeConnectionStateListener, resolvedRemoteAddress, sessionClosed, sessionCreated, sessionIdle, sessionOpened, setBound, setCallbackFactory, setupConnector, switchState

Methods inherited from class java.lang.Object

clone, equals, 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

Field Detail

VERSION

public static final String VERSION

See Also:

Constant Field Values

Constructor Detail

Connection

public Connection(ConnectionInformation connectionInformantion)

Method Detail

getRequiredVersion

public String getRequiredVersion()

Specified by:

getRequiredVersion in class SessionConnectionBase

startWrite

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

write

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

completeWrite

protected void completeWrite(LongRunningOperation operation)
                      throws OperationException

Throws:

OperationException

startWriteAttributes

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

writeAttributes

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

completeWriteAttributes

public WriteAttributeResults completeWriteAttributes(LongRunningOperation operation)
                                              throws OperationException

Throws:

OperationException

completeBrowse

protected Entry[] completeBrowse(LongRunningOperation operation)
                          throws OperationException

Throws:

OperationException

subscribeItem

public void subscribeItem(String itemId)
                   throws NoConnectionException

Throws:

NoConnectionException

unsubscribeItem

public void unsubscribeItem(String itemId)
                     throws NoConnectionException

Throws:

NoConnectionException

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

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

subscribeFolder

public void subscribeFolder(Location location)
                     throws NoConnectionException,
                            OperationException

Throws:

NoConnectionException

OperationException

unsubscribeFolder

public void unsubscribeFolder(Location location)
                       throws NoConnectionException,
                              OperationException

Throws:

NoConnectionException

OperationException

onConnectionClosed

protected void onConnectionClosed()

Overrides:

onConnectionClosed in class SessionConnectionBase

performSubscriptionChange

protected void performSubscriptionChange(Message message)

browse

public Entry[] browse(Location location,
             int timeout)
               throws NoConnectionException,
                      OperationException

Throws:

NoConnectionException

OperationException

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

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