org.eclipse.kura.cloudconnection

Interface CloudConnectionManager

@ProviderType
public interface CloudConnectionManager

A CloudEndpoint can implement CloudConnectionManager to support the management of long-lived/always on connections. This interface provides methods to connect, disconnect and get the connection state of the associated CloudEndpoint. It also provides methods to register CloudConnectionListeners that will be notified of connection-related events. The implementor must register itself as a CloudConnectionManager OSGi service provider.

Since:

2.0

Method Summary

Modifier and Type	Method and Description
void	connect() Establishes a connection to the configured cloud platform.
void	disconnect() Performs a clean disconnection from the cloud platform.
boolean	isConnected() Tests if the connection is alive.
void	registerCloudConnectionListener(CloudConnectionListener cloudConnectionListener) The implementation will register the CloudConnectionListener instance passed as argument.
void	unregisterCloudConnectionListener(CloudConnectionListener cloudConnectionListener) Unregisters the provided CloudConnectionListener instance from cloud connection related events notifications.

Method Detail

connect

void connect()
      throws KuraConnectException

Establishes a connection to the configured cloud platform.

Throws:

KuraException - if the operation fails

KuraConnectException

disconnect

void disconnect()
         throws KuraDisconnectException

Performs a clean disconnection from the cloud platform.

Throws:

KuraException - if the operation fails

KuraDisconnectException

isConnected

boolean isConnected()

Tests if the connection is alive.

Returns:

true if the framework is connected to the remote server. false otherwise.

registerCloudConnectionListener

void registerCloudConnectionListener(CloudConnectionListener cloudConnectionListener)

The implementation will register the CloudConnectionListener instance passed as argument. Once a cloud connection related event happens, all the registered CloudConnectionListeners will be notified.

Parameters:

cloudConnectionListener - a CloudConnectionListener instance

unregisterCloudConnectionListener

void unregisterCloudConnectionListener(CloudConnectionListener cloudConnectionListener)

Unregisters the provided CloudConnectionListener instance from cloud connection related events notifications.

Parameters:

cloudConnectionListener -