org.universAAL.middleware.brokers.control

Class ControlBroker

java.lang.Object

org.universAAL.middleware.brokers.control.ControlBroker

All Implemented Interfaces:

Broker, SharedObjectListener, MessageListener

public class ControlBroker
extends Object
implements SharedObjectListener, Broker, MessageListener

The Control Broker

Version:

$LastChangedRevision$ ( $LastChangedDate$ )

Author:

Michele Girolami, Stefano Lenzi

Constructor Summary

Constructors

Constructor and Description
ControlBroker(ModuleContext context)

Method Summary

Modifier and Type	Method and Description
void	addNewPeer(SpaceDescriptor spaceDescriptor, PeerCard peer)
void	buildSpace(SpaceCard spaceCard)
void	configureChannels(List<ChannelDescriptor> communicationChannels, String peerName) Only configures the communication channels by creating a list of channels for the Communication Module
void	configurePeeringChannel(ChannelDescriptor peeringChannel, String peerName) Configures the peering channel by configuring the SpaceModule and by creating a new channel for the Communication Module
void	destroySpace(SpaceCard spaceCard)
List<SpaceCard>	discoverSpace(Dictionary<String,String> filters)
void	dispose() Release the resources
Map<PeerCard,Map<String,Serializable>>	findMatchingPeers(Map<String,Serializable> filter, int limit, int timeout)
String	getBrokerName()
PeerCard	getmyPeerCard() This method returns the PeerCard of the current MW instance
SpaceDescriptor	getMySpaceDescriptor() This method returns the SpaceDescriptor of my Space
List<String>	getPeersAddress()
void	handleSendError(ChannelMessage message, CommunicationConnectorException e) Callback for error handling
boolean	init()
void	installArtefactLocally(String serializedPart)
void	join(PeerCard spaceCoordinator, SpaceCard spaceCard)
void	joinRequest(SpaceCard spaceCard, PeerCard sender)
void	leaveRequest(SpaceDescriptor spaceDescriptor)
void	leaveSpace(PeerCard spaceCoordinator, SpaceCard spaceCard)
void	messageReceived(ChannelMessage message) Callback for the reception of messages
void	newPeerAdded(SpaceCard spaceCard, PeerCard peer)
void	newSpaceFound(Set<SpaceCard> spaceCards)
void	notifyRequestToInstallPart(UAPPCard mpaCard, String partID, UAPPPartStatus partStatus)
void	peerFound(PeerCard peer)
void	peerLost(PeerCard sender)
void	renewSpace(SpaceCard spaceCard)
Map<String,Serializable>	requestPeerAttributes(List<String> attributes, PeerCard target, int limit, int timeout)
void	requestPeerCard(String peerAddress)
void	requestToInstallPart(byte[] partAsZip, PeerCard target, UAPPCard card) This method allows to request the installation of an uApp part to a target node
void	requestToLeave(SpaceDescriptor spaceDescriptor)
void	requestToUninstallPart(PeerCard target, UAPPCard card) This method allows to request the installation of an uApp part to a target node
void	resetModule(List<ChannelDescriptor> channels)
void	sendConfigurationMessage(ConfigurationMessage cm) Send a Configuration Message.
void	sendMessage(BrokerMessage msg, List<PeerCard> receivers) Send a message.
void	sharedObjectAdded(Object sharedObj, Object removeHook)
void	sharedObjectRemoved(Object arg0)
void	signalSpaceStatus(SpaceStatus status, SpaceDescriptor spaceDescriptor)
void	spaceJoined(SpaceDescriptor descriptor)
BrokerMessage	unmarshall(String message) From String to Broker Message

Methods inherited from class java.lang.Object

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

Constructor Detail

ControlBroker

public ControlBroker(ModuleContext context)

Method Detail

init

public boolean init()

Specified by:

init in interface Broker

discoverSpace

public List<SpaceCard> discoverSpace(Dictionary<String,String> filters)

buildSpace

public void buildSpace(SpaceCard spaceCard)

sharedObjectAdded

public void sharedObjectAdded(Object sharedObj,
                              Object removeHook)

Specified by:

sharedObjectAdded in interface SharedObjectListener

sharedObjectRemoved

public void sharedObjectRemoved(Object arg0)

Specified by:

sharedObjectRemoved in interface SharedObjectListener

joinRequest

public void joinRequest(SpaceCard spaceCard,
                        PeerCard sender)

leaveRequest

public void leaveRequest(SpaceDescriptor spaceDescriptor)

requestToLeave

public void requestToLeave(SpaceDescriptor spaceDescriptor)

peerLost

public void peerLost(PeerCard sender)

join

public void join(PeerCard spaceCoordinator,
                 SpaceCard spaceCard)

getmyPeerCard

public PeerCard getmyPeerCard()

This method returns the PeerCard of the current MW instance

Returns:

PeerCard

getMySpaceDescriptor

public SpaceDescriptor getMySpaceDescriptor()

This method returns the SpaceDescriptor of my Space

Returns:

spaceJoined

public void spaceJoined(SpaceDescriptor descriptor)

peerFound

public void peerFound(PeerCard peer)

newSpaceFound

public void newSpaceFound(Set<SpaceCard> spaceCards)

configureChannels

public void configureChannels(List<ChannelDescriptor> communicationChannels,
                              String peerName)

Only configures the communication channels by creating a list of channels for the Communication Module

Parameters:

communicationChannels -

configurePeeringChannel

public void configurePeeringChannel(ChannelDescriptor peeringChannel,
                                    String peerName)

Configures the peering channel by configuring the SpaceModule and by creating a new channel for the Communication Module

Parameters:

peeringChannel -

resetModule

public void resetModule(List<ChannelDescriptor> channels)

destroySpace

public void destroySpace(SpaceCard spaceCard)

leaveSpace

public void leaveSpace(PeerCard spaceCoordinator,
                       SpaceCard spaceCard)

addNewPeer

public void addNewPeer(SpaceDescriptor spaceDescriptor,
                       PeerCard peer)

newPeerAdded

public void newPeerAdded(SpaceCard spaceCard,
                         PeerCard peer)

requestToUninstallPart

public void requestToUninstallPart(PeerCard target,
                                   UAPPCard card)

This method allows to request the installation of an uApp part to a target node

Parameters:

target - The node into which to install the part

card - The reference information of the part of the application within a service to install

requestToInstallPart

public void requestToInstallPart(byte[] partAsZip,
                                 PeerCard target,
                                 UAPPCard card)

This method allows to request the installation of an uApp part to a target node

Parameters:

partAsZip - The part serialized as a String. The payload of the DeployMessage has to be a string

target - The node into which to install the part

card - The reference information of the part of the application within a service to install

notifyRequestToInstallPart

public void notifyRequestToInstallPart(UAPPCard mpaCard,
                                       String partID,
                                       UAPPPartStatus partStatus)

Parameters:

mpaCard -

partID -

peer - The peer notifying the staus of the part

partStatus -

getBrokerName

public String getBrokerName()

Specified by:

getBrokerName in interface Broker

handleSendError

public void handleSendError(ChannelMessage message,
                            CommunicationConnectorException e)

Description copied from interface: MessageListener

Callback for error handling

Specified by:

handleSendError in interface MessageListener

messageReceived

public void messageReceived(ChannelMessage message)

Description copied from interface: MessageListener

Callback for the reception of messages

Specified by:

messageReceived in interface MessageListener

installArtefactLocally

public void installArtefactLocally(String serializedPart)

getPeersAddress

public List<String> getPeersAddress()

requestPeerCard

public void requestPeerCard(String peerAddress)

dispose

public void dispose()

Description copied from interface: Broker

Release the resources

Specified by:

dispose in interface Broker

renewSpace

public void renewSpace(SpaceCard spaceCard)

signalSpaceStatus

public void signalSpaceStatus(SpaceStatus status,
                              SpaceDescriptor spaceDescriptor)

unmarshall

public BrokerMessage unmarshall(String message)

Description copied from interface: Broker

From String to Broker Message

Specified by:

unmarshall in interface Broker

Returns:

requestPeerAttributes

public Map<String,Serializable> requestPeerAttributes(List<String> attributes,
                                                      PeerCard target,
                                                      int limit,
                                                      int timeout)

findMatchingPeers

public Map<PeerCard,Map<String,Serializable>> findMatchingPeers(Map<String,Serializable> filter,
                                                                int limit,
                                                                int timeout)

sendConfigurationMessage

public void sendConfigurationMessage(ConfigurationMessage cm)

Send a Configuration Message.

Parameters:

cm -

sendMessage

public void sendMessage(BrokerMessage msg,
                        List<PeerCard> receivers)

Send a message.