org.eclipse.scada.hd.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.hd.client.ngp.ConnectionImpl

All Implemented Interfaces:

Connection, StatisticsProvider

public class ConnectionImpl
extends ConnectionBaseImpl
implements Connection

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
void	addListListener(ItemListListener listener) Add a new listener to the connection in order to receive item list updates.
protected void	closeQuery(Long queryId)
Query	createQuery(String itemId, QueryParameters parameters, QueryListener listener, boolean updateData) Create a new query on the server
void	dispose() Dispose the connection
protected void	handleMessage(Object message) Handle a message that came in by the current session.
protected void	onConnectionBound() Called when the connection got bound
protected void	onConnectionClosed() Called when the connection got closed
void	removeListListener(ItemListListener listener) Remove a listener from the connection
protected void	sendBrowseRequestState(boolean state)
protected void	sendCloseQuery(long queryId)
protected void	sendQueryUpdateParameters(long id, QueryParameters parameters)
protected void	updateQueryParameters(QueryImpl query, QueryParameters parameters)

Methods inherited from class org.eclipse.scada.core.client.ngp.ConnectionBaseImpl

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

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

addConnectionStateListener, addPrivilegeListener, connect, connect, disconnect, firePrivilegeChange, getPrivileges, getSession, getSslSession, getState, handleConnectComplete, isDisposed, messageReceived, 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, 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

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

Overrides:

dispose in class ClientBaseConnection

onConnectionBound

protected void onConnectionBound()

Description copied from class: ClientBaseConnection

Called when the connection got bound

This method is called while the connection lock is held.

The default implementation does nothing.

Overrides:

onConnectionBound in class ClientBaseConnection

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 ConnectionBaseImpl

createQuery

public Query createQuery(String itemId,
                         QueryParameters parameters,
                         QueryListener listener,
                         boolean updateData)

Description copied from interface: Connection

Create a new query on the server

Parameters:

itemId - the historical item to query

parameters - the initial query parameters

listener - the listener that will receive data

updateData - true if the query should provide continuous updates, false if the query should only be executed once an not data updates should be delivered after the query state changed to QueryState.COMPLETE.

Returns:

a new query instance, null is never returned

addListListener

public void addListListener(ItemListListener listener)

Description copied from interface: Connection

Add a new listener to the connection in order to receive item list updates.

A new listener will also receive any already known items.

Parameters:

listener - the listener to add

removeListListener

public void removeListListener(ItemListListener listener)

Description copied from interface: Connection

Remove a listener from the connection

Parameters:

listener - the listener to remove

closeQuery

protected void closeQuery(Long queryId)

updateQueryParameters

protected void updateQueryParameters(QueryImpl query,
                                     QueryParameters parameters)

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

sendCloseQuery

protected void sendCloseQuery(long queryId)

sendQueryUpdateParameters

protected void sendQueryUpdateParameters(long id,
                                         QueryParameters parameters)

sendBrowseRequestState

protected void sendBrowseRequestState(boolean state)