org.eclipse.scada.ae.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.ae.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.AcknowledgeFuture
static class	ConnectionImpl.DisconnectedQuery A dummy query which is only disconnected

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<Void>	acknowledge(String monitorId, Date aknTimestamp, OperationParameters operationParameters, CallbackHandler callbackHandler) Acknowledge the monitor if the akn state was reached at or before the provided timestamp
void	addBrowserListener(BrowserListener listener) Add browser listener
Query	createQuery(String queryType, String queryData, QueryListener listener)
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	removeBrowserListener(BrowserListener listener)
void	sendCloseQuery(long queryId)
void	sendCreateQuery(long queryId, String queryType, String queryData)
void	sendLoadMore(long queryId, int count)
void	sendStartBrowse()
void	sendStopBrowse()
void	sendSubscribeEventPool(String eventPoolId)
void	sendSubscribeMonitorPool(String monitorPoolId)
void	sendUnsubscribeEventPool(String eventPoolId)
void	sendUnsubscribeMonitorPool(String monitorPoolId)
void	setEventListener(String eventQueryId, EventListener listener) Set the listener that should receive event updates
void	setMonitorListener(String monitorQueryId, MonitorListener listener) Set the listener that should receive monitor updates

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

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

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

addBrowserListener

public void addBrowserListener(BrowserListener listener)

Description copied from interface: Connection

Add browser listener

Parameters:

listener - the listener to add

removeBrowserListener

public void removeBrowserListener(BrowserListener listener)

setEventListener

public void setEventListener(String eventQueryId,
                             EventListener listener)

Description copied from interface: Connection

Set the listener that should receive event updates

setMonitorListener

public void setMonitorListener(String monitorQueryId,
                               MonitorListener listener)

Description copied from interface: Connection

Set the listener that should receive monitor updates

createQuery

public Query createQuery(String queryType,
                         String queryData,
                         QueryListener listener)

acknowledge

public NotifyFuture<Void> acknowledge(String monitorId,
                                      Date aknTimestamp,
                                      OperationParameters operationParameters,
                                      CallbackHandler callbackHandler)

Description copied from interface: Connection

Acknowledge the monitor if the akn state was reached at or before the provided timestamp

Parameters:

monitorId - the id of the condition

aknTimestamp - the timestamp up to which the state may be acknowledged

operationParameters - optionally provide some user information which performs the aknowledgement. If the information is not provided the current logged in user will be used. If the information is present but the current logged in user is not allowed to change the user performing acknowledgement the server may fall back to use the actual information of the logged in user instead.

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

sendStartBrowse

public void sendStartBrowse()

sendStopBrowse

public void sendStopBrowse()

sendSubscribeMonitorPool

public void sendSubscribeMonitorPool(String monitorPoolId)

sendUnsubscribeMonitorPool

public void sendUnsubscribeMonitorPool(String monitorPoolId)

sendSubscribeEventPool

public void sendSubscribeEventPool(String eventPoolId)

sendUnsubscribeEventPool

public void sendUnsubscribeEventPool(String eventPoolId)

sendCloseQuery

public void sendCloseQuery(long queryId)

sendLoadMore

public void sendLoadMore(long queryId,
                         int count)

sendCreateQuery

public void sendCreateQuery(long queryId,
                            String queryType,
                            String queryData)