org.onosproject.ui.impl.topo.model

Class UiSharedTopologyModel

java.lang.Object

org.onosproject.event.AbstractListenerManager<UiModelEvent,UiModelListener>

org.onosproject.ui.impl.topo.model.UiSharedTopologyModel

All Implemented Interfaces:

org.onosproject.event.ListenerService<UiModelEvent,UiModelListener>

@Service(value=UiSharedTopologyModel.class)
public final class UiSharedTopologyModel
extends org.onosproject.event.AbstractListenerManager<UiModelEvent,UiModelListener>

Service that creates and maintains the UI-model of the network topology.

Field Summary

Fields inherited from class org.onosproject.event.AbstractListenerManager

eventDispatcher, listenerRegistry

Constructor Summary

Constructors

Constructor and Description
UiSharedTopologyModel()

Method Summary

Modifier and Type	Method and Description
protected void	activate()
protected void	deactivate()
List<org.onosproject.ui.model.topo.UiClusterMember>	getClusterMembers() Returns the list of cluster members stored in the model cache.
Set<org.onosproject.ui.model.topo.UiDeviceLink>	getDeviceLinks() Returns the set of device links stored in the model cache.
Set<org.onosproject.ui.model.topo.UiDevice>	getDevices() Returns the set of devices stored in the model cache.
Set<org.onosproject.ui.model.topo.UiHost>	getHosts() Returns the set of hosts stored in the model cache.
org.onosproject.ui.model.topo.UiRegion	getNullRegion() Returns the null region.
org.onosproject.ui.model.topo.UiRegion	getRegion(org.onosproject.net.region.RegionId id) Returns the region for the given identifier.
Set<org.onosproject.ui.model.topo.UiRegion>	getRegions() Returns the set of regions stored in the model cache.
List<org.onosproject.ui.model.topo.UiSynthLink>	getSynthLinks(org.onosproject.net.region.RegionId regionId) Returns the synthetic links associated with the specified region.
void	refresh() Refreshes the cache's internal state.
void	register(UiTopoSession session) Registers a UI topology session with the topology model.
void	unregister(UiTopoSession session) Unregisters a UI topology session from the topology model.

Methods inherited from class org.onosproject.event.AbstractListenerManager

addListener, bindEventDispatcher, post, removeListener, unbindEventDispatcher

Methods inherited from class java.lang.Object

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

Constructor Detail

UiSharedTopologyModel

public UiSharedTopologyModel()

Method Detail

activate

@Activate
protected void activate()

deactivate

@Deactivate
protected void deactivate()

register

public void register(UiTopoSession session)

Registers a UI topology session with the topology model.

Parameters:

session - the session to register

unregister

public void unregister(UiTopoSession session)

Unregisters a UI topology session from the topology model.

Parameters:

session - the session to unregister

refresh

public void refresh()

Refreshes the cache's internal state.

getClusterMembers

public List<org.onosproject.ui.model.topo.UiClusterMember> getClusterMembers()

Returns the list of cluster members stored in the model cache.

Returns:

list of cluster members

getRegions

public Set<org.onosproject.ui.model.topo.UiRegion> getRegions()

Returns the set of regions stored in the model cache.

Returns:

set of regions

getRegion

public org.onosproject.ui.model.topo.UiRegion getRegion(org.onosproject.net.region.RegionId id)

Returns the region for the given identifier.

Parameters:

id - region identifier

Returns:

the region

getNullRegion

public org.onosproject.ui.model.topo.UiRegion getNullRegion()

Returns the null region.

Returns:

the null region

getDevices

public Set<org.onosproject.ui.model.topo.UiDevice> getDevices()

Returns the set of devices stored in the model cache.

Returns:

set of devices

getHosts

public Set<org.onosproject.ui.model.topo.UiHost> getHosts()

Returns the set of hosts stored in the model cache.

Returns:

set of hosts

getDeviceLinks

public Set<org.onosproject.ui.model.topo.UiDeviceLink> getDeviceLinks()

Returns the set of device links stored in the model cache.

Returns:

set of device links

getSynthLinks

public List<org.onosproject.ui.model.topo.UiSynthLink> getSynthLinks(org.onosproject.net.region.RegionId regionId)

Returns the synthetic links associated with the specified region.

Parameters:

regionId - region ID

Returns:

synthetic links for that region