SpaceManagerImpl (universAAL Super POM 3.4.2-SNAPSHOT API)

java.lang.Object
- org.universAAL.middleware.managers.space.SpaceManagerImpl

All Implemented Interfaces:

SharedObjectListener, Manager, SpaceEventHandler, SpaceManager
```
public class SpaceManagerImpl
extends Object
implements SpaceEventHandler, SpaceManager, SharedObjectListener
```
The implementation of the SpaceManager and SpaceEventHandler

Version:

$LastChangedRevision$ ( $LastChangedDate$ )

Author:

Michele Girolami, Stefano Lenzi, Giancarlo Riolo, Carsten Stockloew

Field Summary
- Fields inherited from interface org.universAAL.middleware.managers.api.SpaceManager
  COMUNICATION_TIMEOUT_KEY, COMUNICATION_TIMEOUT_VALUE, DEFAULT_PEER_ROLE, PEER_ID_FILE

Constructor Summary

Constructors
Constructor and Description

SpaceManagerImpl(ModuleContext context)

Constructors
Constructor and Description
`SpaceManagerImpl(ModuleContext context)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSpaceListener(SpaceListener listener)` Add a new Space listener.
`void`	`cleanUpJoinRequest()`
`void`	`dispose()` Release all the resources
`Map<String,SpaceDescriptor>`	`getManagedSpaces()` This method return a map of Space managed by this MW instance
`MatchingResult`	`getMatchingPeers(Map<String,Serializable> filter)` A method for identifying a possible set of Peer in the space that can be used for installing a part of the universAAL application. The matching algorithm returns only the Peer of the space that match the following rules For each key of the `Map` with `null` value, an attribute with any value must be available on the matching Peer For each key of the `Map` with a not `null` value, an attribute with same value must be available on the matching Peer.
`PeerCard`	`getMyPeerCard()` This method returns the PeerCard of the current MW instance
`Map<String,Serializable>`	`getPeerAttributes(List<String> attributes, PeerCard target)`
`Map<String,PeerCard>`	`getPeers()` This method return the list of neighborhood peers joined to the current Space. NOTE: The list does not contains the invoker
`Boolean`	`getPendingSpace()`
`ISpace`	`getSpaceDefaultConfiguration()`
`SpaceDescriptor`	`getSpaceDescriptor()` This method returns the SpaceDescriptor of the Space where the MW belongs to or null if the mw instance does not join to any Space.
`Set<SpaceCard>`	`getSpaces()` This method returns the list of Space discovered
`SpaceStatus`	`getSpaceStatus()`
`long`	`getWaitAfterJoinRequest()`
`boolean`	`init()` Initialize the Space Manager
`void`	`initSpace(ISpace spaceDefaultConfiguration)` Private method to manage the creation of a new Space starting from the default configurations
`void`	`join(SpaceCard spaceCard)` method to join an existing Space according the configuration file: -to configure the peering channel -to send a join request -to receive the join response -to get the SpaceDescriptor -to configure the communication channels
`void`	`joinRequest(SpaceCard spaceCard, PeerCard peer)` This method allows the SpaceManager to manage a join request from a remote peer.
`void`	`leaveRequest(SpaceDescriptor spaceDescriptor)` This method forces the peer to leave a Space
`void`	`leaveSpace(SpaceDescriptor spaceDescriptor)` Method used to leave an Space
`void`	`loadConfigurations(Dictionary configurations)` This method sets all the configurations for the SpaceManager
`void`	`mpaInstalled(SpaceDescriptor spaceDescriptor)` Called in order to alert the Space about the installation of a new MPA
`void`	`mpaInstalling(SpaceDescriptor spaceDescriptor)` Called in order to alert the Space about the installation of a new MPA
`void`	`newSpacesFound(Set<SpaceCard> spaceCards)` A new Space has been found
`void`	`peerFound(PeerCard peer)` Method called when a peer joins the Space managed by the SpaceManager
`void`	`peerLost(PeerCard peer)` This method notifies to the coordinator that a peer wants to leave to the Space
`ISpace`	`readSpaceDefaultConfigurations()`
`void`	`removeSpaceListener(SpaceListener listener)` Remove a Space Listener
`void`	`setListOfPeers(Map<String,PeerCard> peers)` This method allows to configure the set of peers that actually join the Space managed or joined by this SpaceManager
`void`	`sharedObjectAdded(Object sharedObj, Object removeHook)`
`void`	`sharedObjectRemoved(Object removeHook)`
`void`	`spaceEvent(SpaceStatus newStatus)`
`void`	`spaceJoined(SpaceDescriptor descriptor)` The method is called asynchronously from the bottom layer of the MW after a previous join(...) request.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SpaceManagerImpl
```
public SpaceManagerImpl(ModuleContext context)
```
- Method Detail
  - getManagedSpaces
```
public Map<String,SpaceDescriptor> getManagedSpaces()
```
    Description copied from interface: SpaceManager
    
    This method return a map of Space managed by this MW instance
    
    Specified by:
    
    getManagedSpaces in interface SpaceManager
    
    Returns:
  - getPeers
```
public Map<String,PeerCard> getPeers()
```
    Description copied from interface: SpaceManager
    
    This method return the list of neighborhood peers joined to the current Space.
    NOTE: The list does not contains the invoker
    
    Specified by:
    
    getPeers in interface SpaceManager
    
    Returns:
    
    Map of peers: peerID, PeerCard
  - getSpaceDefaultConfiguration
```
public ISpace getSpaceDefaultConfiguration()
```
  - getPendingSpace
```
public Boolean getPendingSpace()
```
  - getWaitAfterJoinRequest
```
public long getWaitAfterJoinRequest()
```
  - getSpaceDescriptor
```
public SpaceDescriptor getSpaceDescriptor()
```
    Description copied from interface: SpaceManager
    
    This method returns the SpaceDescriptor of the Space where the MW belongs to or null if the mw instance does not join to any Space.
    
    Specified by:
    
    getSpaceDescriptor in interface SpaceManager
    
    Returns:
    
    SpaceDescriptor
  - getMyPeerCard
```
public PeerCard getMyPeerCard()
```
    Description copied from interface: SpaceManager
    
    This method returns the PeerCard of the current MW instance
    
    Specified by:
    
    getMyPeerCard in interface SpaceManager
    
    Returns:
    
    PeerCard
  - getSpaces
```
public Set<SpaceCard> getSpaces()
```
    Description copied from interface: SpaceManager
    
    This method returns the list of Space discovered
    
    Specified by:
    
    getSpaces in interface SpaceManager
    
    Returns:
    
    Set of Space found
  - init
```
public boolean init()
```
    Description copied from interface: Manager
    
    Initialize the Space Manager
    
    Specified by:
    
    init in interface Manager
    
    Returns:
    
    true if the initialization is completed, false otherwise
  - initSpace
```
public void initSpace(ISpace spaceDefaultConfiguration)
```
    Private method to manage the creation of a new Space starting from the default configurations
    
    Parameters:
    
    spaceDefaultConfiguration - Default Space configurations
  - join
```
public void join(SpaceCard spaceCard)
```
    Description copied from interface: SpaceManager
    
    method to join an existing Space according the configuration file: -to configure the peering channel -to send a join request -to receive the join response -to get the SpaceDescriptor -to configure the communication channels
    
    Specified by:
    
    join in interface SpaceManager
  - cleanUpJoinRequest
```
public void cleanUpJoinRequest()
```
  - spaceJoined
```
public void spaceJoined(SpaceDescriptor descriptor)
```
    Description copied from interface: SpaceEventHandler
    
    The method is called asynchronously from the bottom layer of the MW after a previous join(...) request.
    
    Specified by:
    
    spaceJoined in interface SpaceEventHandler
    
    Parameters:
    
    descriptor - all the information about the joined Space
  - readSpaceDefaultConfigurations
```
public ISpace readSpaceDefaultConfigurations()
```
  - loadConfigurations
```
public void loadConfigurations(Dictionary configurations)
```
    Description copied from interface: Manager
    
    This method sets all the configurations for the SpaceManager
    
    Specified by:
    
    loadConfigurations in interface Manager
    
    Parameters:
    
    configurations - Dictionary of configurations
  - joinRequest
```
public void joinRequest(SpaceCard spaceCard,
                        PeerCard peer)
```
    Description copied from interface: SpaceEventHandler
    
    This method allows the SpaceManager to manage a join request from a remote peer. In this case this SpaceManager is the Space coordinator
    
    Specified by:
    
    joinRequest in interface SpaceEventHandler
  - newSpacesFound
```
public void newSpacesFound(Set<SpaceCard> spaceCards)
```
    Description copied from interface: SpaceEventHandler
    
    A new Space has been found
    
    Specified by:
    
    newSpacesFound in interface SpaceEventHandler
  - peerFound
```
public void peerFound(PeerCard peer)
```
    Description copied from interface: SpaceEventHandler
    
    Method called when a peer joins the Space managed by the SpaceManager
    
    Specified by:
    
    peerFound in interface SpaceEventHandler
  - peerLost
```
public void peerLost(PeerCard peer)
```
    Description copied from interface: SpaceEventHandler
    
    This method notifies to the coordinator that a peer wants to leave to the Space
    
    Specified by:
    
    peerLost in interface SpaceEventHandler
  - sharedObjectAdded
```
public void sharedObjectAdded(Object sharedObj,
                              Object removeHook)
```
    Specified by:
    
    sharedObjectAdded in interface SharedObjectListener
  - sharedObjectRemoved
```
public void sharedObjectRemoved(Object removeHook)
```
    Specified by:
    
    sharedObjectRemoved in interface SharedObjectListener
  - leaveRequest
```
public void leaveRequest(SpaceDescriptor spaceDescriptor)
```
    Description copied from interface: SpaceEventHandler
    
    This method forces the peer to leave a Space
    
    Specified by:
    
    leaveRequest in interface SpaceEventHandler
  - leaveSpace
```
public void leaveSpace(SpaceDescriptor spaceDescriptor)
```
    Description copied from interface: SpaceManager
    
    Method used to leave an Space
    
    Specified by:
    
    leaveSpace in interface SpaceManager
  - dispose
```
public void dispose()
```
    Description copied from interface: Manager
    
    Release all the resources
    
    Specified by:
    
    dispose in interface Manager
  - addSpaceListener
```
public void addSpaceListener(SpaceListener listener)
```
    Description copied from interface: SpaceManager
    
    Add a new Space listener.
    
    Specified by:
    
    addSpaceListener in interface SpaceManager
  - removeSpaceListener
```
public void removeSpaceListener(SpaceListener listener)
```
    Description copied from interface: SpaceManager
    
    Remove a Space Listener
    
    Specified by:
    
    removeSpaceListener in interface SpaceManager
  - setListOfPeers
```
public void setListOfPeers(Map<String,PeerCard> peers)
```
    Description copied from interface: SpaceEventHandler
    
    This method allows to configure the set of peers that actually join the Space managed or joined by this SpaceManager
    
    Specified by:
    
    setListOfPeers in interface SpaceEventHandler
    
    Parameters:
    
    peers - Map of peers
  - getSpaceStatus
```
public SpaceStatus getSpaceStatus()
```
  - mpaInstalled
```
public void mpaInstalled(SpaceDescriptor spaceDescriptor)
```
    Description copied from interface: SpaceEventHandler
    
    Called in order to alert the Space about the installation of a new MPA
    
    Specified by:
    
    mpaInstalled in interface SpaceEventHandler
  - mpaInstalling
```
public void mpaInstalling(SpaceDescriptor spaceDescriptor)
```
    Description copied from interface: SpaceEventHandler
    
    Called in order to alert the Space about the installation of a new MPA
    
    Specified by:
    
    mpaInstalling in interface SpaceEventHandler
  - spaceEvent
```
public void spaceEvent(SpaceStatus newStatus)
```
    Specified by:
    
    spaceEvent in interface SpaceEventHandler
  - getMatchingPeers
```
public MatchingResult getMatchingPeers(Map<String,Serializable> filter)
```
    Description copied from interface: SpaceManager
    A method for identifying a possible set of Peer in the space that can be used for installing a part of the universAAL application.
    The matching algorithm returns only the Peer of the space that match the following rules
    - For each key of the Map with null value, an attribute with any value must be available on the matching Peer
    - For each key of the Map with a not null value, an attribute with same value must be available on the matching Peer. The #equals(Object) is used for checking if the value are the same
    Specified by:
    
    getMatchingPeers in interface SpaceManager
    
    Parameters:
    
    filter - a Map that contains a pair of String as Key and Object as value which will be used for looking for matching among the one available on the space
    
    Returns:
    
    MatchingResult representing the filtering result
  - getPeerAttributes
```
public Map<String,Serializable> getPeerAttributes(List<String> attributes,
                                                  PeerCard target)
```
    Specified by:
    
    getPeerAttributes in interface SpaceManager
    
    Parameters:
    
    attributes - The list of attribute to get value,
    
    target - PeerCard the peer card that identifies the peer that we want to read attribute from
    
    Returns:
    
    a Map with the pair String, Serializable representing the attribute requested along with its value.

Class SpaceManagerImpl

Field Summary

Fields inherited from interface org.universAAL.middleware.managers.api.SpaceManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SpaceManagerImpl

Method Detail

getManagedSpaces

getPeers

getSpaceDefaultConfiguration

getPendingSpace

getWaitAfterJoinRequest

getSpaceDescriptor

getMyPeerCard

getSpaces

init

initSpace

join

cleanUpJoinRequest

spaceJoined

readSpaceDefaultConfigurations

loadConfigurations

joinRequest

newSpacesFound

peerFound

peerLost

sharedObjectAdded

sharedObjectRemoved

leaveRequest

leaveSpace

dispose

addSpaceListener

removeSpaceListener

setListOfPeers

getSpaceStatus

mpaInstalled

mpaInstalling

spaceEvent

getMatchingPeers

getPeerAttributes