org.eclipse.eavp.viz.service.connections

Class ConnectionAdapter<T>

java.lang.Object

org.eclipse.eavp.viz.datastructures.VizObject.VizObject

org.eclipse.eavp.viz.service.connections.ConnectionAdapter<T>

Type Parameters:

T - The type of the connection object.

All Implemented Interfaces:

IVizObject, IVizUpdateable, IConnectionAdapter<T>

public abstract class ConnectionAdapter<T>
extends VizObject
implements IConnectionAdapter<T>

This class provides an adapter that wraps a connection. It provides feedback based on the current state of the connection.

There are certain properties of a connection that are managed by this class:

1. key - The key or name associated with the connection.
2. connection - The connection object.
3. properties - A map of properties required to open or maintain a connection. This is handled by sub-classes.
4. state - The current state of the connection.
5. listeners - Listeners registered with the adapter are notified when the connection state changes.

This class sub-classes ICEObject, which manages the key and the listeners. However, the key is only ever set via setConnectionProperties(List).

Author:

Jordan Deyton

Field Summary

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

iComponentListener

Constructor Summary

Constructors

Constructor and Description
ConnectionAdapter() The default constructor.

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.
void	register(IVizUpdateableListener listener) (non-Javadoc)
abstract 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).
void	setDescription(java.lang.String description) Does nothing.
void	setId(int id) Does nothing.
void	setName(java.lang.String name) Does nothing.

Methods inherited from class org.eclipse.eavp.viz.datastructures.VizObject.VizObject

clone, copy, equals, getDescription, getId, getName, hashCode, unregister, update

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

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

unregister, update

Constructor Detail

ConnectionAdapter

public ConnectionAdapter()

The default constructor.

Method Detail

connect

public boolean connect()

Description copied from interface: IConnectionAdapter

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).

Specified by:

connect in interface IConnectionAdapter<T>

Returns:

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

connect

public boolean connect(boolean block)

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

Note: This method is not intended to be overridden by sub-classes.

Specified by:

connect in interface IConnectionAdapter<T>

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

public boolean disconnect()

Description copied from interface: IConnectionAdapter

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).

Specified by:

disconnect in interface IConnectionAdapter<T>

Returns:

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

disconnect

public boolean disconnect(boolean block)

Disconnects the associated connection if not already disconnected.

Note: This method is not intended to be overridden by sub-classes.

Specified by:

disconnect in interface IConnectionAdapter<T>

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

public T getConnection()

Description copied from interface: IConnectionAdapter

Gets the connection managed by this adapter.

Specified by:

getConnection in interface IConnectionAdapter<T>

Returns:

The associated connection.

getConnectionProperty

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

Description copied from interface: IConnectionAdapter

Gets the connection property corresponding to the specified key.

Specified by:

getConnectionProperty in interface IConnectionAdapter<T>

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

public java.lang.String getKey()

Description copied from interface: IConnectionAdapter

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

Specified by:

getKey in interface IConnectionAdapter<T>

Returns:

The connection key.

getState

public ConnectionState getState()

Description copied from interface: IConnectionAdapter

Gets the current state of the associated connection.

Specified by:

getState in interface IConnectionAdapter<T>

Returns:

The current state of the associated connection.

setConnectionProperties

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

Description copied from interface: IConnectionAdapter

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.

Specified by:

setConnectionProperties in interface IConnectionAdapter<T>

Parameters:

properties - The list of new connection properties.

Returns:

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

getHost

public java.lang.String getHost()

Description copied from interface: IConnectionAdapter

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

Specified by:

getHost in interface IConnectionAdapter<T>

Returns:

The hostname.

getPort

public int getPort()

Description copied from interface: IConnectionAdapter

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

Specified by:

getPort in interface IConnectionAdapter<T>

Returns:

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

isRemote

public boolean isRemote()

Description copied from interface: IConnectionAdapter

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

Specified by:

isRemote in interface IConnectionAdapter<T>

Returns:

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

register

public void register(IVizUpdateableListener listener)

Description copied from class: VizObject

(non-Javadoc)

Specified by:

register in interface IVizObject

Specified by:

register in interface IVizUpdateable

Overrides:

register in class VizObject

Parameters:

listener -

The new listener that should be notified when the the Component's state changes.

See Also:

IUpdateable#register(IUpdateableListener listener)

setId

public void setId(int id)

Does nothing. The ID should be set as a connection property via setConnectionProperties(List).

Specified by:

setId in interface IVizObject

Overrides:

setId in class VizObject

See Also:

Identifiable#setId(int id)

setName

public void setName(java.lang.String name)

Does nothing. The name (or key) should be set as a connection property via setConnectionProperties(List).

Specified by:

setName in interface IVizObject

Overrides:

setName in class VizObject

See Also:

Identifiable#setName(String name)

setDescription

public void setDescription(java.lang.String description)

Does nothing. The description should be set as a connection property via setConnectionProperties(List).

Specified by:

setDescription in interface IVizObject

Overrides:

setDescription in class VizObject

See Also:

Identifiable#setDescription(String description)