api.topostore

Class TopoStore

java.lang.Object

api.topostore.TopoStore

All Implemented Interfaces:

TopoStoreInterface

Direct Known Subclasses:

OdlTopoStore, OnosTopoStore

public abstract class TopoStore
extends java.lang.Object
implements TopoStoreInterface

Store topology information and implements topology store api functions.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<TopoVertex>	topoVertices

Constructor Summary

Constructors

Constructor and Description
TopoStore()

Method Summary

Modifier and Type	Method and Description
void	addEdge(TopoEdge topoEdge) Adds an edge to list of topology links and topology graph.
void	addHost(TopoHost topoHost) Adds a host to the list of topology hosts.
void	addSwitch(TopoSwitch topoSwitch) Adda network device (i.e.
boolean	checkHostExistenceWithIP(org.onlab.packet.Ip4Address ip4Address) Checks existence of a host based on its IPv4 address.
boolean	checkHostExistenceWithMac(org.onlab.packet.MacAddress macAddress) Checks existence of a host based on its MAC address.
void	clear()
void	fetchTopo()
org.jgrapht.Graph<TopoVertex,TopoEdge>	getGraph() Returns topology graph.
java.util.Set<TopoHost>	getHosts() Returns a list of hosts in the network topology.
java.util.List<TopoEdge>	getShortestPath(java.lang.String srcDevice, java.lang.String dstDevice) Returns shortest path between two end-points.
java.util.Set<TopoSwitch>	getSwitches() Returns a list of network switches in the network topology.
java.util.Set<TopoEdge>	getTopoEdges()
TopoHost	getTopoHostByIP(org.onlab.packet.Ip4Address ipAddress) Finds a host in the network topology based on a given IPv4 address.
TopoHost	getTopoHostByMac(org.onlab.packet.MacAddress macAddress) Finds a host based on a given Mac address.
void	printDevices() Prints list of network devices in the current network topology.
void	printHosts() Prints list of topology hosts in the current network topology.
void	printLinks() Prints list of topology links in the current network topology.
void	printPath(java.util.List<TopoEdge> path) Prints an end-to-end path between two end points.
void	printTopo() Prints topology information including list of devices, hosts, and links.

Methods inherited from class java.lang.Object

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

Methods inherited from interface api.topostore.TopoStoreInterface

updateTopo

Field Detail

topoVertices

protected java.util.Set<TopoVertex> topoVertices

Constructor Detail

TopoStore

public TopoStore()

Method Detail

clear

public void clear()

fetchTopo

public void fetchTopo()

Specified by:

fetchTopo in interface TopoStoreInterface

addSwitch

public void addSwitch(TopoSwitch topoSwitch)

Adda network device (i.e. a switch) to the topo store.

Parameters:

topoSwitch - a network switch

addEdge

public void addEdge(TopoEdge topoEdge)

Adds an edge to list of topology links and topology graph.

Parameters:

topoEdge -

addHost

public void addHost(TopoHost topoHost)

Adds a host to the list of topology hosts.

Parameters:

topoHost - A TopoHost instance.

getSwitches

public java.util.Set<TopoSwitch> getSwitches()

Returns a list of network switches in the network topology.

Specified by:

getSwitches in interface TopoStoreInterface

Returns:

list of switches.

getHosts

public java.util.Set<TopoHost> getHosts()

Returns a list of hosts in the network topology.

Specified by:

getHosts in interface TopoStoreInterface

Returns:

list of hosts.

getTopoHostByMac

public TopoHost getTopoHostByMac(org.onlab.packet.MacAddress macAddress)

Finds a host based on a given Mac address.

Parameters:

macAddress - macAddress of given host.

Returns:

a TopoHost.

checkHostExistenceWithIP

public boolean checkHostExistenceWithIP(org.onlab.packet.Ip4Address ip4Address)

Checks existence of a host based on its IPv4 address.

Parameters:

ip4Address - IPv4 address of a host.

Returns:

a boolean

checkHostExistenceWithMac

public boolean checkHostExistenceWithMac(org.onlab.packet.MacAddress macAddress)

Checks existence of a host based on its MAC address.

Parameters:

macAddress - MAC address of a given host.

Returns:

a boolean

getTopoHostByIP

public TopoHost getTopoHostByIP(org.onlab.packet.Ip4Address ipAddress)

Finds a host in the network topology based on a given IPv4 address.

Parameters:

ipAddress - IPv4 address of a host.

Returns:

a TopoHost instance.

getGraph

public org.jgrapht.Graph<TopoVertex,TopoEdge> getGraph()

Returns topology graph.

Specified by:

getGraph in interface TopoStoreInterface

Returns:

topology graph.

getTopoEdges

public java.util.Set<TopoEdge> getTopoEdges()

getShortestPath

public java.util.List<TopoEdge> getShortestPath(java.lang.String srcDevice,
                                                java.lang.String dstDevice)

Returns shortest path between two end-points.

Parameters:

srcDevice - source end point.

dstDevice - destination end point.

Returns:

a shortest path.

printPath

public void printPath(java.util.List<TopoEdge> path)

Prints an end-to-end path between two end points.

Parameters:

path - a path.

printTopo

public void printTopo()

Prints topology information including list of devices, hosts, and links.

Specified by:

printTopo in interface TopoStoreInterface

printLinks

public void printLinks()

Prints list of topology links in the current network topology.

printHosts

public void printHosts()

Prints list of topology hosts in the current network topology.

printDevices

public void printDevices()

Prints list of network devices in the current network topology.