org.eclipse.scada.core.client.common

Class ClientBaseConnection

java.lang.Object

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

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

All Implemented Interfaces:

Connection, StatisticsProvider

Direct Known Subclasses:

ConnectionBaseImpl, ConnectionImpl

public abstract class ClientBaseConnection
extends BaseConnection
implements Connection

Field Summary

Fields

Modifier and Type	Field and Description
protected CallbackFactory	callbackFactory
protected CallbackHandler	connectCallbackHandler

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

connectionInformation, executor, statistics

Constructor Summary

Constructors

Constructor and Description
ClientBaseConnection(IoHandlerFactory handlerFactory, IoLoggerFilterChainBuilder chainBuilder, ConnectionInformation connectionInformation)

Method Summary

Methods

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
protected void	firePrivilegeChange(Set<String> granted)
Set<String>	getPrivileges() Return the list of currently granted privileges.
protected IoSession	getSession()
SSLSession	getSslSession()
ConnectionState	getState() Get the current connection state
protected void	handleConnectComplete(ConnectFuture future)
protected abstract void	handleMessage(Object message) Handle a message that came in by the current session.
boolean	isDisposed()
void	messageReceived(IoSession session, Object message)
protected void	onConnectionBound() Called when the connection got bound
protected void	onConnectionClosed() Called when the connection got closed
protected void	onConnectionConnected() Called when the connection got connected
protected void	performClosed(IoSession session, Throwable error)
protected void	performDisconnected(Throwable error)
void	performOpened(IoSession session)
void	removeConnectionStateListener(ConnectionStateListener connectionStateListener)
void	removePrivilegeListener(PrivilegeListener listener)
protected void	sendMessage(Object message)
protected void	sendMessageChecked(Object message) Send a message if a connection exists
void	setCallbackFactory(CallbackFactory callbackFactory)
protected void	setState(ConnectionState connectionState, Throwable error)
protected void	switchState(ConnectionState state, Throwable error)

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

getConnectionInformation, getSessionProperties

Field Detail

connectCallbackHandler

protected volatile CallbackHandler connectCallbackHandler

callbackFactory

protected CallbackFactory callbackFactory

Constructor Detail

ClientBaseConnection

public ClientBaseConnection(IoHandlerFactory handlerFactory,
                    IoLoggerFilterChainBuilder chainBuilder,
                    ConnectionInformation connectionInformation)
                     throws Exception

Throws:

Exception

Method Detail

setCallbackFactory

public void setCallbackFactory(CallbackFactory callbackFactory)

Specified by:

setCallbackFactory in interface Connection

connect

public void connect()

Description copied from interface: Connection

Start the connection

Specified by:

connect in interface Connection

connect

public void connect(CallbackHandler callbackHandler)

Description copied from interface: Connection

Start the connection with a callback handler

Specified by:

connect in interface Connection

disconnect

public void disconnect()

Description copied from interface: Connection

Stop the connection

Specified by:

disconnect in interface Connection

switchState

protected void switchState(ConnectionState state,
               Throwable error)

onConnectionBound

protected void onConnectionBound()

Called when the connection got bound

This method is called while the connection lock is held.

The default implementation does nothing.

onConnectionConnected

protected void onConnectionConnected()

Called when the connection got connected

This method is called while the connection lock is held.

The default implementation switches directly to ConnectionState.BOUND

onConnectionClosed

protected void onConnectionClosed()

Called when the connection got closed

This method is called while the connection lock is held.

The default implementation does nothing.

performDisconnected

protected void performDisconnected(Throwable error)

handleConnectComplete

protected void handleConnectComplete(ConnectFuture future)

isDisposed

public boolean isDisposed()

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 BaseConnection

setState

protected void setState(ConnectionState connectionState,
            Throwable error)

addConnectionStateListener

public void addConnectionStateListener(ConnectionStateListener connectionStateListener)

Specified by:

addConnectionStateListener in interface Connection

removeConnectionStateListener

public void removeConnectionStateListener(ConnectionStateListener connectionStateListener)

Specified by:

removeConnectionStateListener in interface Connection

getState

public ConnectionState getState()

Description copied from interface: Connection

Get the current connection state

Specified by:

getState in interface Connection

Returns:

The current connection state

performClosed

protected void performClosed(IoSession session,
                 Throwable error)

performOpened

public void performOpened(IoSession session)

messageReceived

public void messageReceived(IoSession session,
                   Object message)

handleMessage

protected abstract void handleMessage(Object message)

Handle a message that came in by the current session.

Note that the method is called while holding the lock the connection itself.

Parameters:

message - the received message

sendMessageChecked

protected void sendMessageChecked(Object message)
                           throws NoConnectionException

Send a message if a connection exists

Works like sendMessage(Object), but the connection is not established it will throw an exception instead of silently ignoring the fact.

Parameters:

message - the message to send

Throws:

NoConnectionException - thrown in case no connection currently exists

sendMessage

protected void sendMessage(Object message)

getSslSession

public SSLSession getSslSession()

addPrivilegeListener

public void addPrivilegeListener(PrivilegeListener listener)

Description copied from interface: Connection

Add a listener to the privileges of the session

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

Specified by:

addPrivilegeListener in interface Connection

removePrivilegeListener

public void removePrivilegeListener(PrivilegeListener listener)

Specified by:

removePrivilegeListener in interface Connection

getPrivileges

public Set<String> getPrivileges()

Description copied from interface: Connection

Return the list of currently granted privileges.

Specified by:

getPrivileges in interface Connection

Returns:

the list of current privileges. Must never return null.

firePrivilegeChange

protected void firePrivilegeChange(Set<String> granted)

getSession

protected IoSession getSession()