org.universAAL.middleware.modules

Interface SpaceModule

All Superinterfaces:

Module

All Known Implementing Classes:

SpaceModuleImpl

public interface SpaceModule
extends Module

The implementations of this interface manage the Space life-cycle: creation, update, destroy.

Author:

Michele Girolami

Method Summary

Modifier and Type	Method and Description
void	addPeer(SpaceDescriptor spaceDescriptor, PeerCard peer) 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
List<String>	getPeersAddress() This method fetches the list of peer address joining to the same Space
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
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	messageFromSpace(SpaceMessage message, PeerCard sender) This method is called as soon as an SpaceMessage has been received
void	newSpace(SpaceCard spaceCard) This method creates a new Space
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

Methods inherited from interface org.universAAL.middleware.modules.Module

dispose, getDescription, getName, getProvider, getVersion, init, loadConfigurations

Method Detail

getSpaces

List<SpaceCard> getSpaces()

This method fetches a list of Spaces without any filter

Returns:

List of discovered Spaces

getSpaces

List<SpaceCard> getSpaces(Dictionary<String,String> filters)

This method fetches a list of Spaces according to a filter

Parameters:

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

Returns:

newSpace

void newSpace(SpaceCard spaceCard)

This method creates a new Space

Parameters:

configurations - The configuration parameters for the Space

renewSpace

void renewSpace(SpaceCard spaceCard)

This method renews the Space

Parameters:

spaceCard -

destroySpace

void destroySpace(SpaceCard spaceCard)

Destroy a Space

Parameters:

spaceCard - Space to destroy

joinSpace

void joinSpace(PeerCard spaceCoordinator,
               SpaceCard spaceCard)

This method allows to join to an existing Space

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

leaveSpace

void leaveSpace(PeerCard spaceCoordinator,
                SpaceCard spaceCard)

This method allows to leave a Space

Parameters:

spaceCard - Space Card of the Space to leave

requestToLeave

void requestToLeave(SpaceDescriptor spaceDescriptor)

This method announces to all the peers to leave the space

Parameters:

spaceDescriptor -

requestPeerCard

void requestPeerCard(SpaceDescriptor spaceDescriptor,
                     String peerAddress)

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

Parameters:

peerAddress - the address of the peer

spaceDescriptor - the Space descriptor

messageFromSpace

void messageFromSpace(SpaceMessage message,
                      PeerCard sender)

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

Parameters:

message -

addPeer

void addPeer(SpaceDescriptor spaceDescriptor,
             PeerCard peer)

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

Parameters:

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

peer - The Peer to add to the Space

announceNewPeer

void announceNewPeer(SpaceCard spaceCard,
                     PeerCard peerCard)

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

Parameters:

spaceCard - The Space where to propagate the event

peerCard - The new peer added

configureSpaceChannel

void configureSpaceChannel()

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

getPeersAddress

List<String> getPeersAddress()

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

Parameters:

peers -

Returns:

The consolidated list of peers