org.onosproject.incubator.net.virtual.impl

Class VirtualNetworkManager

java.lang.Object

org.onosproject.net.provider.AbstractProviderRegistry<P,S>

org.onosproject.net.provider.AbstractListenerProviderRegistry<VirtualNetworkEvent,VirtualNetworkListener,VirtualNetworkProvider,VirtualNetworkProviderService>

org.onosproject.incubator.net.virtual.impl.VirtualNetworkManager

All Implemented Interfaces:

org.onosproject.event.ListenerService<VirtualNetworkEvent,VirtualNetworkListener>, VirtualNetworkProviderRegistry, VirtualNetworkAdminService, VirtualNetworkService, org.onosproject.net.provider.ProviderRegistry<VirtualNetworkProvider,VirtualNetworkProviderService>

@Service
public class VirtualNetworkManager
extends org.onosproject.net.provider.AbstractListenerProviderRegistry<VirtualNetworkEvent,VirtualNetworkListener,VirtualNetworkProvider,VirtualNetworkProviderService>
implements VirtualNetworkService, VirtualNetworkAdminService, VirtualNetworkProviderRegistry

Implementation of the virtual network service.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.onosproject.core.CoreService	coreService
protected org.onosproject.net.intent.IntentService	intentService
protected VirtualNetworkStore	store

Fields inherited from class org.onosproject.net.provider.AbstractListenerProviderRegistry

eventDispatcher, listenerRegistry

Fields inherited from interface org.onosproject.incubator.net.virtual.VirtualNetworkService

VIRTUAL_NETWORK_TOPIC

Constructor Summary

Constructors

Constructor and Description
VirtualNetworkManager()

Method Summary

Modifier and Type	Method and Description
void	activate()
void	bindVirtualPort(NetworkId networkId, org.onosproject.net.DeviceId deviceId, org.onosproject.net.PortNumber portNumber, org.onosproject.net.ConnectPoint realizedBy) Binds an existing virtual port on the specified device.
protected VirtualNetworkProviderService	createProviderService(VirtualNetworkProvider provider)
VirtualDevice	createVirtualDevice(NetworkId networkId, org.onosproject.net.DeviceId deviceId) Creates a new virtual device within the specified network.
VirtualHost	createVirtualHost(NetworkId networkId, org.onosproject.net.HostId hostId, org.onlab.packet.MacAddress mac, org.onlab.packet.VlanId vlan, org.onosproject.net.HostLocation location, Set<org.onlab.packet.IpAddress> ips) Creates a new virtual host within the specified network.
VirtualLink	createVirtualLink(NetworkId networkId, org.onosproject.net.ConnectPoint src, org.onosproject.net.ConnectPoint dst) Creates a new virtual link within the specified network.
VirtualNetwork	createVirtualNetwork(TenantId tenantId) Creates a new virtual network for the specified tenant.
VirtualPort	createVirtualPort(NetworkId networkId, org.onosproject.net.DeviceId deviceId, org.onosproject.net.PortNumber portNumber, org.onosproject.net.ConnectPoint realizedBy) Creates a new virtual port on the specified device.
void	deactivate()
<T> T	get(NetworkId networkId, Class<T> serviceClass) Returns implementation of the specified service class for operating in the context of the given network.
Set<org.onosproject.net.DeviceId>	getPhysicalDevices(NetworkId networkId, VirtualDevice virtualDevice) Returns list of physical device identifier mapping with the virtual device in the specified network.
org.onlab.osgi.ServiceDirectory	getServiceDirectory() Returns service directory.
Set<TenantId>	getTenantIds() Returns the set of tenant identifiers known to the system.
Set<VirtualDevice>	getVirtualDevices(NetworkId networkId) Returns a collection of all virtual devices in the specified network.
Set<VirtualHost>	getVirtualHosts(NetworkId networkId) Returns a collection of all virtual hosts in the specified network.
Set<VirtualLink>	getVirtualLinks(NetworkId networkId) Returns collection of all virtual links in the specified network.
org.onosproject.core.ApplicationId	getVirtualNetworkApplicationId(NetworkId networkId) Returns the application identifier for a virtual network.
Set<VirtualNetwork>	getVirtualNetworks(TenantId tenantId) Returns a collection of all virtual networks created on behalf of the specified tenant.
Set<VirtualPort>	getVirtualPorts(NetworkId networkId, org.onosproject.net.DeviceId deviceId) Returns list of all virtual ports of the specified device.
void	registerTenantId(TenantId tenantId) Registers the specified, externally generated tenant identifier.
void	removeVirtualDevice(NetworkId networkId, org.onosproject.net.DeviceId deviceId) Removes the specified virtual device and all its ports and affiliated links.
void	removeVirtualHost(NetworkId networkId, org.onosproject.net.HostId hostId) Removes the specified virtual host.
void	removeVirtualLink(NetworkId networkId, org.onosproject.net.ConnectPoint src, org.onosproject.net.ConnectPoint dst) Removes the specified virtual link.
void	removeVirtualNetwork(NetworkId networkId) Removes the specified virtual network and all its devices and links.
void	removeVirtualPort(NetworkId networkId, org.onosproject.net.DeviceId deviceId, org.onosproject.net.PortNumber portNumber) Removes the specified virtual port.
void	setIntentService(org.onosproject.net.intent.IntentService intentService) Only used for Junit test methods outside of this package.
void	setStore(VirtualNetworkStore store) Only used for Junit test methods outside of this package.
void	unregisterTenantId(TenantId tenantId) Unregisters the specified, externally generated tenant identifier.

Methods inherited from class org.onosproject.net.provider.AbstractListenerProviderRegistry

addListener, bindEventDispatcher, post, removeListener, unbindEventDispatcher

Methods inherited from class org.onosproject.net.provider.AbstractProviderRegistry

defaultProvider, getProvider, getProvider, getProvider, getProviders, register, unregister

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.event.ListenerService

addListener, removeListener

Methods inherited from interface org.onosproject.net.provider.ProviderRegistry

getProviders, register, unregister

Field Detail

store

@Reference(cardinality=MANDATORY_UNARY)
protected VirtualNetworkStore store

intentService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.net.intent.IntentService intentService

coreService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.core.CoreService coreService

Constructor Detail

VirtualNetworkManager

public VirtualNetworkManager()

Method Detail

setStore

public void setStore(VirtualNetworkStore store)

Only used for Junit test methods outside of this package.

Parameters:

store - virtual network store

setIntentService

public void setIntentService(org.onosproject.net.intent.IntentService intentService)

Only used for Junit test methods outside of this package.

Parameters:

intentService - intent service

activate

@Activate
public void activate()

deactivate

@Deactivate
public void deactivate()

registerTenantId

public void registerTenantId(TenantId tenantId)

Description copied from interface: VirtualNetworkAdminService

Registers the specified, externally generated tenant identifier.

Specified by:

registerTenantId in interface VirtualNetworkAdminService

Parameters:

tenantId - tenant identifier

unregisterTenantId

public void unregisterTenantId(TenantId tenantId)

Description copied from interface: VirtualNetworkAdminService

Unregisters the specified, externally generated tenant identifier.

Specified by:

unregisterTenantId in interface VirtualNetworkAdminService

Parameters:

tenantId - tenant identifier

getTenantIds

public Set<TenantId> getTenantIds()

Description copied from interface: VirtualNetworkAdminService

Returns the set of tenant identifiers known to the system.

Specified by:

getTenantIds in interface VirtualNetworkAdminService

Returns:

set of known tenant identifiers

createVirtualNetwork

public VirtualNetwork createVirtualNetwork(TenantId tenantId)

Description copied from interface: VirtualNetworkAdminService

Creates a new virtual network for the specified tenant.

Specified by:

createVirtualNetwork in interface VirtualNetworkAdminService

Parameters:

tenantId - tenant identifier

Returns:

newly created virtual network

removeVirtualNetwork

public void removeVirtualNetwork(NetworkId networkId)

Description copied from interface: VirtualNetworkAdminService

Removes the specified virtual network and all its devices and links.

Specified by:

removeVirtualNetwork in interface VirtualNetworkAdminService

Parameters:

networkId - network identifier

createVirtualDevice

public VirtualDevice createVirtualDevice(NetworkId networkId,
                                         org.onosproject.net.DeviceId deviceId)

Description copied from interface: VirtualNetworkAdminService

Creates a new virtual device within the specified network. The device id must be unique within the bounds of the network.

Specified by:

createVirtualDevice in interface VirtualNetworkAdminService

Parameters:

networkId - network identifier

deviceId - device identifier

Returns:

newly created virtual device

removeVirtualDevice

public void removeVirtualDevice(NetworkId networkId,
                                org.onosproject.net.DeviceId deviceId)

Description copied from interface: VirtualNetworkAdminService

Removes the specified virtual device and all its ports and affiliated links.

Specified by:

removeVirtualDevice in interface VirtualNetworkAdminService

Parameters:

networkId - network identifier

deviceId - device identifier

createVirtualHost

public VirtualHost createVirtualHost(NetworkId networkId,
                                     org.onosproject.net.HostId hostId,
                                     org.onlab.packet.MacAddress mac,
                                     org.onlab.packet.VlanId vlan,
                                     org.onosproject.net.HostLocation location,
                                     Set<org.onlab.packet.IpAddress> ips)

Description copied from interface: VirtualNetworkAdminService

Creates a new virtual host within the specified network. The host id must be unique within the bounds of the network.

Specified by:

createVirtualHost in interface VirtualNetworkAdminService

Parameters:

networkId - network identifier

hostId - host identifier

mac - mac address

vlan - vlan identifier

location - host location

ips - set of ip addresses

Returns:

newly created virtual host

removeVirtualHost

public void removeVirtualHost(NetworkId networkId,
                              org.onosproject.net.HostId hostId)

Description copied from interface: VirtualNetworkAdminService

Removes the specified virtual host.

Specified by:

removeVirtualHost in interface VirtualNetworkAdminService

Parameters:

networkId - network identifier

hostId - host identifier

createVirtualLink

public VirtualLink createVirtualLink(NetworkId networkId,
                                     org.onosproject.net.ConnectPoint src,
                                     org.onosproject.net.ConnectPoint dst)

Description copied from interface: VirtualNetworkAdminService

Creates a new virtual link within the specified network.

Specified by:

createVirtualLink in interface VirtualNetworkAdminService

Parameters:

networkId - network identifier

src - source connection point

dst - destination connection point

Returns:

newly created virtual link

removeVirtualLink

public void removeVirtualLink(NetworkId networkId,
                              org.onosproject.net.ConnectPoint src,
                              org.onosproject.net.ConnectPoint dst)

Description copied from interface: VirtualNetworkAdminService

Removes the specified virtual link.

Specified by:

removeVirtualLink in interface VirtualNetworkAdminService

Parameters:

networkId - network identifier

src - source connection point

dst - destination connection point

createVirtualPort

public VirtualPort createVirtualPort(NetworkId networkId,
                                     org.onosproject.net.DeviceId deviceId,
                                     org.onosproject.net.PortNumber portNumber,
                                     org.onosproject.net.ConnectPoint realizedBy)

Description copied from interface: VirtualNetworkAdminService

Creates a new virtual port on the specified device.

Specified by:

createVirtualPort in interface VirtualNetworkAdminService

Parameters:

networkId - network identifier

deviceId - virtual device identifier

portNumber - virtual port number

realizedBy - underlying physical port using which this virtual port is realized

Returns:

newly created port

bindVirtualPort

public void bindVirtualPort(NetworkId networkId,
                            org.onosproject.net.DeviceId deviceId,
                            org.onosproject.net.PortNumber portNumber,
                            org.onosproject.net.ConnectPoint realizedBy)

Description copied from interface: VirtualNetworkAdminService

Binds an existing virtual port on the specified device.

Specified by:

bindVirtualPort in interface VirtualNetworkAdminService

Parameters:

networkId - network identifier

deviceId - virtual device identifier

portNumber - virtual port number

realizedBy - underlying physical port using which this virtual port is realized

removeVirtualPort

public void removeVirtualPort(NetworkId networkId,
                              org.onosproject.net.DeviceId deviceId,
                              org.onosproject.net.PortNumber portNumber)

Description copied from interface: VirtualNetworkAdminService

Removes the specified virtual port.

Specified by:

removeVirtualPort in interface VirtualNetworkAdminService

Parameters:

networkId - network identifier

deviceId - device identifier

portNumber - port number

getServiceDirectory

public org.onlab.osgi.ServiceDirectory getServiceDirectory()

Description copied from interface: VirtualNetworkService

Returns service directory.

Specified by:

getServiceDirectory in interface VirtualNetworkService

Returns:

a service directory

getVirtualNetworks

public Set<VirtualNetwork> getVirtualNetworks(TenantId tenantId)

Description copied from interface: VirtualNetworkService

Returns a collection of all virtual networks created on behalf of the specified tenant.

Specified by:

getVirtualNetworks in interface VirtualNetworkService

Parameters:

tenantId - tenant identifier

Returns:

collection of networks

getVirtualDevices

public Set<VirtualDevice> getVirtualDevices(NetworkId networkId)

Description copied from interface: VirtualNetworkService

Returns a collection of all virtual devices in the specified network.

Specified by:

getVirtualDevices in interface VirtualNetworkService

Parameters:

networkId - network identifier

Returns:

collection of devices

getVirtualHosts

public Set<VirtualHost> getVirtualHosts(NetworkId networkId)

Description copied from interface: VirtualNetworkService

Returns a collection of all virtual hosts in the specified network.

Specified by:

getVirtualHosts in interface VirtualNetworkService

Parameters:

networkId - network identifier

Returns:

collection of hosts

getVirtualLinks

public Set<VirtualLink> getVirtualLinks(NetworkId networkId)

Description copied from interface: VirtualNetworkService

Returns collection of all virtual links in the specified network.

Specified by:

getVirtualLinks in interface VirtualNetworkService

Parameters:

networkId - network identifier

Returns:

collection of links

getVirtualPorts

public Set<VirtualPort> getVirtualPorts(NetworkId networkId,
                                        org.onosproject.net.DeviceId deviceId)

Description copied from interface: VirtualNetworkService

Returns list of all virtual ports of the specified device. If the device identifier is null then all of the virtual ports in the specified network will be returned.

Specified by:

getVirtualPorts in interface VirtualNetworkService

Parameters:

networkId - network identifier

deviceId - device identifier

Returns:

list of ports

getPhysicalDevices

public Set<org.onosproject.net.DeviceId> getPhysicalDevices(NetworkId networkId,
                                                            VirtualDevice virtualDevice)

Description copied from interface: VirtualNetworkService

Returns list of physical device identifier mapping with the virtual device in the specified network. The physical devices are specified by port mapping mechanism.

Specified by:

getPhysicalDevices in interface VirtualNetworkService

Parameters:

networkId - network identifier

virtualDevice - the virtual device

Returns:

collection of the specified device's identifier

get

public <T> T get(NetworkId networkId,
                 Class<T> serviceClass)

Description copied from interface: VirtualNetworkService

Returns implementation of the specified service class for operating in the context of the given network.

The following services will be available:

• DeviceService
• LinkService
• HostService
• TopologyService
• PathService
• PacketService
• FlowRuleService
• FlowObjectiveService
• IntentService

Specified by:

get in interface VirtualNetworkService

Type Parameters:

T - type of service

Parameters:

networkId - network identifier

serviceClass - service class

Returns:

implementation class

getVirtualNetworkApplicationId

public org.onosproject.core.ApplicationId getVirtualNetworkApplicationId(NetworkId networkId)

Description copied from interface: VirtualNetworkService

Returns the application identifier for a virtual network.

Specified by:

getVirtualNetworkApplicationId in interface VirtualNetworkService

Parameters:

networkId - network identifier

Returns:

an representative application identifier for a virtual network

createProviderService

protected VirtualNetworkProviderService createProviderService(VirtualNetworkProvider provider)

Specified by:

createProviderService in class org.onosproject.net.provider.AbstractProviderRegistry<VirtualNetworkProvider,VirtualNetworkProviderService>