org.eclipse.scada.da.client.ngp

Class ConnectionImpl

java.lang.Object

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

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

org.eclipse.scada.core.client.ngp.ConnectionBaseImpl

org.eclipse.scada.da.client.ngp.ConnectionImpl

All Implemented Interfaces:

Connection, StatisticsProvider

public class ConnectionImpl
extends ConnectionBaseImpl
implements Connection

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConnectionImpl.BrowseFuture
static class	ConnectionImpl.WriteAttributesFuture
static class	ConnectionImpl.WriteFuture

Field Summary

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

connectCallbackHandler

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

connectionInformation, executor, statistics

Constructor Summary

Constructors

Constructor and Description
ConnectionImpl(ConnectionInformation connectionInformation)
ConnectionImpl(ConnectionInformation connectionInformation, org.apache.mina.core.service.IoProcessor<org.apache.mina.transport.socket.nio.NioSession> processor) Create a new connection

Method Summary

Modifier and Type	Method and Description
NotifyFuture<Entry[]>	browse(Location location)
void	browse(Location location, BrowseOperationCallback callback) Browse a server folder for items.
protected Collection<Entry>	convert(List<BrowserEntry> addedOrModified)
static WriteAttributeResults	convertResults(List<AttributeWriteResultEntry> attributeResults)
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 static Map<String,Variant>	makeAttributes(Map<String,Variant> addedOrUpdated, Set<String> removed)
protected static OperationParameters	makeParameters(OperationParameters operationParameters)
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.ngp.ConnectionBaseImpl

makeProperties, nextRequest, onConnectionClosed, onConnectionConnected, processCallbackFuture, registerCallbackHandler, sendRequestMessage, setCallbackFactory

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

ConnectionImpl

public ConnectionImpl(ConnectionInformation connectionInformation,
                      org.apache.mina.core.service.IoProcessor<org.apache.mina.transport.socket.nio.NioSession> processor)
               throws Exception

Create a new connection

Parameters:

connectionInformation - the information where to connect to

processor - the socket processor, may be null to use the default

Throws:

Exception - if anything goes wrong

Method Detail

convertResults

public static WriteAttributeResults convertResults(List<AttributeWriteResultEntry> attributeResults)

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

browse

public NotifyFuture<Entry[]> browse(Location location)

write

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

startWrite

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

writeAttributes

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

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

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.

Overrides:

handleMessage in class ConnectionBaseImpl

Parameters:

message - the received message

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

makeAttributes

protected static Map<String,Variant> makeAttributes(Map<String,Variant> addedOrUpdated,
                                                    Set<String> removed)

convert

protected Collection<Entry> convert(List<BrowserEntry> addedOrModified)

makeParameters

protected static OperationParameters makeParameters(OperationParameters operationParameters)