com.redhat.thermostat.storage.core

Class Connection

java.lang.Object

com.redhat.thermostat.storage.core.Connection

public abstract class Connection
extends Object

Storage delegates to this class for connecting to storage.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Connection.ConnectionListener
static class	Connection.ConnectionStatus

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	connected

Constructor Summary

Constructors

Constructor and Description
Connection()

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(Connection.ConnectionListener listener) Adds a connection listener to this connection.
abstract void	connect() Connects to storage.
abstract void	disconnect() Disconnects from storage.
protected void	fireChanged(Connection.ConnectionStatus status) Notifies all registered listeners of this ConnectionStatus event.
String	getUrl()
boolean	isConnected() May be used to determine the state of a connection if no connect or disconnect attempt is currently in progress.
void	removeListener(Connection.ConnectionListener listener) Removes a formerly registered listener.
void	setUrl(String url) Sets the connection URL to which to connect to.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

connected

protected boolean connected

Constructor Detail

Connection

public Connection()

Method Detail

setUrl

public void setUrl(String url)

Sets the connection URL to which to connect to.

Parameters:

url - The connection URL.

getUrl

public String getUrl()

Returns:

The connection URL.

toString

public String toString()

Overrides:

toString in class Object

connect

public abstract void connect()

Connects to storage. Implementors are responsible to fire at least the following connection events:

• ConnectionStatus.CONNECTED: Once the connection has been made successfully.
• ConnectionStatus.FAILED_TO_CONNECT: If the connection could not be established for some reason.

These events are mutually exclusive. One of the two needs to be fired in any case.

disconnect

public abstract void disconnect()

Disconnects from storage. Implementors are responsible to fire at least the following connection events:

• ConnectionStatus.DISCONNECTED: Once disconnect has finished.

isConnected

public boolean isConnected()

May be used to determine the state of a connection if no connect or disconnect attempt is currently in progress.

Returns:

Provided the connection is not in a transitive state (e.g. ongoing connect/disconnect), true if storage is connected. False otherwise.

addListener

public void addListener(Connection.ConnectionListener listener)

Adds a connection listener to this connection. This may be used for progress reporting.

Parameters:

listener - The listener which will be notified of connection events.

removeListener

public void removeListener(Connection.ConnectionListener listener)

Removes a formerly registered listener. No-op if the given listener is not currently registered.

Parameters:

listener - The listener which should get removed.

fireChanged

protected void fireChanged(Connection.ConnectionStatus status)

Notifies all registered listeners of this ConnectionStatus event.

Parameters:

status - The status which is passed on to listeners.