org.eclipse.kura.cloudconnection

Interface CloudEndpoint

@ProviderType
public interface CloudEndpoint

CloudEndpoint provide APIs to ease the communication with a cloud platform allowing to publish a message, manage subscribers, subscribe to message delivery notification or get information about the specific cloud endpoint configuration. Each CloudEndpoint is referenced by zero or more CloudPublisher and CloudSubscriber instances. Applications should not use directly this API but, instead, use the CloudPublisher and the CloudSubscriber interfaces to give applications the capabilities to publish and receive messages. The implementor must register itself as a CloudEndpoint OSGi service provider.

Since:

2.0

Method Summary

Modifier and Type	Method and Description
default java.util.Map<java.lang.String,java.lang.String>	getInfo() Provides information related to the associated connection.
java.lang.String	publish(KuraMessage message) Publishes the received KuraMessage to the associated cloud platform and returns, if supported, a String representing a message ID.
void	registerCloudDeliveryListener(CloudDeliveryListener cloudDeliveryListener) The implementation will register the CloudDeliveryListener instance passed as argument.
void	registerSubscriber(java.util.Map<java.lang.String,java.lang.Object> subscriptionProperties, CloudSubscriberListener cloudSubscriberListener) Registers the provided CloudSubscriberListener using the specified subscriptionProperties that will allow to disambiguate the specific subscriptions.
void	unregisterCloudDeliveryListener(CloudDeliveryListener cloudDeliveryListener) Unregisters the provided CloudDeliveryListener instance from cloud connection related events notifications.
void	unregisterSubscriber(CloudSubscriberListener cloudSubscriberListener) Unregisters the provided cloudSubscriberListener.

Method Detail

publish

java.lang.String publish(KuraMessage message)
                  throws KuraException

Publishes the received KuraMessage to the associated cloud platform and returns, if supported, a String representing a message ID. null is returned if the cloud endpoint will not confirm the message delivery, either because this is not supported by the underlying protocol or because the cloud endpoint itself is not implemented or configured to request the confirmation.

Parameters:

message - the KuraMessage to be published

Returns:

a String representing the message ID or null if not supported

Throws:

KuraException - if the publishing operation fails.

registerSubscriber

void registerSubscriber(java.util.Map<java.lang.String,java.lang.Object> subscriptionProperties,
                        CloudSubscriberListener cloudSubscriberListener)

Registers the provided CloudSubscriberListener using the specified subscriptionProperties that will allow to disambiguate the specific subscriptions.

Parameters:

subscriptionProperties - a map representing the subscription context

cloudSubscriberListener - a CloudSubscriberListener object that will be notified when a message is received in a context that matches the one identified by the subscription properties.

unregisterSubscriber

void unregisterSubscriber(CloudSubscriberListener cloudSubscriberListener)

Unregisters the provided cloudSubscriberListener.

Parameters:

cloudSubscriberListener - the CloudSubscriberListener to be unregistered.

getInfo

default java.util.Map<java.lang.String,java.lang.String> getInfo()

Provides information related to the associated connection. The information provided depends on the specific implementation and type of connection to the remote resource. The default implementation returns an empty map.

Returns:

a map that represents all the information related to the specific connection.

registerCloudDeliveryListener

void registerCloudDeliveryListener(CloudDeliveryListener cloudDeliveryListener)

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

Parameters:

cloudDeliveryListener - a CloudDeliveryListener instance

unregisterCloudDeliveryListener

void unregisterCloudDeliveryListener(CloudDeliveryListener cloudDeliveryListener)

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

Parameters:

cloudConnectionListener -