org.onosproject.ui.impl.topo

Class UiTopoSession

java.lang.Object

org.onosproject.ui.impl.topo.UiTopoSession

All Implemented Interfaces:

org.onosproject.event.EventFilter<UiModelEvent>, org.onosproject.event.EventListener<UiModelEvent>, UiModelListener

public class UiTopoSession
extends Object
implements UiModelListener

Coordinates with the UiTopoLayoutService to access UiTopoLayouts, and with the UiSharedTopologyModel which maintains a local model of the network entities, tailored specifically for displaying on the UI.

Note that an instance of this class will be created for each UiWebSocket connection, and will contain the state of how the topology is laid out for the logged-in user.

The expected pattern is for the Topo2ViewMessageHandler to obtain a reference to the session instance (via the UiWebSocket), and interact with it when topo-related events come in from the client.

Constructor Summary

Constructors

Constructor and Description
UiTopoSession(UiWebSocket webSocket, UiSharedTopologyModel model, org.onosproject.ui.UiTopoLayoutService layoutService) Creates a new topology session for the specified web socket connection.

Method Summary

Modifier and Type	Method and Description
List<org.onosproject.ui.model.topo.UiTopoLayout>	breadCrumbs() Returns the breadcrumb trail from current layout to root.
org.onosproject.ui.model.topo.UiTopoLayout	currentLayout() Returns the current layout context.
void	destroy() Destroys the session; unregistering from the shared model.
void	enableEvent(boolean enabled) Enables or disables the transmission of topology event update messages.
void	event(UiModelEvent event)
List<org.onosproject.ui.model.topo.UiClusterMember>	getAllInstances() Returns the list of ONOS instances (cluster members).
List<org.onosproject.ui.model.topo.UiSynthLink>	getLinks(org.onosproject.ui.model.topo.UiTopoLayout layout) Returns the (synthetic) links of the region in the specified layout.
Set<org.onosproject.ui.model.topo.UiNode>	getPeerNodes(org.onosproject.ui.model.topo.UiTopoLayout layout) Returns the regions/devices that are "peers" to this region.
org.onosproject.ui.model.topo.UiRegion	getRegion(org.onosproject.ui.model.topo.UiTopoLayout layout) Returns the region for the specified layout.
Set<org.onosproject.ui.model.topo.UiRegion>	getSubRegions(org.onosproject.ui.model.topo.UiTopoLayout layout) Returns the subregions of the region in the specified layout.
void	init() Initializes the session; registering with the shared model.
void	navToRegion(String regionId) Navigates to the specified region by setting the associated layout as current.
void	refreshModel() Refreshes the model's internal state.
void	setCurrentLayout(org.onosproject.ui.model.topo.UiTopoLayout topoLayout) Changes the current layout context to the specified layout.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.event.EventFilter

isRelevant

Constructor Detail

UiTopoSession

public UiTopoSession(UiWebSocket webSocket,
                     UiSharedTopologyModel model,
                     org.onosproject.ui.UiTopoLayoutService layoutService)

Creates a new topology session for the specified web socket connection.

Parameters:

webSocket - web socket

model - share topology model

layoutService - topology layout service

Method Detail

init

public void init()

Initializes the session; registering with the shared model.

destroy

public void destroy()

Destroys the session; unregistering from the shared model.

toString

public String toString()

Overrides:

toString in class Object

event

public void event(UiModelEvent event)

Specified by:

event in interface org.onosproject.event.EventListener<UiModelEvent>

currentLayout

public org.onosproject.ui.model.topo.UiTopoLayout currentLayout()

Returns the current layout context.

Returns:

current topology layout

breadCrumbs

public List<org.onosproject.ui.model.topo.UiTopoLayout> breadCrumbs()

Returns the breadcrumb trail from current layout to root. That is, element 0 of the list will be the current layout; the last element of the list will be the root layout. This list is guaranteed to have size of at least 1.

Returns:

breadcrumb trail

setCurrentLayout

public void setCurrentLayout(org.onosproject.ui.model.topo.UiTopoLayout topoLayout)

Changes the current layout context to the specified layout.

Parameters:

topoLayout - new topology layout context

enableEvent

public void enableEvent(boolean enabled)

Enables or disables the transmission of topology event update messages.

Parameters:

enabled - true if messages should be sent

getAllInstances

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

Returns the list of ONOS instances (cluster members).

Returns:

the list of ONOS instances

getRegion

public org.onosproject.ui.model.topo.UiRegion getRegion(org.onosproject.ui.model.topo.UiTopoLayout layout)

Returns the region for the specified layout.

Parameters:

layout - layout filter

Returns:

region that the layout is based upon

getPeerNodes

public Set<org.onosproject.ui.model.topo.UiNode> getPeerNodes(org.onosproject.ui.model.topo.UiTopoLayout layout)

Returns the regions/devices that are "peers" to this region. That is, based on the layout the user is viewing, all the regions/devices that are associated with layouts that share the same parent layout as this layout, AND that are linked to an element within this region.

Parameters:

layout - the layout being viewed

Returns:

all regions/devices that are "siblings" to this layout's region

getSubRegions

public Set<org.onosproject.ui.model.topo.UiRegion> getSubRegions(org.onosproject.ui.model.topo.UiTopoLayout layout)

Returns the subregions of the region in the specified layout.

Parameters:

layout - the layout being viewed

Returns:

all regions that are "contained within" this layout's region

getLinks

public List<org.onosproject.ui.model.topo.UiSynthLink> getLinks(org.onosproject.ui.model.topo.UiTopoLayout layout)

Returns the (synthetic) links of the region in the specified layout.

Parameters:

layout - the layout being viewed

Returns:

all links that are contained by this layout's region

refreshModel

public void refreshModel()

Refreshes the model's internal state.

navToRegion

public void navToRegion(String regionId)

Navigates to the specified region by setting the associated layout as current.

Parameters:

regionId - region identifier