org.eclipse.kura.cloud

Class Cloudlet

java.lang.Object

org.eclipse.kura.cloud.Cloudlet

All Implemented Interfaces:

CloudClientListener

@ConsumerType
public abstract class Cloudlet
extends java.lang.Object
implements CloudClientListener

Cloudlet is an abstract class that can be extended by services that wants to implement remote resource management. The Cloudlet abstracts the detailed of the communication with the remote clients providing easy to use template methods to be implemented by subclasses to handle CRUD operations on local resources.

• doGet(org.eclipse.kura.cloud.CloudletTopic, org.eclipse.kura.message.KuraRequestPayload, org.eclipse.kura.message.KuraResponsePayload) is used to implement a READ request for a resource identified by the supplied CloudletTopic.getResources()
• doPut(org.eclipse.kura.cloud.CloudletTopic, org.eclipse.kura.message.KuraRequestPayload, org.eclipse.kura.message.KuraResponsePayload) is used to implement a CREATE or UPDATE request for a resource identified by the supplied CloudletTopic.getResources()
• doDel(org.eclipse.kura.cloud.CloudletTopic, org.eclipse.kura.message.KuraRequestPayload, org.eclipse.kura.message.KuraResponsePayload) is used to implement a DELETE request for a resource identified by the supplied CloudletTopic.getResources()
• doPost(org.eclipse.kura.cloud.CloudletTopic, org.eclipse.kura.message.KuraRequestPayload, org.eclipse.kura.message.KuraResponsePayload) is used to implement other operations on a resource identified by the supplied CloudletTopic.getResources()
• doExec(org.eclipse.kura.cloud.CloudletTopic, org.eclipse.kura.message.KuraRequestPayload, org.eclipse.kura.message.KuraResponsePayload) is used to perform applicatioon operation not necessary tied to a given resource.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DFLT_PRIORITY
protected static int	DFLT_PUB_QOS
protected static boolean	DFLT_RETAIN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Cloudlet(java.lang.String appId)

Method Summary

Modifier and Type	Method and Description
protected void	activate(org.osgi.service.component.ComponentContext componentContext)
protected void	deactivate(org.osgi.service.component.ComponentContext componentContext)
protected void	doDel(CloudletTopic reqTopic, KuraRequestPayload reqPayload, KuraResponsePayload respPayload)
protected void	doExec(CloudletTopic reqTopic, KuraRequestPayload reqPayload, KuraResponsePayload respPayload)
protected void	doGet(CloudletTopic reqTopic, KuraRequestPayload reqPayload, KuraResponsePayload respPayload)
protected void	doPost(CloudletTopic reqTopic, KuraRequestPayload reqPayload, KuraResponsePayload respPayload)
protected void	doPut(CloudletTopic reqTopic, KuraRequestPayload reqPayload, KuraResponsePayload respPayload)
java.lang.String	getAppId()
protected CloudClient	getCloudApplicationClient()
protected CloudService	getCloudService()
protected org.osgi.service.component.ComponentContext	getComponentContext()
void	onConnectionEstablished() Called when the CloudClient has successfully connected with the broker.
void	onConnectionLost() Called when the client has lost its connection with the broker.
void	onControlMessageArrived(java.lang.String deviceId, java.lang.String appTopic, KuraPayload msg, int qos, boolean retain) Called by the CloudClient when it receives a published control message from the broker.
void	onMessageArrived(java.lang.String deviceId, java.lang.String appTopic, KuraPayload msg, int qos, boolean retain) Called by the client when it receives a published data message from the broker.
void	onMessageConfirmed(int messageId, java.lang.String topic) Called by the CloudClient when a published message has been fully acknowledged by the broker, as appropriate for the quality of service.
void	onMessagePublished(int messageId, java.lang.String topic) Called by the CloudClient when a message has been transfered from the publishing queue to the underlying DataTransportService for publishing on the wire.
void	setCloudService(CloudService cloudService)
void	unsetCloudService(CloudService cloudService)

Methods inherited from class java.lang.Object

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

Field Detail

DFLT_PUB_QOS

protected static final int DFLT_PUB_QOS

See Also:

Constant Field Values

DFLT_RETAIN

protected static final boolean DFLT_RETAIN

See Also:

Constant Field Values

DFLT_PRIORITY

protected static final int DFLT_PRIORITY

See Also:

Constant Field Values

Constructor Detail

Cloudlet

protected Cloudlet(java.lang.String appId)

Method Detail

setCloudService

public void setCloudService(CloudService cloudService)

unsetCloudService

public void unsetCloudService(CloudService cloudService)

activate

protected void activate(org.osgi.service.component.ComponentContext componentContext)

deactivate

protected void deactivate(org.osgi.service.component.ComponentContext componentContext)

getAppId

public java.lang.String getAppId()

getCloudService

protected CloudService getCloudService()

getCloudApplicationClient

protected CloudClient getCloudApplicationClient()

getComponentContext

protected org.osgi.service.component.ComponentContext getComponentContext()

doGet

protected void doGet(CloudletTopic reqTopic,
                     KuraRequestPayload reqPayload,
                     KuraResponsePayload respPayload)
              throws KuraException

Throws:

KuraException

doPut

protected void doPut(CloudletTopic reqTopic,
                     KuraRequestPayload reqPayload,
                     KuraResponsePayload respPayload)
              throws KuraException

Throws:

KuraException

doPost

protected void doPost(CloudletTopic reqTopic,
                      KuraRequestPayload reqPayload,
                      KuraResponsePayload respPayload)
               throws KuraException

Throws:

KuraException

doDel

protected void doDel(CloudletTopic reqTopic,
                     KuraRequestPayload reqPayload,
                     KuraResponsePayload respPayload)
              throws KuraException

Throws:

KuraException

doExec

protected void doExec(CloudletTopic reqTopic,
                      KuraRequestPayload reqPayload,
                      KuraResponsePayload respPayload)
               throws KuraException

Throws:

KuraException

onControlMessageArrived

public void onControlMessageArrived(java.lang.String deviceId,
                                    java.lang.String appTopic,
                                    KuraPayload msg,
                                    int qos,
                                    boolean retain)

Description copied from interface: CloudClientListener

Called by the CloudClient when it receives a published control message from the broker. If the message received has a binary payload that it has NOT been encoded using the the KuraPayload class, the received bytes will be set as the body field of a new KuraPaylaod instance which is passed to the callback Listener interface.

Specified by:

onControlMessageArrived in interface CloudClientListener

Parameters:

deviceId - The deviceId this message was addressed to.

appTopic - The appTopic the message arrived on.

msg - The KuraPayload that arrived.

qos - The Quality of Service that the message was received on.

retain - Whether the message was retained by the broker.

onMessageArrived

public void onMessageArrived(java.lang.String deviceId,
                             java.lang.String appTopic,
                             KuraPayload msg,
                             int qos,
                             boolean retain)

Description copied from interface: CloudClientListener

Called by the client when it receives a published data message from the broker. If the message received has a binary payload that it has NOT been encoded using the the KuraPayload class, the received bytes will be set as the body field of a new KuraPaylaod instance which is passed to the callback Listener interface.

Specified by:

onMessageArrived in interface CloudClientListener

Parameters:

deviceId - The asset ID of the semanticTopic prefix the message arrived on.

appTopic - The appTopic the message arrived on.

msg - The KuraPayload that arrived.

qos - The Quality of Service that the message was received on.

retain - Whether the message was retained by the broker.

onConnectionLost

public void onConnectionLost()

Description copied from interface: CloudClientListener

Called when the client has lost its connection with the broker. Depending on the DataService configuration, the client will attempt to reconnect and call the CloudClientListener.onConnectionEstablished() method upon a successful reconnect. This is only a notification, the callback handler should not attempt to handle the reconnect.
If the bundle using the client relies on subscriptions beyond the default ones, it is responsibility of the application to implement the CloudClientListener.onConnectionEstablished() callback method to restore the subscriptions it needs after a connection loss.

Specified by:

onConnectionLost in interface CloudClientListener

onConnectionEstablished

public void onConnectionEstablished()

Description copied from interface: CloudClientListener

Called when the CloudClient has successfully connected with the broker.
If the bundle using the client relies on subscriptions beyond the default ones, it is responsibility of the application to implement the CloudClientListener.onConnectionEstablished() callback method to restore the subscriptions it needs after a connection loss.

Specified by:

onConnectionEstablished in interface CloudClientListener

onMessageConfirmed

public void onMessageConfirmed(int messageId,
                               java.lang.String topic)

Description copied from interface: CloudClientListener

Called by the CloudClient when a published message has been fully acknowledged by the broker, as appropriate for the quality of service. The published method is not called for QoS 0 publications.

Specified by:

onMessageConfirmed in interface CloudClientListener

Parameters:

messageId - The message id of the published message

onMessagePublished

public void onMessagePublished(int messageId,
                               java.lang.String topic)

Description copied from interface: CloudClientListener

Called by the CloudClient when a message has been transfered from the publishing queue to the underlying DataTransportService for publishing on the wire.

Specified by:

onMessagePublished in interface CloudClientListener