org.onosproject.incubator.net.virtual

Interface VirtualNetworkService

All Superinterfaces:

ListenerService<VirtualNetworkEvent,VirtualNetworkListener>

All Known Subinterfaces:

VirtualNetworkAdminService

@Beta
public interface VirtualNetworkService
extends ListenerService<VirtualNetworkEvent,VirtualNetworkListener>

Service for querying virtual network inventory.

Field Summary

Fields

Modifier and Type	Field and Description
static String	VIRTUAL_NETWORK_TOPIC The topic used for obtaining globally unique ids.

Method Summary

Modifier and Type	Method and Description
<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<DeviceId>	getPhysicalDevices(NetworkId networkId, DeviceId deviceId) Returns list of physical device identifier mapping with the virtual device in the specified network.
ServiceDirectory	getServiceDirectory() Returns service directory.
TenantId	getTenantId(NetworkId networkId) Returns tenantId for specified virtual network id.
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.
VirtualNetwork	getVirtualNetwork(NetworkId networkId) Returns the virtual network matching the network identifier.
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, DeviceId deviceId) Returns list of all virtual ports of the specified device.

Methods inherited from interface org.onosproject.event.ListenerService

addListener, removeListener

Field Detail

VIRTUAL_NETWORK_TOPIC

static final String VIRTUAL_NETWORK_TOPIC

The topic used for obtaining globally unique ids.

See Also:

Constant Field Values

Method Detail

getVirtualNetworks

Set<VirtualNetwork> getVirtualNetworks(TenantId tenantId)

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

Parameters:

tenantId - tenant identifier

Returns:

collection of networks

Throws:

ItemNotFoundException - if no such network found

getVirtualNetwork

VirtualNetwork getVirtualNetwork(NetworkId networkId)

Returns the virtual network matching the network identifier.

Parameters:

networkId - virtual network identifier

Returns:

virtual network instance

Throws:

ItemNotFoundException - if no such network found

getTenantId

TenantId getTenantId(NetworkId networkId)

Returns tenantId for specified virtual network id.

Parameters:

networkId - virtual network identifier

Returns:

tenantId tenant identifier

Throws:

ItemNotFoundException - if no such network found

getVirtualDevices

Set<VirtualDevice> getVirtualDevices(NetworkId networkId)

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

Parameters:

networkId - network identifier

Returns:

collection of devices

Throws:

ItemNotFoundException - if no such network found

getVirtualHosts

Set<VirtualHost> getVirtualHosts(NetworkId networkId)

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

Parameters:

networkId - network identifier

Returns:

collection of hosts

Throws:

ItemNotFoundException - if no such network found

getVirtualLinks

Set<VirtualLink> getVirtualLinks(NetworkId networkId)

Returns collection of all virtual links in the specified network.

Parameters:

networkId - network identifier

Returns:

collection of links

Throws:

ItemNotFoundException - if no such network found

getVirtualPorts

Set<VirtualPort> getVirtualPorts(NetworkId networkId,
                                 DeviceId deviceId)

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.

Parameters:

networkId - network identifier

deviceId - device identifier

Returns:

list of ports

Throws:

ItemNotFoundException - if no such network found

getPhysicalDevices

Set<DeviceId> getPhysicalDevices(NetworkId networkId,
                                 DeviceId deviceId)

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

Parameters:

networkId - network identifier

deviceId - the virtual device identifier

Returns:

collection of the specified device's identifier

get

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

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
• MastershipService
• MastershipAdminService
• MastershipTermService

Type Parameters:

T - type of service

Parameters:

networkId - network identifier

serviceClass - service class

Returns:

implementation class

Throws:

ItemNotFoundException - if no such network found

ServiceNotFoundException - if no implementation found

getServiceDirectory

ServiceDirectory getServiceDirectory()

Returns service directory.

Returns:

a service directory

getVirtualNetworkApplicationId

ApplicationId getVirtualNetworkApplicationId(NetworkId networkId)

Returns the application identifier for a virtual network.

Parameters:

networkId - network identifier

Returns:

an representative application identifier for a virtual network