org.universAAL.middleware.modules.space

Class SpaceModuleImpl

java.lang.Object

org.universAAL.middleware.modules.space.SpaceModuleImpl

All Implemented Interfaces:

Broker, ServiceListener, SharedObjectListener, MessageListener, Module, SpaceModule

public class SpaceModuleImpl
extends Object
implements SpaceModule, MessageListener, SharedObjectListener, ServiceListener, Broker

Implementation of the SpaceModule

Author:

Michele Girolami

Constructor Summary

Constructors

Constructor and Description
SpaceModuleImpl(ModuleContext context)

Method Summary

Modifier and Type	Method and Description
void	addPeer(SpaceDescriptor spaceDescriptor, PeerCard newPeer) This method allows to add a new Peer to the Space.
void	announceNewPeer(SpaceCard spaceCard, PeerCard peerCard) This method propagates the event of new PeerAdded to the whole Space
void	configureSpaceChannel() This method configures the channel used in order to send/receive Space messages
void	destroySpace(SpaceCard spaceCard) Destroy a Space
void	dispose() Routine in order to release resources
String	getBrokerName()
String	getDescription()
String	getName()
List<String>	getPeersAddress() This method fetches the list of peer address joining to the same Space
String	getProvider()
List<SpaceCard>	getSpaces() This method fetches a list of Spaces without any filter
List<SpaceCard>	getSpaces(Dictionary<String,String> filters) This method fetches a list of Spaces according to a filter
String	getVersion()
void	handleSendError(ChannelMessage message, CommunicationConnectorException exception) Callback for error handling
boolean	init() This method configures the SpaceModule: -to obtain the reference to all the DiscoveryConnector present in the fw -to obtain the reference to the CommunicationModdule -to obtain the reference to the ControlBroker
void	joinSpace(PeerCard spaceCoordinator, SpaceCard spaceCard) This method allows to join to an existing Space
void	leaveSpace(PeerCard spaceCoordinator, SpaceCard spaceCard) This method allows to leave a Space
void	loadConfigurations(Dictionary configurations)
void	messageFromSpace(SpaceMessage message, PeerCard sender) This method is called as soon as an SpaceMessage has been received
void	messageReceived(ChannelMessage message) Callback for the reception of messages
void	newSpace(SpaceCard spaceCard) This method creates a new Space
void	newSpacesFound(Set<SpaceCard> spaceCards) Called when a new Space has been found
void	renewSpace(SpaceCard spaceCard) This method renews the Space
void	requestPeerCard(SpaceDescriptor spaceDescriptor, String peerAddress) This method allows to send a request for the PeerCard of the peer with the specified address
void	requestToLeave(SpaceDescriptor spaceDescriptor) This method announces to all the peers to leave the space
void	sharedObjectAdded(Object arg0, Object arg1)
void	sharedObjectRemoved(Object arg0)
void	spaceLost(SpaceCard spaceCard) Called when an Space has been destroyed
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

SpaceModuleImpl

public SpaceModuleImpl(ModuleContext context)

Method Detail

init

public boolean init()

This method configures the SpaceModule: -to obtain the reference to all the DiscoveryConnector present in the fw -to obtain the reference to the CommunicationModdule -to obtain the reference to the ControlBroker

Specified by:

init in interface Broker

Specified by:

init in interface Module

Returns:

true if initialized with the connectors and the module, false otherwise

getSpaces

public List<SpaceCard> getSpaces()

Description copied from interface: SpaceModule

This method fetches a list of Spaces without any filter

Specified by:

getSpaces in interface SpaceModule

Returns:

List of discovered Spaces

getSpaces

public List<SpaceCard> getSpaces(Dictionary<String,String> filters)
                          throws SpaceModuleException

Description copied from interface: SpaceModule

This method fetches a list of Spaces according to a filter

Specified by:

getSpaces in interface SpaceModule

Parameters:

filters - A set of key, value pairs for filtering the Spaces

Returns:

Throws:

SpaceModuleException

newSpace

public void newSpace(SpaceCard spaceCard)
              throws SpaceModuleException

Description copied from interface: SpaceModule

This method creates a new Space

Specified by:

newSpace in interface SpaceModule

Throws:

SpaceModuleException

getDescription

public String getDescription()

Specified by:

getDescription in interface Module

getProvider

public String getProvider()

Specified by:

getProvider in interface Module

getVersion

public String getVersion()

Specified by:

getVersion in interface Module

getName

public String getName()

Specified by:

getName in interface Module

loadConfigurations

public void loadConfigurations(Dictionary configurations)

Specified by:

loadConfigurations in interface Module

leaveSpace

public void leaveSpace(PeerCard spaceCoordinator,
                       SpaceCard spaceCard)

Description copied from interface: SpaceModule

This method allows to leave a Space

Specified by:

leaveSpace in interface SpaceModule

spaceCard - Space Card of the Space to leave

requestToLeave

public void requestToLeave(SpaceDescriptor spaceDescriptor)

Description copied from interface: SpaceModule

This method announces to all the peers to leave the space

Specified by:

requestToLeave in interface SpaceModule

requestPeerCard

public void requestPeerCard(SpaceDescriptor spaceDescriptor,
                            String peerAddress)

Description copied from interface: SpaceModule

This method allows to send a request for the PeerCard of the peer with the specified address

Specified by:

requestPeerCard in interface SpaceModule

Parameters:

spaceDescriptor - the Space descriptor

peerAddress - the address of the peer

newSpacesFound

public void newSpacesFound(Set<SpaceCard> spaceCards)

Description copied from interface: ServiceListener

Called when a new Space has been found

Specified by:

newSpacesFound in interface ServiceListener

joinSpace

public void joinSpace(PeerCard spaceCoordinator,
                      SpaceCard spaceCard)

Description copied from interface: SpaceModule

This method allows to join to an existing Space

Specified by:

joinSpace in interface SpaceModule

Parameters:

spaceCoordinator - The PeerCard of the Space coordinator to which to sent the request

spaceCard - The SpaceCard of the space the peer aims to join

addPeer

public void addPeer(SpaceDescriptor spaceDescriptor,
                    PeerCard newPeer)

Description copied from interface: SpaceModule

This method allows to add a new Peer to the Space.

Specified by:

addPeer in interface SpaceModule

Parameters:

spaceDescriptor - All the information regarding the Space for the new Peer

newPeer - The Peer to add to the Space

announceNewPeer

public void announceNewPeer(SpaceCard spaceCard,
                            PeerCard peerCard)

Description copied from interface: SpaceModule

This method propagates the event of new PeerAdded to the whole Space

Specified by:

announceNewPeer in interface SpaceModule

Parameters:

spaceCard - The Space where to propagate the event

peerCard - The new peer added

messageFromSpace

public void messageFromSpace(SpaceMessage message,
                             PeerCard sender)
                      throws SpaceModuleException

Description copied from interface: SpaceModule

This method is called as soon as an SpaceMessage has been received

Specified by:

messageFromSpace in interface SpaceModule

Throws:

SpaceModuleException

configureSpaceChannel

public void configureSpaceChannel()

Description copied from interface: SpaceModule

This method configures the channel used in order to send/receive Space messages

Specified by:

configureSpaceChannel in interface SpaceModule

messageReceived

public void messageReceived(ChannelMessage message)

Description copied from interface: MessageListener

Callback for the reception of messages

Specified by:

messageReceived in interface MessageListener

handleSendError

public void handleSendError(ChannelMessage message,
                            CommunicationConnectorException exception)
                     throws SpaceModuleException

Description copied from interface: MessageListener

Callback for error handling

Specified by:

handleSendError in interface MessageListener

Throws:

SpaceModuleException

destroySpace

public void destroySpace(SpaceCard spaceCard)

Description copied from interface: SpaceModule

Destroy a Space

Specified by:

destroySpace in interface SpaceModule

Parameters:

spaceCard - Space to destroy

spaceLost

public void spaceLost(SpaceCard spaceCard)

Description copied from interface: ServiceListener

Called when an Space has been destroyed

Specified by:

spaceLost in interface ServiceListener

Parameters:

spaceCard - Information about the Space

sharedObjectAdded

public void sharedObjectAdded(Object arg0,
                              Object arg1)

Specified by:

sharedObjectAdded in interface SharedObjectListener

sharedObjectRemoved

public void sharedObjectRemoved(Object arg0)

Specified by:

sharedObjectRemoved in interface SharedObjectListener

getBrokerName

public String getBrokerName()

Specified by:

getBrokerName in interface Broker

dispose

public void dispose()

Description copied from interface: Module

Routine in order to release resources

Specified by:

dispose in interface Broker

Specified by:

dispose in interface Module

getPeersAddress

public List<String> getPeersAddress()

Description copied from interface: SpaceModule

This method fetches the list of peer address joining to the same Space

Specified by:

getPeersAddress in interface SpaceModule

Returns:

The consolidated list of peers

renewSpace

public void renewSpace(SpaceCard spaceCard)

Description copied from interface: SpaceModule

This method renews the Space

Specified by:

renewSpace in interface SpaceModule

unmarshall

public BrokerMessage unmarshall(String message)

Description copied from interface: Broker

From String to Broker Message

Specified by:

unmarshall in interface Broker

Returns: