Package ch.hevs.cloudio.endpoint

Interface CloudioEndpointService

All Known Implementing Classes:

CloudioEndpoint

public interface CloudioEndpointService

A CloudioEndpoint is the root object of any connection of a device or a gateway to cloud.io. The CloudioEndpointService is exposed by the cloud.io OSGi container in order to enable other OSGi bundles to register and remove new nodes within the endpoint.

Method Summary

Modifier and Type	Method	Description
void	addEndpointListener(CloudioEndpointListener listener)	Adds the given listener to the endpoint service.
void	addNode(java.lang.String nodeName, CloudioNode node)	Adds the given node to the endpoint.
<T extends CloudioNode> T	addNode(java.lang.String nodeName, java.lang.Class<T> nodeClass)	Adds a new node instance of the given node class to the endpoint.
<T extends CloudioNode> T	getNode(java.lang.String nodeName)	Returns the node with the given name that was registered within cloud.iO or null if no such node is present.
boolean	isOnline()	Returns true if the endpoint is connected to the central message broker, otherwise false.
void	removeEndpointListener(CloudioEndpointListener listener)	Removes the given listener from the endpoint service.
void	removeNode(CloudioNode node)	Removes the given node from the endpoint if the node actually is part of the endpoint.
void	removeNode(java.lang.String nodeName)	Removes the node with the given name from the endpoint if the node actually is part of the endpoint.

Method Detail

isOnline

boolean isOnline()

Returns true if the endpoint is connected to the central message broker, otherwise false.

Returns:

True if the endpoint is online, false otherwise.

addEndpointListener

void addEndpointListener(CloudioEndpointListener listener)

Adds the given listener to the endpoint service.

Parameters:

listener - Listener to add.

removeEndpointListener

void removeEndpointListener(CloudioEndpointListener listener)

Removes the given listener from the endpoint service.

Parameters:

listener - Listener to add.

addNode

void addNode(java.lang.String nodeName,
             CloudioNode node)
      throws DuplicateNamedItemException

Adds the given node to the endpoint. The name of the node needs to be unique, otherwise the method will fail with an DuplicateNamedItemException.

Parameters:

nodeName - Name to give to the node.

node - Reference to the node instance to add.

Throws:

DuplicateNamedItemException - If a node with the given name already exists.

addNode

<T extends CloudioNode> T addNode(java.lang.String nodeName,
                                  java.lang.Class<T> nodeClass)
                           throws InvalidCloudioNodeException,
                                  DuplicateNamedItemException

Adds a new node instance of the given node class to the endpoint. The name of the node needs to be unique, otherwise the method will fail with an DuplicateNamedItemException. Note that the node class must dispose a default constructor in order to let the method create an instance of the class.

Type Parameters:

T - Type of the node class.

Parameters:

nodeName - Name to give to the node.

nodeClass - The class of the node to instantiate.

Returns:

Reference to the new instance of the given node class.

Throws:

DuplicateNamedItemException - If a node with the given name already exists.

InvalidCloudioNodeException

removeNode

void removeNode(CloudioNode node)

Removes the given node from the endpoint if the node actually is part of the endpoint. If the node was not contained in the endpoint, the method will do nothing at all.

Parameters:

node - Node to remove.

removeNode

void removeNode(java.lang.String nodeName)

Removes the node with the given name from the endpoint if the node actually is part of the endpoint. If the endpoint does not contain a node with the given name, the method will do nothing at all.

Parameters:

nodeName - Name of the node to remove.

getNode

<T extends CloudioNode> T getNode(java.lang.String nodeName)
                           throws java.lang.ClassCastException

Returns the node with the given name that was registered within cloud.iO or null if no such node is present.

Type Parameters:

T - Subclass of node.

Parameters:

nodeName - Name of the node to return a reference to.

Returns:

A reference to registered node or null if no node with the given name exists.

Throws:

java.lang.ClassCastException - If the node could not be casted to the target type