com.hp.sdn.topo

Interface TopologyService

All Known Implementing Classes:

TopologyServiceAdapter

public interface TopologyService

Service for retrieving network topology & connectivity information between infrastructure devices.

Author:

Thomas Vachuska

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(TopologyListener listener) Registers a listener for only topology-related events.
TopologyCluster	getCluster(DeviceId deviceId) Retrieves the cluster in which the specified infrastructure devices is located.
Set<DeviceId>	getClusterDevices(TopologyCluster cluster) Returns the set of devices contained within the specified cluster.
Set<TopologyCluster>	getClusters() Returns the set of clusters in the current topology.
Set<TopologyListener>	getListeners() Returns the set of listeners for topology-related events.
Set<Path>	getPaths(DeviceId src, DeviceId dst) Returns all shortest paths between the specified source and destination infrastructure devices, measuring link edge weight using hop count.
Set<Path>	getPaths(DeviceId src, DeviceId dst, LinkWeight weight) Returns all shortest paths between the specified source and destination infrastructure devices using the supplied link edge weight function.
Topology	getTopology() Returns the current topology information.
boolean	isBroadcastAllowed(ConnectionPoint point) Indicates whether or not the specified connection point is allowed to be used for traffic broadcast.
boolean	isInfrastructure(ConnectionPoint point) Indicates whether or not the specified connection point is part of the infrastructure.
boolean	pathExists(DeviceId src, DeviceId dst) Indicates, whether a path exists or not between two infrastructure devices
void	removeListener(TopologyListener listener) Unregisters a listener from topology-related events, regardless of which topology-related events the listener was registered to receive.

Method Detail

getTopology

Topology getTopology()

Returns the current topology information.

Returns:

topology descriptor

Throws:

ServiceNotFoundException - if no topology has been computed yet

pathExists

boolean pathExists(DeviceId src,
                 DeviceId dst)

Indicates, whether a path exists or not between two infrastructure devices

Parameters:

src - id of the source device

dst - if of the destination device

Returns:

true if path exists else false

getPaths

Set<Path> getPaths(DeviceId src,
                 DeviceId dst)

Returns all shortest paths between the specified source and destination infrastructure devices, measuring link edge weight using hop count.

Parameters:

src - id of the source device

dst - if of the destination device

Returns:

set of paths or an empty set if no path exists

getPaths

Set<Path> getPaths(DeviceId src,
                 DeviceId dst,
                 LinkWeight weight)

Returns all shortest paths between the specified source and destination infrastructure devices using the supplied link edge weight function.

The LinkWeight.weight(com.hp.sdn.model.Link) may return a negative number to indicate that any path traversing that link should be considered as not viable.

Parameters:

src - id of the source device

dst - if of the destination device

weight - link edge weight function

Returns:

set of paths or an empty set if no path exists

isInfrastructure

boolean isInfrastructure(ConnectionPoint point)

Indicates whether or not the specified connection point is part of the infrastructure. This means it has been detected as an end-point of at least one direct or tunnel infrastructure link.

Parameters:

point - connection point to test

Returns:

true if the connection point belongs to the infrastructure

isBroadcastAllowed

boolean isBroadcastAllowed(ConnectionPoint point)

Indicates whether or not the specified connection point is allowed to be used for traffic broadcast.

Parameters:

point - connection point to test

Returns:

true if the connection point can be used to broadcast traffic

getClusters

Set<TopologyCluster> getClusters()

Returns the set of clusters in the current topology.

Returns:

set of topology clusters

See Also:

TopologyCluster

getCluster

TopologyCluster getCluster(DeviceId deviceId)

Retrieves the cluster in which the specified infrastructure devices is located.

Parameters:

deviceId - id of the infrastructure device

Returns:

topology cluster containing the device

getClusterDevices

Set<DeviceId> getClusterDevices(TopologyCluster cluster)

Returns the set of devices contained within the specified cluster.

Parameters:

cluster - topology cluster

Returns:

set of device ids

addListener

void addListener(TopologyListener listener)

Registers a listener for only topology-related events. This registration will override any prior listener registrations for the same object.

Parameters:

listener - the event listener

removeListener

void removeListener(TopologyListener listener)

Unregisters a listener from topology-related events, regardless of which topology-related events the listener was registered to receive.

Parameters:

listener - the event listener

Throws:

IllegalArgumentException - if the listener was not registered

getListeners

Set<TopologyListener> getListeners()

Returns the set of listeners for topology-related events.

Returns:

set of listeners