org.eclipse.scada.ca.ui.connection.creator.jaxws

Class DummyConnection

java.lang.Object

org.eclipse.scada.ca.ui.connection.creator.jaxws.DummyConnection

All Implemented Interfaces:

Connection

public class DummyConnection
extends Object
implements Connection

Constructor Summary

Constructors

Constructor and Description
DummyConnection(ConnectionInformation connectionInformation)

Method Summary

Methods

Modifier and Type	Method and Description
void	addConnectionStateListener(ConnectionStateListener connectionStateListener)
void	addFactoriesListener(FactoriesListener listener)
void	addPrivilegeListener(PrivilegeListener listener) Add a listener to the privileges of the session
NotifyFuture<Void>	applyDiff(List<DiffEntry> changeSet, OperationParameters operationParameters, CallbackHandler callbackHandler)
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
NotifyFuture<ConfigurationInformation>	getConfiguration(String factoryId, String configurationId)
ConnectionInformation	getConnectionInformation()
NotifyFuture<FactoryInformation[]>	getFactories()
NotifyFuture<FactoryInformation>	getFactoryWithData(String factoryId)
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	removeFactoriesListener(FactoriesListener listener)
void	removePrivilegeListener(PrivilegeListener listener)
void	setCallbackFactory(CallbackFactory callbackFactory)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DummyConnection

public DummyConnection(ConnectionInformation connectionInformation)

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

setCallbackFactory

public void setCallbackFactory(CallbackFactory callbackFactory)

Specified by:

setCallbackFactory 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

connect

public void connect()

Description copied from interface: Connection

Start the connection

Specified by:

connect in interface Connection

disconnect

public void disconnect()

Description copied from interface: Connection

Stop the connection

Specified by:

disconnect in interface Connection

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

getConnectionInformation

public ConnectionInformation getConnectionInformation()

Specified by:

getConnectionInformation in interface Connection

getSessionProperties

public Map<String,String> getSessionProperties()

Description copied from interface: Connection

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

Specified by:

getSessionProperties in interface Connection

Returns:

the connection properties

addFactoriesListener

public void addFactoriesListener(FactoriesListener listener)

removeFactoriesListener

public void removeFactoriesListener(FactoriesListener listener)

getFactories

public NotifyFuture<FactoryInformation[]> getFactories()

getFactoryWithData

public NotifyFuture<FactoryInformation> getFactoryWithData(String factoryId)

getConfiguration

public NotifyFuture<ConfigurationInformation> getConfiguration(String factoryId,
                                                      String configurationId)

applyDiff

public NotifyFuture<Void> applyDiff(List<DiffEntry> changeSet,
                           OperationParameters operationParameters,
                           CallbackHandler callbackHandler)

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.