org.onosproject.common

Class DefaultTopology

java.lang.Object

org.onosproject.net.AbstractAnnotated

org.onosproject.net.AbstractModel

org.onosproject.common.DefaultTopology

All Implemented Interfaces:

org.onosproject.net.Annotated, org.onosproject.net.Provided, org.onosproject.net.topology.Topology

public class DefaultTopology
extends org.onosproject.net.AbstractModel
implements org.onosproject.net.topology.Topology

Default implementation of the topology descriptor. This carries the backing topology data.

Constructor Summary

Constructors

Constructor and Description
DefaultTopology(org.onosproject.net.provider.ProviderId providerId, org.onosproject.net.topology.GraphDescription description) Creates a topology descriptor attributed to the specified provider.
DefaultTopology(org.onosproject.net.provider.ProviderId providerId, org.onosproject.net.topology.GraphDescription description, com.google.common.base.Function<org.onosproject.net.ConnectPoint,Boolean> broadcastFunction) Creates a topology descriptor attributed to the specified provider.

Method Summary

Modifier and Type	Method and Description
Set<org.onosproject.net.ConnectPoint>	broadcastPoints(org.onosproject.net.topology.ClusterId clusterId) Returns the set of the cluster broadcast points.
int	broadcastSetSize(org.onosproject.net.topology.ClusterId clusterId) Returns the size of the cluster broadcast set.
int	clusterCount()
long	computeCost()
long	creationTime()
int	deviceCount()
org.onosproject.net.topology.TopologyCluster	getCluster(org.onosproject.net.topology.ClusterId clusterId) Returns the specified topology cluster.
org.onosproject.net.topology.TopologyCluster	getCluster(org.onosproject.net.DeviceId deviceId) Returns the topology cluster that contains the given device.
Set<org.onosproject.net.DeviceId>	getClusterDevices(org.onosproject.net.topology.TopologyCluster cluster) Returns the set of cluster devices.
Set<org.onosproject.net.Link>	getClusterLinks(org.onosproject.net.topology.TopologyCluster cluster) Returns the set of cluster links.
Set<org.onosproject.net.topology.TopologyCluster>	getClusters() Returns the set of topology clusters.
Set<org.onosproject.net.DisjointPath>	getDisjointPaths(org.onosproject.net.DeviceId src, org.onosproject.net.DeviceId dst) /** Returns the set of pre-computed shortest disjoint path pairs between source and destination devices.
Set<org.onosproject.net.DisjointPath>	getDisjointPaths(org.onosproject.net.DeviceId src, org.onosproject.net.DeviceId dst, org.onosproject.net.topology.LinkWeight weight) Computes on-demand the set of shortest disjoint path pairs between source and destination devices.
Set<org.onosproject.net.DisjointPath>	getDisjointPaths(org.onosproject.net.DeviceId src, org.onosproject.net.DeviceId dst, org.onosproject.net.topology.LinkWeight weight, Map<org.onosproject.net.Link,Object> riskProfile) Computes on-demand the set of shortest disjoint risk groups path pairs between source and destination devices.
Set<org.onosproject.net.DisjointPath>	getDisjointPaths(org.onosproject.net.DeviceId src, org.onosproject.net.DeviceId dst, Map<org.onosproject.net.Link,Object> riskProfile) Computes on-demand the set of shortest disjoint risk groups path pairs between source and destination devices.
org.onosproject.net.topology.TopologyGraph	getGraph() Returns the backing topology graph.
Set<org.onosproject.net.Path>	getPaths(org.onosproject.net.DeviceId src, org.onosproject.net.DeviceId dst) Returns the set of pre-computed shortest paths between source and destination devices.
Set<org.onosproject.net.Path>	getPaths(org.onosproject.net.DeviceId src, org.onosproject.net.DeviceId dst, org.onosproject.net.topology.LinkWeight weight) Computes on-demand the set of shortest paths between source and destination devices.
Set<org.onosproject.net.Path>	getPaths(org.onosproject.net.DeviceId src, org.onosproject.net.DeviceId dst, org.onosproject.net.topology.LinkWeight weight, int maxPaths) Computes on-demand the set of shortest paths between source and destination devices, the set of returned paths will be no more than, maxPaths in size.
boolean	isBroadcastPoint(org.onosproject.net.ConnectPoint connectPoint) Indicates whether the given point is part of a broadcast set.
boolean	isInfrastructure(org.onosproject.net.ConnectPoint connectPoint) Indicates whether the given point is an infrastructure link end-point.
int	linkCount()
static void	setDefaultGraphPathSearch(org.onlab.graph.GraphPathSearch<org.onosproject.net.topology.TopologyVertex,org.onosproject.net.topology.TopologyEdge> graphPathSearch) Sets the default lpath search algorighm to be used when computing paths.
static void	setDefaultLinkWeight(org.onosproject.net.topology.LinkWeight linkWeight) Sets the default link-weight to be used when computing paths.
long	time()
String	toString()

Methods inherited from class org.onosproject.net.AbstractModel

providerId

Methods inherited from class org.onosproject.net.AbstractAnnotated

annotations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.net.Provided

providerId

Constructor Detail

DefaultTopology

public DefaultTopology(org.onosproject.net.provider.ProviderId providerId,
                       org.onosproject.net.topology.GraphDescription description,
                       com.google.common.base.Function<org.onosproject.net.ConnectPoint,Boolean> broadcastFunction)

Creates a topology descriptor attributed to the specified provider.

Parameters:

providerId - identity of the provider

description - data describing the new topology

broadcastFunction - broadcast point function

DefaultTopology

public DefaultTopology(org.onosproject.net.provider.ProviderId providerId,
                       org.onosproject.net.topology.GraphDescription description)

Creates a topology descriptor attributed to the specified provider.

Parameters:

providerId - identity of the provider

description - data describing the new topology

Method Detail

setDefaultLinkWeight

public static void setDefaultLinkWeight(org.onosproject.net.topology.LinkWeight linkWeight)

Sets the default link-weight to be used when computing paths. If null is specified, the builtin default link-weight measuring hop-counts will be used.

Parameters:

linkWeight - new default link-weight

setDefaultGraphPathSearch

public static void setDefaultGraphPathSearch(org.onlab.graph.GraphPathSearch<org.onosproject.net.topology.TopologyVertex,org.onosproject.net.topology.TopologyEdge> graphPathSearch)

Sets the default lpath search algorighm to be used when computing paths. If null is specified, the builtin default Dijkstra will be used.

Parameters:

graphPathSearch - new default algorithm

time

public long time()

Specified by:

time in interface org.onosproject.net.topology.Topology

creationTime

public long creationTime()

Specified by:

creationTime in interface org.onosproject.net.topology.Topology

computeCost

public long computeCost()

Specified by:

computeCost in interface org.onosproject.net.topology.Topology

clusterCount

public int clusterCount()

Specified by:

clusterCount in interface org.onosproject.net.topology.Topology

deviceCount

public int deviceCount()

Specified by:

deviceCount in interface org.onosproject.net.topology.Topology

linkCount

public int linkCount()

Specified by:

linkCount in interface org.onosproject.net.topology.Topology

getGraph

public org.onosproject.net.topology.TopologyGraph getGraph()

Returns the backing topology graph.

Returns:

topology graph

getClusters

public Set<org.onosproject.net.topology.TopologyCluster> getClusters()

Returns the set of topology clusters.

Returns:

set of clusters

getCluster

public org.onosproject.net.topology.TopologyCluster getCluster(org.onosproject.net.topology.ClusterId clusterId)

Returns the specified topology cluster.

Parameters:

clusterId - cluster identifier

Returns:

topology cluster

getCluster

public org.onosproject.net.topology.TopologyCluster getCluster(org.onosproject.net.DeviceId deviceId)

Returns the topology cluster that contains the given device.

Parameters:

deviceId - device identifier

Returns:

topology cluster

getClusterDevices

public Set<org.onosproject.net.DeviceId> getClusterDevices(org.onosproject.net.topology.TopologyCluster cluster)

Returns the set of cluster devices.

Parameters:

cluster - topology cluster

Returns:

cluster devices

getClusterLinks

public Set<org.onosproject.net.Link> getClusterLinks(org.onosproject.net.topology.TopologyCluster cluster)

Returns the set of cluster links.

Parameters:

cluster - topology cluster

Returns:

cluster links

isInfrastructure

public boolean isInfrastructure(org.onosproject.net.ConnectPoint connectPoint)

Indicates whether the given point is an infrastructure link end-point.

Parameters:

connectPoint - connection point

Returns:

true if infrastructure

isBroadcastPoint

public boolean isBroadcastPoint(org.onosproject.net.ConnectPoint connectPoint)

Indicates whether the given point is part of a broadcast set.

Parameters:

connectPoint - connection point

Returns:

true if in broadcast set

broadcastSetSize

public int broadcastSetSize(org.onosproject.net.topology.ClusterId clusterId)

Returns the size of the cluster broadcast set.

Parameters:

clusterId - cluster identifier

Returns:

size of the cluster broadcast set

broadcastPoints

public Set<org.onosproject.net.ConnectPoint> broadcastPoints(org.onosproject.net.topology.ClusterId clusterId)

Returns the set of the cluster broadcast points.

Parameters:

clusterId - cluster identifier

Returns:

set of cluster broadcast points

getPaths

public Set<org.onosproject.net.Path> getPaths(org.onosproject.net.DeviceId src,
                                              org.onosproject.net.DeviceId dst)

Returns the set of pre-computed shortest paths between source and destination devices.

Parameters:

src - source device

dst - destination device

Returns:

set of shortest paths

getPaths

public Set<org.onosproject.net.Path> getPaths(org.onosproject.net.DeviceId src,
                                              org.onosproject.net.DeviceId dst,
                                              org.onosproject.net.topology.LinkWeight weight)

Computes on-demand the set of shortest paths between source and destination devices.

Parameters:

src - source device

dst - destination device

weight - link weight function

Returns:

set of shortest paths

getPaths

public Set<org.onosproject.net.Path> getPaths(org.onosproject.net.DeviceId src,
                                              org.onosproject.net.DeviceId dst,
                                              org.onosproject.net.topology.LinkWeight weight,
                                              int maxPaths)

Computes on-demand the set of shortest paths between source and destination devices, the set of returned paths will be no more than, maxPaths in size. The first maxPaths paths will be returned maintaining any ordering guarantees provided by the underlying (default or if no default is specified DijkstraGraphSearch) search. If returning all paths of a given length would exceed maxPaths a subset of paths of that length will be returned, which paths will be returned depends on the currently specified GraphPathSearch. See setDefaultGraphPathSearch(org.onlab.graph.GraphPathSearch<org.onosproject.net.topology.TopologyVertex, org.onosproject.net.topology.TopologyEdge>).

Parameters:

src - source device

dst - destination device

weight - link weight function

maxPaths - maximum number of paths

Returns:

set of shortest paths

getDisjointPaths

public Set<org.onosproject.net.DisjointPath> getDisjointPaths(org.onosproject.net.DeviceId src,
                                                              org.onosproject.net.DeviceId dst)

/** Returns the set of pre-computed shortest disjoint path pairs between source and destination devices.

Parameters:

src - source device

dst - destination device

Returns:

set of shortest disjoint path pairs

getDisjointPaths

public Set<org.onosproject.net.DisjointPath> getDisjointPaths(org.onosproject.net.DeviceId src,
                                                              org.onosproject.net.DeviceId dst,
                                                              org.onosproject.net.topology.LinkWeight weight)

Computes on-demand the set of shortest disjoint path pairs between source and destination devices.

Parameters:

src - source device

dst - destination device

weight - link weight function

Returns:

set of disjoint shortest path pairs

getDisjointPaths

public Set<org.onosproject.net.DisjointPath> getDisjointPaths(org.onosproject.net.DeviceId src,
                                                              org.onosproject.net.DeviceId dst,
                                                              org.onosproject.net.topology.LinkWeight weight,
                                                              Map<org.onosproject.net.Link,Object> riskProfile)

Computes on-demand the set of shortest disjoint risk groups path pairs between source and destination devices.

Parameters:

src - source device

dst - destination device

weight - edge weight object

riskProfile - map representing risk groups for each link

Returns:

set of shortest disjoint paths

getDisjointPaths

public Set<org.onosproject.net.DisjointPath> getDisjointPaths(org.onosproject.net.DeviceId src,
                                                              org.onosproject.net.DeviceId dst,
                                                              Map<org.onosproject.net.Link,Object> riskProfile)

Computes on-demand the set of shortest disjoint risk groups path pairs between source and destination devices.

Parameters:

src - source device

dst - destination device

riskProfile - map representing risk groups for each link

Returns:

set of shortest disjoint paths

toString

public String toString()

Overrides:

toString in class Object