net.onrc.openvirtex.elements

Interface Mappable

All Known Implementing Classes:

OVXMap

public interface Mappable

Method Summary

Methods

Modifier and Type	Method and Description
void	addIP(PhysicalIPAddress physicalIP, OVXIPAddress virtualIP) This function creates the map between the PhysicalIP and VirtualIP in both directions.
void	addLinks(List<PhysicalLink> physicalLinks, OVXLink virtualLink) Create the mapping between PhysicalLinks and a VirtualLink.
void	addMAC(MACAddress mac, Integer tenantId) Creates the maping between the MAC address and tenant ID.
void	addNetwork(OVXNetwork virtualNetwork) Maintains a list of all the virtualNetworks in the system indexed by the tenant id mapping to VirtualNetworks.
void	addRoute(SwitchRoute route, List<PhysicalLink> physicalLinks) Adds a mapping between a SwitchRoute and the PhysicalLinks making it up.
void	addSwitches(List<PhysicalSwitch> physicalSwitches, OVXSwitch virtualSwitch) Create the mapping between PhysicalSwithes and a VirtualSwitch.
Integer	getMAC(MACAddress mac) Gets the tenant ID associated with the given MAC address.
PhysicalIPAddress	getPhysicalIP(OVXIPAddress ip, Integer tenantId)
List<PhysicalLink>	getPhysicalLinks(OVXLink virtualLink) Get the physicalLinks that all make up a specified virtualLink.
List<PhysicalSwitch>	getPhysicalSwitches(OVXSwitch virtualSwitch) Get the physicalSwitches that are contained in the virtualSwitch.
List<PhysicalLink>	getRoute(SwitchRoute route) Gets the current path as a list of physical links for the given route.
Set<SwitchRoute>	getSwitchRoutes(PhysicalLink physicalLink, Integer tenantId) Gets the switch routes that use the given physical link in the specified virtual network.
OVXIPAddress	getVirtualIP(PhysicalIPAddress ip)
List<OVXLink>	getVirtualLinks(PhysicalLink physicalLink, Integer tenantId) Gets the list of OVXLinks that are part of virtual network identified by tenantId and which include the specified physicalLink.
OVXNetwork	getVirtualNetwork(Integer tenantId) Gets the virtual network instance associated with the given tenant ID.
OVXSwitch	getVirtualSwitch(PhysicalSwitch physicalSwitch, Integer tenantId) Get the virtualSwitch which has been specified by the physicalSwitch and tenantId.
boolean	hasMAC(MACAddress mac) Checks if the MAC address exists in the map.
boolean	hasOVXLinks(PhysicalLink physicalLink, Integer tenantId)
boolean	hasPhysicalIP(OVXIPAddress vip, Integer tenantId)
boolean	hasSwitchRoutes(PhysicalLink physicalLink, Integer tenantId)
boolean	hasVirtualIP(PhysicalIPAddress ip)
boolean	hasVirtualSwitch(PhysicalSwitch psw, int tid)
void	knownLink(PhysicalLink link) Sets the linkid back to the original linkid for a physical link that previously existed and has gone away and come back.
Map<Integer,OVXNetwork>	listVirtualNetworks() Obtains an immutable copy of the list of virtual networks.
void	removeMAC(MACAddress mac) Removes the MAC address from the map.
void	removeNetwork(OVXNetwork network) Deletes the OVXNetwork object.
void	removePhysicalLink(PhysicalLink physicalLink) Removes a PhysicalLink from a Mappable, including mappings to OVXLinks and SwitchRoutes.
void	removePhysicalSwitch(PhysicalSwitch physicalSwitch) Removes a PhysicalSwitch from Mappable mappings.
void	removeRoute(SwitchRoute route) Removes a SwitchRoute from the map.
void	removeVirtualIPs(int tenantId) Delete all the IPs associated to a single virtual network.
void	removeVirtualLink(OVXLink virtualLink) Delete the OVXLink object.
void	removeVirtualSwitch(OVXSwitch virtualSwitch) Delete the OVXSwitch object.

Method Detail

addIP

void addIP(PhysicalIPAddress physicalIP,
         OVXIPAddress virtualIP)

This function creates the map between the PhysicalIP and VirtualIP in both directions.

Parameters:

physicalIP - Refers to the PhysicalIPAddress which is created using the tenant id and virtualIP

virtualIP - The IP address used within the VirtualNetwork

addSwitches

void addSwitches(List<PhysicalSwitch> physicalSwitches,
               OVXSwitch virtualSwitch)

Create the mapping between PhysicalSwithes and a VirtualSwitch. This function takes in a list of physicalSwitches and adds to the OVXMap indexed by the virtualSwitch.

Parameters:

physicalSwitches -

virtualSwitch -

addLinks

void addLinks(List<PhysicalLink> physicalLinks,
            OVXLink virtualLink)

Create the mapping between PhysicalLinks and a VirtualLink. This function takes in a list of physicalLinks rather than an individual physicalLink and adds the list to the OVXmap.

Parameters:

physicalLinks -

virtualLink -

addNetwork

void addNetwork(OVXNetwork virtualNetwork)

Maintains a list of all the virtualNetworks in the system indexed by the tenant id mapping to VirtualNetworks.

Parameters:

virtualNetwork - An OVXNetwork object which keeps track of all the elements in the Virtual network

addMAC

void addMAC(MACAddress mac,
          Integer tenantId)

Creates the maping between the MAC address and tenant ID.

Parameters:

mac - the MAC address

tenantId - the tenant ID.

addRoute

void addRoute(SwitchRoute route,
            List<PhysicalLink> physicalLinks)

Adds a mapping between a SwitchRoute and the PhysicalLinks making it up.

Parameters:

route - the switch route

physicalLinks - the physical path

getPhysicalIP

PhysicalIPAddress getPhysicalIP(OVXIPAddress ip,
                              Integer tenantId)
                                throws AddressMappingException

Parameters:

ip -

tenantId -

Returns:

Physical IP address associated with virtual IP and tenant ID

Throws:

AddressMappingException

getVirtualIP

OVXIPAddress getVirtualIP(PhysicalIPAddress ip)
                          throws AddressMappingException

Parameters:

ip -

Returns:

Virtual IP address associated with physical IP

Throws:

AddressMappingException

getVirtualSwitch

OVXSwitch getVirtualSwitch(PhysicalSwitch physicalSwitch,
                         Integer tenantId)
                           throws SwitchMappingException

Get the virtualSwitch which has been specified by the physicalSwitch and tenantId.

Parameters:

physicalSwitch - A PhysicalSwitch object is a single switch in the PhysicalNetwork

Returns:

virtualSwitch A OVXSwitch object which represents a single switch in the OVXNetwork

Throws:

SwitchMappingException

getVirtualLinks

List<OVXLink> getVirtualLinks(PhysicalLink physicalLink,
                            Integer tenantId)
                              throws LinkMappingException

Gets the list of OVXLinks that are part of virtual network identified by tenantId and which include the specified physicalLink.

Parameters:

physicalLink - A PhysicalLink object which represent a single source and destination PhysicalPort and PhysicalSwitch

Returns:

virtualLink A OVXLink object which represents a single link in the OVXNetwork

Throws:

LinkMappingException

getPhysicalLinks

List<PhysicalLink> getPhysicalLinks(OVXLink virtualLink)
                                    throws LinkMappingException

Get the physicalLinks that all make up a specified virtualLink. Return a list of all the physicalLinks that make up the virtualLink.

Parameters:

virtualLink - An OVXLink object which represents a single link in the OVXNetwork

Returns:

physicalLinks A List of PhysicalLink objects which represent a single source and destination PhysicalPort and PhysicalSwitch

Throws:

LinkMappingException

getPhysicalSwitches

List<PhysicalSwitch> getPhysicalSwitches(OVXSwitch virtualSwitch)
                                         throws SwitchMappingException

Get the physicalSwitches that are contained in the virtualSwitch. for a big switch this will be multiple physicalSwitches.

Parameters:

virtualSwitch - A OVXSwitch object representing a single switch in the virtual network

Returns:

physicalSwitches A List of PhysicalSwitch objects that are each part of the OVXSwitch specified

Throws:

SwitchMappingException

getVirtualNetwork

OVXNetwork getVirtualNetwork(Integer tenantId)
                             throws NetworkMappingException

Gets the virtual network instance associated with the given tenant ID.

Parameters:

tenantId - the tenant ID

Returns:

the virual network

Throws:

NetworkMappingException

getMAC

Integer getMAC(MACAddress mac)
               throws AddressMappingException

Gets the tenant ID associated with the given MAC address.

Parameters:

mac - the MAC address

Returns:

tenant ID associated with MAC address

Throws:

AddressMappingException

listVirtualNetworks

Map<Integer,OVXNetwork> listVirtualNetworks()

Obtains an immutable copy of the list of virtual networks.

Returns:

- immutable list of virtual networks

removeNetwork

void removeNetwork(OVXNetwork network)

Deletes the OVXNetwork object.

Parameters:

OVXNetwork - network This is object representing the virtual network

removeVirtualLink

void removeVirtualLink(OVXLink virtualLink)

Delete the OVXLink object.

Parameters:

OVXLink - virtualLink This is object representing the virtual link

removeVirtualSwitch

void removeVirtualSwitch(OVXSwitch virtualSwitch)

Delete the OVXSwitch object.

Parameters:

OVXSwitch - virtualSwitch This is object representing the virtual switch

removeVirtualIPs

void removeVirtualIPs(int tenantId)

Delete all the IPs associated to a single virtual network.

Parameters:

tenantId - This is an Integer that represents a unique number for each virtualNetwork

removeMAC

void removeMAC(MACAddress mac)

Removes the MAC address from the map.

Parameters:

mac - the MAC address

tenantId - the tenant ID

getRoute

List<PhysicalLink> getRoute(SwitchRoute route)
                            throws LinkMappingException

Gets the current path as a list of physical links for the given route.

Parameters:

route - the switch route

Returns:

the path

Throws:

LinkMappingException

getSwitchRoutes

Set<SwitchRoute> getSwitchRoutes(PhysicalLink physicalLink,
                               Integer tenantId)
                                 throws LinkMappingException

Gets the switch routes that use the given physical link in the specified virtual network.

Parameters:

physicalLink - the physical link

tenantId - the tenant ID

Returns:

The routes associated with the supplied PhysicalLink

Throws:

LinkMappingException

removeRoute

void removeRoute(SwitchRoute route)

Removes a SwitchRoute from the map.

Parameters:

route - the switch route

removePhysicalLink

void removePhysicalLink(PhysicalLink physicalLink)

Removes a PhysicalLink from a Mappable, including mappings to OVXLinks and SwitchRoutes.

Parameters:

physicalLink - the physical link

removePhysicalSwitch

void removePhysicalSwitch(PhysicalSwitch physicalSwitch)

Removes a PhysicalSwitch from Mappable mappings.

Parameters:

physicalSwitch - the physical switch

hasPhysicalIP

boolean hasPhysicalIP(OVXIPAddress vip,
                    Integer tenantId)

Parameters:

vip - Virtual IP address

tenantId - the ID representing a virtual network.

Returns:

true if a PhysicalIPAddress exists in this map

hasVirtualIP

boolean hasVirtualIP(PhysicalIPAddress ip)

Parameters:

ip - The physical IP address

Returns:

true if a mapping exists

hasMAC

boolean hasMAC(MACAddress mac)

Checks if the MAC address exists in the map.

Parameters:

mac - the MAC address

Returns:

true if the MAC address exists in this map

hasSwitchRoutes

boolean hasSwitchRoutes(PhysicalLink physicalLink,
                      Integer tenantId)

Parameters:

physicalLink - the PhysicalLink

tenantId - the ID representing a virtual network.

Returns:

true if a PhysicalLink maps to any SwitchRoutes

hasOVXLinks

boolean hasOVXLinks(PhysicalLink physicalLink,
                  Integer tenantId)

Parameters:

physicalLink - the PhysicalLink

tenantId - the ID representing a virtual network.

Returns:

true if a PhysicalLink maps to any OVXLinks

hasVirtualSwitch

boolean hasVirtualSwitch(PhysicalSwitch psw,
                       int tid)

Parameters:

psw - the PhysicalSwitch mapped to the OVXSwitch we want to check for

tid - TenantID of OVXSwitch

Returns:

true if the OVXSwitch exists

knownLink

void knownLink(PhysicalLink link)

Sets the linkid back to the original linkid for a physical link that previously existed and has gone away and come back.

Parameters:

link - - the new link that has just been detected,