org.eclipse.scada.core.client

Interface Connection

All Known Subinterfaces:

Connection, Connection, Connection, Connection

All Known Implementing Classes:

ClientBaseConnection, ConnectionBaseImpl, ConnectionImpl, ConnectionImpl, ConnectionImpl, ConnectionImpl, ConnectionImpl, DummyConnection, LazyConnectionWrapper

public interface Connection

Method Summary

Modifier and Type	Method and Description
void	addConnectionStateListener(ConnectionStateListener connectionStateListener)
void	addPrivilegeListener(PrivilegeListener listener) Add a listener to the privileges of the session
void	connect() Start the connection
void	connect(CallbackHandler callbackHandler) Start the connection with a callback handler
void	disconnect() Stop the connection
void	dispose() Dispose the connection
ConnectionInformation	getConnectionInformation()
Set<String>	getPrivileges() Return the list of currently granted privileges.
Map<String,String>	getSessionProperties() Return the session properties as provided by the server.
ConnectionState	getState() Get the current connection state
void	removeConnectionStateListener(ConnectionStateListener connectionStateListener)
void	removePrivilegeListener(PrivilegeListener listener)
void	setCallbackFactory(CallbackFactory callbackFactory)

Method Detail

setCallbackFactory

void setCallbackFactory(CallbackFactory callbackFactory)

Since:

1.1

connect

void connect()

Start the connection

connect

void connect(CallbackHandler callbackHandler)

Start the connection with a callback handler

Since:

1.1

disconnect

void disconnect()

Stop the connection

addConnectionStateListener

void addConnectionStateListener(ConnectionStateListener connectionStateListener)

removeConnectionStateListener

void removeConnectionStateListener(ConnectionStateListener connectionStateListener)

getState

ConnectionState getState()

Get the current connection state

Returns:

The current connection state

getConnectionInformation

ConnectionInformation getConnectionInformation()

getSessionProperties

Map<String,String> getSessionProperties()

Return the session properties as provided by the server. The session properties are only valid if the connection is in the state ConnectionState.BOUND

Returns:

the connection properties

addPrivilegeListener

void addPrivilegeListener(PrivilegeListener listener)

Add a listener to the privileges of the session

When adding a new listener it will receive an initial call with the current privileges.

Parameters:

listener -

removePrivilegeListener

void removePrivilegeListener(PrivilegeListener listener)

getPrivileges

Set<String> getPrivileges()

Return the list of currently granted privileges.

Returns:

the list of current privileges. Must never return null.

Since:

1.0

dispose

void dispose()

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 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 dispose() call.

Since:

1.0