com.hp.sdn.topo

Class TopologyServiceAdapter

java.lang.Object

com.hp.sdn.topo.TopologyServiceAdapter

All Implemented Interfaces:

TopologyService

public class TopologyServiceAdapter
extends Object
implements TopologyService

An adapter for the TopologyService API, provided specifically for unit tests and implementers to use, to insulate from changes in the API.

Author:

Thomas Vachuska

Constructor Summary

Constructors

Constructor and Description
TopologyServiceAdapter()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

TopologyServiceAdapter

public TopologyServiceAdapter()

Method Detail

getTopology

public Topology getTopology()

Description copied from interface: TopologyService

Returns the current topology information.

Specified by:

getTopology in interface TopologyService

Returns:

topology descriptor

pathExists

public boolean pathExists(DeviceId src,
                 DeviceId dst)

Description copied from interface: TopologyService

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

Specified by:

pathExists in interface TopologyService

Parameters:

src - id of the source device

dst - if of the destination device

Returns:

true if path exists else false

getPaths

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

Description copied from interface: TopologyService

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

Specified by:

getPaths in interface TopologyService

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

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

Description copied from interface: TopologyService

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.

Specified by:

getPaths in interface TopologyService

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

public boolean isInfrastructure(ConnectionPoint point)

Description copied from interface: TopologyService

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.

Specified by:

isInfrastructure in interface TopologyService

Parameters:

point - connection point to test

Returns:

true if the connection point belongs to the infrastructure

isBroadcastAllowed

public boolean isBroadcastAllowed(ConnectionPoint point)

Description copied from interface: TopologyService

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

Specified by:

isBroadcastAllowed in interface TopologyService

Parameters:

point - connection point to test

Returns:

true if the connection point can be used to broadcast traffic

getClusters

public Set<TopologyCluster> getClusters()

Description copied from interface: TopologyService

Returns the set of clusters in the current topology.

Specified by:

getClusters in interface TopologyService

Returns:

set of topology clusters

See Also:

TopologyCluster

getCluster

public TopologyCluster getCluster(DeviceId deviceId)

Description copied from interface: TopologyService

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

Specified by:

getCluster in interface TopologyService

Parameters:

deviceId - id of the infrastructure device

Returns:

topology cluster containing the device

getClusterDevices

public Set<DeviceId> getClusterDevices(TopologyCluster cluster)

Description copied from interface: TopologyService

Returns the set of devices contained within the specified cluster.

Specified by:

getClusterDevices in interface TopologyService

Parameters:

cluster - topology cluster

Returns:

set of device ids

addListener

public void addListener(TopologyListener listener)

Description copied from interface: TopologyService

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

Specified by:

addListener in interface TopologyService

Parameters:

listener - the event listener

removeListener

public void removeListener(TopologyListener listener)

Description copied from interface: TopologyService

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

Specified by:

removeListener in interface TopologyService

Parameters:

listener - the event listener

getListeners

public Set<TopologyListener> getListeners()

Description copied from interface: TopologyService

Returns the set of listeners for topology-related events.

Specified by:

getListeners in interface TopologyService

Returns:

set of listeners