topology
Class TopologyService

java.lang.Object
  extended by topology.TopologyService

public abstract class TopologyService
extends Object

Implements the service-type component for the topology module. It is the entry-point for this module, offering an interface to the actions performed by the OverlayManagement. This module deals only with the dynamic view of groups' devices, overlays, retrieving and managing information needed for communicating with other devices (e.g. for synchronization purposes).


Field Summary
(package private)  NetworkService networkService
          The communication between the TopologyService and the remote services goes through the network module.
(package private)  OverlayManagement overlayManagement
          TopologyService uses the OverlayManagement component for retrieving overlay data, or informing it about updates.
 
Constructor Summary
TopologyService()
           
 
Method Summary
abstract  void buildGroupOverlays()
          The topology module starts building the group overlays.
abstract  List<Device> getDevices(Group group)
          Returns the devices in the given group's overlay.
abstract  void updateGroupOverlay(Group group)
          The topology module is informed that a group change related to user dynamics has occurred, and needs to update the overlay for that group.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

overlayManagement

OverlayManagement overlayManagement
TopologyService uses the OverlayManagement component for retrieving overlay data, or informing it about updates.


networkService

NetworkService networkService
The communication between the TopologyService and the remote services goes through the network module. TopologyService uses the NetworkService to send requests for information about devices.

Constructor Detail

TopologyService

public TopologyService()
Method Detail

getDevices

public abstract List<Device> getDevices(Group group)
Returns the devices in the given group's overlay. This method is invoked by the SynchronizationService when starting a synchronization process.

Parameters:
group - - the group for which the devices are requested
Returns:
a list of Device objects that represent the online devices and contain their connectivity information.

updateGroupOverlay

public abstract void updateGroupOverlay(Group group)
The topology module is informed that a group change related to user dynamics has occurred, and needs to update the overlay for that group.

Parameters:
group -

buildGroupOverlays

public abstract void buildGroupOverlays()
The topology module starts building the group overlays.