org.eclipse.eavp.viz.service.connections

Interface IConnectionAdapter<T>

Type Parameters:

T - The type of the connection object.

All Superinterfaces:

IVizUpdateable

All Known Implementing Classes:

ConnectionAdapter

public interface IConnectionAdapter<T>
extends IVizUpdateable

This is an interface for adapters that wrap any sort of local or remote connection. If provides feedback based on the current state of the connection to registered IUpdateableListeners (see also: IConnectionClient).

Author:

Jordan Deyton

Field Summary

Fields inherited from interface org.eclipse.eavp.viz.datastructures.VizObject.IVizUpdateable

iComponentListener

Method Summary

Modifier and Type	Method and Description
boolean	connect() Connects to the associated connection if not already connected or connecting.
boolean	connect(boolean block) Connects to the associated connection if not already connected or connecting.
boolean	disconnect() Disconnects the associated connection if not already disconnected.
boolean	disconnect(boolean block) Disconnects the associated connection if not already disconnected.
T	getConnection() Gets the connection managed by this adapter.
java.lang.String	getConnectionProperty(java.lang.String key) Gets the connection property corresponding to the specified key.
java.lang.String	getHost() A convenience method to get the host for the connection.
java.lang.String	getKey() Gets the key currently associated with this connection.
int	getPort() A convenience method to get the port for the connection.
ConnectionState	getState() Gets the current state of the associated connection.
boolean	isRemote() A convenience method to determine whether the associated connection is to a remote device.
boolean	setConnectionProperties(java.util.List<VizEntry> properties) Sets the connection's required properties based on the provided list of Entrys (usually a row from a ConnectionTable).

Methods inherited from interface org.eclipse.eavp.viz.datastructures.VizObject.IVizUpdateable

register, unregister, update

Method Detail

connect

boolean connect()

Connects to the associated connection if not already connected or connecting.

Note:This method will not block the caller thread, so it is the same as calling connect(false).

Returns:

True if the connection is established upon returning, false otherwise.

connect

boolean connect(boolean block)

Connects to the associated connection if not already connected or connecting.

Parameters:

block - If true, then the calling thread will be blocked until the connection succeeds or fails. If false, then the connection process will not block the calling thread.

Returns:

True if the connection is established upon returning, false otherwise.

disconnect

boolean disconnect()

Disconnects the associated connection if not already disconnected.

Note:This method will not block the caller thread, so it is the same as calling disconnect(false).

Returns:

True if the connection is closed upon returning, false otherwise.

disconnect

boolean disconnect(boolean block)

Disconnects the associated connection if not already disconnected.

Parameters:

block - If true, then the calling thread will be blocked until the disconnection succeeds or fails. If false, then the disconnection process will not block the calling thread.

Returns:

True if the connection is closed upon returning, false otherwise.

getConnection

T getConnection()

Gets the connection managed by this adapter.

Returns:

The associated connection.

getConnectionProperty

java.lang.String getConnectionProperty(java.lang.String key)

Gets the connection property corresponding to the specified key.

Parameters:

key - The key or ID of the required connection property.

Returns:

The value of the connection property, or null if the key did not exist.

getKey

java.lang.String getKey()

Gets the key currently associated with this connection. The value is usually maintained by a connection manager.

Returns:

The connection key.

getState

ConnectionState getState()

Gets the current state of the associated connection.

Returns:

The current state of the associated connection.

setConnectionProperties

boolean setConnectionProperties(java.util.List<VizEntry> properties)

Sets the connection's required properties based on the provided list of Entrys (usually a row from a ConnectionTable).

The associated connection should not be reset if the connection properties have changed.

Parameters:

properties - The list of new connection properties.

Returns:

True if the new connection properties were valid and a change occurred, false otherwise.

getHost

java.lang.String getHost()

A convenience method to get the host for the connection. This will be either "localhost" or some other hostname/IP address.

Returns:

The hostname.

getPort

int getPort()

A convenience method to get the port for the connection. This should be a valid port value.

Returns:

The port for the connection, or -1 if the port is not required.

isRemote

boolean isRemote()

A convenience method to determine whether the associated connection is to a remote device.

Returns:

True if the connection is remote, false otherwise (regardless of connection state).