org.onosproject.incubator.net.virtual

Interface VirtualNetworkStore

All Superinterfaces:

Store<VirtualNetworkEvent,VirtualNetworkStoreDelegate>

public interface VirtualNetworkStore
extends Store<VirtualNetworkEvent,VirtualNetworkStoreDelegate>

Mechanism for distributing and storing virtual network model information.

Method Summary

Modifier and Type	Method and Description
VirtualDevice	addDevice(NetworkId networkId, DeviceId deviceId) Adds a new virtual device to the store.
VirtualHost	addHost(NetworkId networkId, HostId hostId, MacAddress mac, VlanId vlan, HostLocation location, java.util.Set<IpAddress> ips) Adds a new virtual host to the store.
VirtualLink	addLink(NetworkId networkId, ConnectPoint src, ConnectPoint dst, Link.State state, TunnelId realizedBy) Adds a new virtual link.
VirtualNetwork	addNetwork(TenantId tenantId) Adds a new virtual network for the specified tenant to the store.
VirtualPort	addPort(NetworkId networkId, DeviceId deviceId, PortNumber portNumber, ConnectPoint realizedBy) Adds a new virtual port to the network.
void	addTenantId(TenantId tenantId) Adds a new tenant ID to the store.
void	addTunnelId(Intent intent, TunnelId tunnelId) Deprecated. in Kingfisher Release (1.10)
void	bindPort(NetworkId networkId, DeviceId deviceId, PortNumber portNumber, ConnectPoint realizedBy) Binds an existing virtual port to the network.
java.util.Set<VirtualDevice>	getDevices(NetworkId networkId) Returns the list of devices in the specified virtual network.
java.util.Set<VirtualHost>	getHosts(NetworkId networkId) Returns the list of hosts in the specified virtual network.
VirtualLink	getLink(NetworkId networkId, ConnectPoint src, ConnectPoint dst) Returns the virtual link matching the network identifier, source connect point, and destination connect point.
java.util.Set<VirtualLink>	getLinks(NetworkId networkId) Returns the list of virtual links in the specified virtual network.
VirtualNetwork	getNetwork(NetworkId networkId) Returns the virtual network for the given network identifier.
java.util.Set<VirtualNetwork>	getNetworks(TenantId tenantId) Returns the list of networks.
java.util.Set<VirtualPort>	getPorts(NetworkId networkId, DeviceId deviceId) Returns the list of ports of the specified virtual device.
java.util.Set<TenantId>	getTenantIds() Returns set of registered tenant IDs.
java.util.Set<TunnelId>	getTunnelIds(Intent intent) Deprecated. in Kingfisher Release (1.10)
void	removeDevice(NetworkId networkId, DeviceId deviceId) Removes the specified virtual device from the given network.
void	removeHost(NetworkId networkId, HostId hostId) Removes the specified virtual host from the store.
VirtualLink	removeLink(NetworkId networkId, ConnectPoint src, ConnectPoint dst) Removes the specified link from the store.
void	removeNetwork(NetworkId networkId) Removes the specified virtual network from the store.
void	removePort(NetworkId networkId, DeviceId deviceId, PortNumber portNumber) Removes the specified port from the given device and network.
void	removeTenantId(TenantId tenantId) Removes the specified tenant ID from the store.
void	removeTunnelId(Intent intent, TunnelId tunnelId) Deprecated. in Kingfisher Release (1.10)
void	updateLink(VirtualLink virtualLink, TunnelId tunnelId, Link.State state) Updates the tunnelId in the virtual link.
void	updatePortState(NetworkId networkId, DeviceId deviceId, PortNumber portNumber, boolean isEnabled) Updates port state of an existing virtual port.

Methods inherited from interface org.onosproject.store.Store

hasDelegate, setDelegate, unsetDelegate

Method Detail

addTenantId

void addTenantId(TenantId tenantId)

Adds a new tenant ID to the store.

Parameters:

tenantId - tenant identifier

removeTenantId

void removeTenantId(TenantId tenantId)

Removes the specified tenant ID from the store.

Parameters:

tenantId - tenant identifier

getTenantIds

java.util.Set<TenantId> getTenantIds()

Returns set of registered tenant IDs.

Returns:

set of tenant identifiers

addNetwork

VirtualNetwork addNetwork(TenantId tenantId)

Adds a new virtual network for the specified tenant to the store.

Parameters:

tenantId - tenant identifier

Returns:

the virtual network

removeNetwork

void removeNetwork(NetworkId networkId)

Removes the specified virtual network from the store.

Parameters:

networkId - network identifier

addDevice

VirtualDevice addDevice(NetworkId networkId,
                        DeviceId deviceId)

Adds a new virtual device to the store. This device will have no ports.

Parameters:

networkId - network identifier

deviceId - device identifier

Returns:

the virtual device

removeDevice

void removeDevice(NetworkId networkId,
                  DeviceId deviceId)

Removes the specified virtual device from the given network.

Parameters:

networkId - network identifier

deviceId - device identifier

addHost

VirtualHost addHost(NetworkId networkId,
                    HostId hostId,
                    MacAddress mac,
                    VlanId vlan,
                    HostLocation location,
                    java.util.Set<IpAddress> ips)

Adds a new virtual host to the store.

Parameters:

networkId - network identifier

hostId - host identifier

mac - mac address

vlan - vlan identifier

location - host location

ips - set of ip addresses

Returns:

the virtual host

removeHost

void removeHost(NetworkId networkId,
                HostId hostId)

Removes the specified virtual host from the store.

Parameters:

networkId - network identifier

hostId - host identifier

addLink

VirtualLink addLink(NetworkId networkId,
                    ConnectPoint src,
                    ConnectPoint dst,
                    Link.State state,
                    TunnelId realizedBy)

Adds a new virtual link.

Parameters:

networkId - network identifier

src - source end-point of the link

dst - destination end-point of the link

state - link state

realizedBy - underlying tunnel identifier using which this link is realized

Returns:

the virtual link

updateLink

void updateLink(VirtualLink virtualLink,
                TunnelId tunnelId,
                Link.State state)

Updates the tunnelId in the virtual link.

Parameters:

virtualLink - virtual link

tunnelId - tunnel identifier

state - link state

removeLink

VirtualLink removeLink(NetworkId networkId,
                       ConnectPoint src,
                       ConnectPoint dst)

Removes the specified link from the store.

Parameters:

networkId - network identifier

src - source connection point

dst - destination connection point

Returns:

the virtual link

addPort

VirtualPort addPort(NetworkId networkId,
                    DeviceId deviceId,
                    PortNumber portNumber,
                    ConnectPoint realizedBy)

Adds a new virtual port to the network.

Parameters:

networkId - network identifier

deviceId - device identifier

portNumber - port number

realizedBy - underlying port which realizes the virtual port

Returns:

the virtual port

bindPort

void bindPort(NetworkId networkId,
              DeviceId deviceId,
              PortNumber portNumber,
              ConnectPoint realizedBy)

Binds an existing virtual port to the network.

Parameters:

networkId - network identifier

deviceId - device identifier

portNumber - port number

realizedBy - underlying port which realizes the virtual port

updatePortState

void updatePortState(NetworkId networkId,
                     DeviceId deviceId,
                     PortNumber portNumber,
                     boolean isEnabled)

Updates port state of an existing virtual port.

Parameters:

networkId - network identifier

deviceId - device identifier

portNumber - port number

isEnabled - indicator whether the port is up and active

removePort

void removePort(NetworkId networkId,
                DeviceId deviceId,
                PortNumber portNumber)

Removes the specified port from the given device and network.

Parameters:

networkId - network identifier

deviceId - device identifier

portNumber - port number

getNetworks

java.util.Set<VirtualNetwork> getNetworks(TenantId tenantId)

Returns the list of networks.

Parameters:

tenantId - tenant identifier

Returns:

set of virtual networks

getNetwork

VirtualNetwork getNetwork(NetworkId networkId)

Returns the virtual network for the given network identifier.

Parameters:

networkId - network identifier

Returns:

the virtual network

getDevices

java.util.Set<VirtualDevice> getDevices(NetworkId networkId)

Returns the list of devices in the specified virtual network.

Parameters:

networkId - network identifier

Returns:

set of virtual devices

getHosts

java.util.Set<VirtualHost> getHosts(NetworkId networkId)

Returns the list of hosts in the specified virtual network.

Parameters:

networkId - network identifier

Returns:

set of virtual hosts

getLinks

java.util.Set<VirtualLink> getLinks(NetworkId networkId)

Returns the list of virtual links in the specified virtual network.

Parameters:

networkId - network identifier

Returns:

set of virtual links

getLink

VirtualLink getLink(NetworkId networkId,
                    ConnectPoint src,
                    ConnectPoint dst)

Returns the virtual link matching the network identifier, source connect point, and destination connect point.

Parameters:

networkId - network identifier

src - source connect point

dst - destination connect point

Returns:

virtual link

getPorts

java.util.Set<VirtualPort> getPorts(NetworkId networkId,
                                    DeviceId deviceId)

Returns the list of ports of the specified virtual device.

Parameters:

networkId - network identifier

deviceId - device identifier

Returns:

set of virtual networks

addTunnelId

@Deprecated
void addTunnelId(Intent intent,
                             TunnelId tunnelId)

Deprecated. in Kingfisher Release (1.10)

Adds the intent to tunnel identifier mapping to the store.

Parameters:

intent - intent

tunnelId - tunnel identifier

getTunnelIds

@Deprecated
java.util.Set<TunnelId> getTunnelIds(Intent intent)

Deprecated. in Kingfisher Release (1.10)

Return the set of tunnel identifiers store against the intent.

Parameters:

intent - intent

Returns:

set of tunnel identifiers

removeTunnelId

@Deprecated
void removeTunnelId(Intent intent,
                                TunnelId tunnelId)

Deprecated. in Kingfisher Release (1.10)

Removes the intent to tunnel identifier mapping from the store.

Parameters:

intent - intent

tunnelId - tunnel identifier