org.eclipse.scada.ae.client

Interface Connection

All Superinterfaces:

Connection

public interface Connection
extends Connection

Interface for client connection

Since:

0.15.0

Author:

Jens Reimann

Method Summary

Methods

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	removeBrowserListener(BrowserListener listener)
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 interface org.eclipse.scada.core.client.Connection

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

Method Detail

setMonitorListener

void setMonitorListener(String monitorQueryId,
                      MonitorListener listener)

Set the listener that should receive monitor updates

setEventListener

void setEventListener(String eventQueryId,
                    EventListener listener)

Set the listener that should receive event updates

createQuery

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

addBrowserListener

void addBrowserListener(BrowserListener listener)

Add browser listener

Parameters:

listener - the listener to add

removeBrowserListener

void removeBrowserListener(BrowserListener listener)

acknowledge

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

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.