org.onosproject.provider.nil

Class TopologySimulator

java.lang.Object

org.onosproject.provider.nil.TopologySimulator

Direct Known Subclasses:

ConfiguredTopologySimulator, CustomTopologySimulator, GridTopologySimulator, LinearTopologySimulator, MeshTopologySimulator, SpineLeafTopologySimulator, TreeTopologySimulator

public abstract class TopologySimulator
extends Object

Abstraction of a provider capable to simulate some network topology.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.onosproject.cluster.ClusterService	clusterService
protected int	deviceCount
protected List<org.onosproject.net.DeviceId>	deviceIds
protected CountDownLatch	deviceLatch
protected org.onosproject.net.device.DeviceProviderService	deviceProviderService
protected org.onosproject.net.device.DeviceAdminService	deviceService
protected org.onlab.osgi.ServiceDirectory	directory
protected int	hostCount
protected org.onosproject.net.host.HostProviderService	hostProviderService
protected org.onosproject.net.host.HostService	hostService
protected int	infrastructurePorts
protected org.onosproject.net.link.LinkProviderService	linkProviderService
protected org.onosproject.net.link.LinkService	linkService
protected org.onosproject.cluster.NodeId	localNode
protected org.slf4j.Logger	log
protected org.onosproject.mastership.MastershipService	mastershipService
protected int	maxWaitSeconds
protected String[]	topoShape

Constructor Summary

Constructors

Constructor and Description
TopologySimulator()

Method Summary

Modifier and Type	Method and Description
protected List<org.onosproject.net.device.PortDescription>	buildPorts(int portCount) Generates a list of a configured number of ports.
boolean	contains(org.onosproject.net.DeviceId deviceId) Indicates whether or not the simulation deeps the device as available.
void	createDevice(org.onosproject.net.DeviceId id, int chassisId) Creates simulated device.
void	createDevice(org.onosproject.net.DeviceId id, int chassisId, org.onosproject.net.Device.Type type, int portCount) Creates simulated device.
protected void	createDevice(int i) Creates simulated device and adds its id to the list of devices ids.
protected void	createDevices() Creates simulated devices.
protected abstract void	createHosts() Creates simulated hosts.
void	createHosts(org.onosproject.net.DeviceId deviceId, int portOffset) Creates simularted hosts for the specified device.
void	createLink(org.onosproject.net.ConnectPoint one, org.onosproject.net.ConnectPoint two) Creates simulated link between two connection points.
void	createLink(org.onosproject.net.ConnectPoint one, org.onosproject.net.ConnectPoint two, org.onosproject.net.Link.Type type, boolean isBidirectional) Creates simulated link between two connection points.
void	createLink(int i, int j, int pi, int pj) Creates simulated link between two devices.
protected abstract void	createLinks() Creates simulated links.
protected void	init(String topoShape, int deviceCount, int hostCount, org.onlab.osgi.ServiceDirectory directory, org.onosproject.net.device.DeviceProviderService deviceProviderService, org.onosproject.net.host.HostProviderService hostProviderService, org.onosproject.net.link.LinkProviderService linkProviderService) Initializes a new topology simulator with access to the specified service directory and various provider services.
protected void	prepareForDeviceEvents(int count) Prepares to count device added/available/removed events.
protected void	processTopoShape(String shape) Processes the topology shape specifier.
protected void	removeDevices() Removes any devices previously advertised by this provider.
protected void	removeHosts() Removes any hosts previously advertised by this provider.
protected void	removeLinks() Removes any links previously advertised by this provider.
void	setUpTopology() Sets up network topology simulation.
void	tearDownTopology() Tears down network topology simulation.
protected void	waitForDeviceEvents() Waits for all expected device added/available/removed events.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.slf4j.Logger log

topoShape

protected String[] topoShape

deviceCount

protected int deviceCount

hostCount

protected int hostCount

directory

protected org.onlab.osgi.ServiceDirectory directory

localNode

protected org.onosproject.cluster.NodeId localNode

clusterService

protected org.onosproject.cluster.ClusterService clusterService

mastershipService

protected org.onosproject.mastership.MastershipService mastershipService

deviceService

protected org.onosproject.net.device.DeviceAdminService deviceService

hostService

protected org.onosproject.net.host.HostService hostService

linkService

protected org.onosproject.net.link.LinkService linkService

deviceProviderService

protected org.onosproject.net.device.DeviceProviderService deviceProviderService

hostProviderService

protected org.onosproject.net.host.HostProviderService hostProviderService

linkProviderService

protected org.onosproject.net.link.LinkProviderService linkProviderService

maxWaitSeconds

protected int maxWaitSeconds

infrastructurePorts

protected int infrastructurePorts

deviceLatch

protected CountDownLatch deviceLatch

deviceIds

protected final List<org.onosproject.net.DeviceId> deviceIds

Constructor Detail

TopologySimulator

public TopologySimulator()

Method Detail

init

protected void init(String topoShape,
                    int deviceCount,
                    int hostCount,
                    org.onlab.osgi.ServiceDirectory directory,
                    org.onosproject.net.device.DeviceProviderService deviceProviderService,
                    org.onosproject.net.host.HostProviderService hostProviderService,
                    org.onosproject.net.link.LinkProviderService linkProviderService)

Initializes a new topology simulator with access to the specified service directory and various provider services.

Parameters:

topoShape - topology shape specifier

deviceCount - number of devices in the topology

hostCount - number of hosts per device

directory - service directory

deviceProviderService - device provider service

hostProviderService - host provider service

linkProviderService - link provider service

processTopoShape

protected void processTopoShape(String shape)

Processes the topology shape specifier.

Parameters:

shape - topology shape specifier

setUpTopology

public void setUpTopology()

Sets up network topology simulation.

createDevices

protected void createDevices()

Creates simulated devices.

createLinks

protected abstract void createLinks()

Creates simulated links.

createHosts

protected abstract void createHosts()

Creates simulated hosts.

createDevice

protected void createDevice(int i)

Creates simulated device and adds its id to the list of devices ids.

Parameters:

i - index of the device id in the list.

createDevice

public void createDevice(org.onosproject.net.DeviceId id,
                         int chassisId)

Creates simulated device.

Parameters:

id - device identifier

chassisId - chassis identifier number

createDevice

public void createDevice(org.onosproject.net.DeviceId id,
                         int chassisId,
                         org.onosproject.net.Device.Type type,
                         int portCount)

Creates simulated device.

Parameters:

id - device identifier

chassisId - chassis identifier number

type - device type

portCount - number of device ports

createLink

public void createLink(int i,
                       int j,
                       int pi,
                       int pj)

Creates simulated link between two devices.

Parameters:

i - index of one simulated device

j - index of another simulated device

pi - port number of i-th device

pj - port number of j-th device

createLink

public void createLink(org.onosproject.net.ConnectPoint one,
                       org.onosproject.net.ConnectPoint two)

Creates simulated link between two connection points.

Parameters:

one - one connection point

two - another connection point

createLink

public void createLink(org.onosproject.net.ConnectPoint one,
                       org.onosproject.net.ConnectPoint two,
                       org.onosproject.net.Link.Type type,
                       boolean isBidirectional)

Creates simulated link between two connection points.

Parameters:

one - one connection point

two - another connection point

type - link type

isBidirectional - true if link is bidirectional

createHosts

public void createHosts(org.onosproject.net.DeviceId deviceId,
                        int portOffset)

Creates simularted hosts for the specified device.

Parameters:

deviceId - device identifier

portOffset - port offset where to start attaching hosts

prepareForDeviceEvents

protected void prepareForDeviceEvents(int count)

Prepares to count device added/available/removed events.

Parameters:

count - number of events to count

waitForDeviceEvents

protected void waitForDeviceEvents()

Waits for all expected device added/available/removed events.

tearDownTopology

public void tearDownTopology()

Tears down network topology simulation.

removeHosts

protected void removeHosts()

Removes any hosts previously advertised by this provider.

removeLinks

protected void removeLinks()

Removes any links previously advertised by this provider.

removeDevices

protected void removeDevices()

Removes any devices previously advertised by this provider.

buildPorts

protected List<org.onosproject.net.device.PortDescription> buildPorts(int portCount)

Generates a list of a configured number of ports.

Parameters:

portCount - number of ports

Returns:

list of ports

contains

public boolean contains(org.onosproject.net.DeviceId deviceId)

Indicates whether or not the simulation deeps the device as available.

Parameters:

deviceId - device identifier

Returns:

true if device is known