net.onrc.openvirtex.api.service.handlers

Class HandlerUtils

java.lang.Object

net.onrc.openvirtex.api.service.handlers.HandlerUtils

public final class HandlerUtils
extends Object

Utility class that implements various checks to validate API input.

Method Summary

Methods

Modifier and Type	Method and Description
static void	areValidLinkEndPoints(int tenantId, long srcDpid, short ovxSrcPort, long dstDpid, short ovxDstPort, List<PhysicalLink> physicalLinks) Checks that the virtual ports (virtual link end-points) are mapped on the same physical ports that delimit the physical path.
static <T> T	fetchField(String fieldName, Map<String,Object> map, boolean required, T def)
static List<PhysicalLink>	getPhysicalPath(String pathString) Gets the list of physical link instances based on the given path string.
static void	isControllerAvailable(String controllerAddress, int controllerPort, int tenantId) Check that the controller host and port that we are trying to connect with is not already being used by another virtual network in our system.
static void	isUniqueHostMAC(MACAddress mac) Checks if the host MAC address is not yet registered in the map.
static void	isValidDPID(int tenantId, List<Long> dpids) Checks that the physical dpids that are provided all actually refer to a physical switch in the physical network.
static void	isValidHostId(int tenantId, int hostId) Checks that the host ID specified refers to a valid host in the virtual network.
static void	isValidLinkId(int tenantId, int linkId) Checks that the link id specified refers to a pair of virtual links in the virtual network.
static void	isValidOVXBigSwitch(int tenantId, long dpid) Checks that the switch id specified belongs to the virtual network and is of type OVXBigSwitch.
static void	isValidOVXPort(int tenantId, long dpid, short portNumber) Checks if the virtual port number specified is present on the virtual switch.
static void	isValidOVXSwitch(int tenantId, long dpid) Checks that the switch id specified belongs to the virtual network.
static void	isValidPhysicalPort(int tenantId, long dpid, short portNumber) Checks if the physical port number specified is present on the physical switch.
static void	isValidPriority(int priority) Checks if the priority specified is in the allowed range [0,127].
static void	isValidRouteId(int tenantId, long dpid, int routeId) Checks that the route id specified refers to a pair of virtual route in the big-switch belonging to the virtual network.
static void	isValidTenantId(int tenantId) Checks that the tenant id specified refers to a virtual network in the system.
static void	isValidVirtualLink(List<PhysicalLink> physicalLinks) Checks that the virtual link we are trying to create is valid (e.g., dstSwitch of a physical Link is a SrcSwitch of the next physical link and the physical ports are different).

Methods inherited from class java.lang.Object

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

Method Detail

fetchField

public static <T> T fetchField(String fieldName,
               Map<String,Object> map,
               boolean required,
               T def)
                    throws ClassCastException,
                           MissingRequiredField

Throws:

ClassCastException

MissingRequiredField

isControllerAvailable

public static void isControllerAvailable(String controllerAddress,
                         int controllerPort,
                         int tenantId)
                                  throws ControllerUnavailableException

Check that the controller host and port that we are trying to connect with is not already being used by another virtual network in our system. No two virtual networks can have the same controller host and port.

Parameters:

controllerAddress - the controller address

controllerPort - the controller port

tenantId - the tenant ID

Throws:

ControllerUnavailableException - if controller port and address are already in use

isValidTenantId

public static void isValidTenantId(int tenantId)
                            throws InvalidTenantIdException

Checks that the tenant id specified refers to a virtual network in the system.

Parameters:

tenantId - the tenant ID

Throws:

InvalidTenantIdException - if tenant ID is invalid

isValidHostId

public static void isValidHostId(int tenantId,
                 int hostId)
                          throws InvalidHostException,
                                 NetworkMappingException

Checks that the host ID specified refers to a valid host in the virtual network.

Parameters:

tenantId - the tenant ID

hostId - the host ID

Throws:

InvalidHostException

NetworkMappingException

isValidLinkId

public static void isValidLinkId(int tenantId,
                 int linkId)
                          throws InvalidTenantIdException

Checks that the link id specified refers to a pair of virtual links in the virtual network.

Parameters:

tenantId - the tenant ID

linkId - the link ID

Throws:

InvalidLinkException

InvalidTenantIdException

isValidRouteId

public static void isValidRouteId(int tenantId,
                  long dpid,
                  int routeId)
                           throws InvalidRouteException,
                                  NetworkMappingException

Checks that the route id specified refers to a pair of virtual route in the big-switch belonging to the virtual network.

Parameters:

tenantId - the tenant ID

dpid - the datapath ID

routeId - the route ID

Throws:

InvalidRouteException

NetworkMappingException

isValidOVXSwitch

public static void isValidOVXSwitch(int tenantId,
                    long dpid)
                             throws InvalidTenantIdException,
                                    InvalidDPIDException

Checks that the switch id specified belongs to the virtual network.

Parameters:

tenantId - the tenant ID

dpid - the datapath ID

Throws:

InvalidDPIDException

InvalidTenantIdException

isValidOVXBigSwitch

public static void isValidOVXBigSwitch(int tenantId,
                       long dpid)
                                throws NetworkMappingException

Checks that the switch id specified belongs to the virtual network and is of type OVXBigSwitch.

Parameters:

tenantId - the tenant ID

dpid - the datapath ID

Throws:

NetworkMappingException

InvalidDPIDException

isValidDPID

public static void isValidDPID(int tenantId,
               List<Long> dpids)
                        throws InvalidDPIDException

Checks that the physical dpids that are provided all actually refer to a physical switch in the physical network. If any of them does not exist then we throw an exception. If a physical dpid is not connected to any of the other ones, throw an exception. If physical dpid is already mapped to a virtual switch then throw an exception.

Parameters:

tenantId - tenant ID

dpids - the list of datapath IDs

Throws:

InvalidDPIDException

isValidOVXPort

public static void isValidOVXPort(int tenantId,
                  long dpid,
                  short portNumber)
                           throws InvalidPortException,
                                  NetworkMappingException

Checks if the virtual port number specified is present on the virtual switch.

Parameters:

tenantId - the tenant ID

dpid - the datapath ID

portNumber - the port number

Throws:

InvalidPortException

NetworkMappingException

isValidPriority

public static void isValidPriority(int priority)
                            throws InvalidPriorityException

Checks if the priority specified is in the allowed range [0,127].

Parameters:

priority - the priority value

Throws:

InvalidPriorityException

isUniqueHostMAC

public static void isUniqueHostMAC(MACAddress mac)
                            throws DuplicateMACException

Checks if the host MAC address is not yet registered in the map.

Parameters:

mac - the MAC address

Throws:

InvalidPriorityException

DuplicateMACException

isValidPhysicalPort

public static void isValidPhysicalPort(int tenantId,
                       long dpid,
                       short portNumber)
                                throws InvalidPortException,
                                       InvalidDPIDException,
                                       SwitchMappingException

Checks if the physical port number specified is present on the physical switch.

Parameters:

tenantId - the tenant ID

dpid - the datapath ID

portNumber - the port number

Throws:

InvalidPortException

SwitchMappingException

InvalidDPIDException

isValidVirtualLink

public static void isValidVirtualLink(List<PhysicalLink> physicalLinks)
                               throws VirtualLinkException

Checks that the virtual link we are trying to create is valid (e.g., dstSwitch of a physical Link is a SrcSwitch of the next physical link and the physical ports are different).

Parameters:

physicalLinks - the path

Throws:

VirtualLinkException

areValidLinkEndPoints

public static void areValidLinkEndPoints(int tenantId,
                         long srcDpid,
                         short ovxSrcPort,
                         long dstDpid,
                         short ovxDstPort,
                         List<PhysicalLink> physicalLinks)
                                  throws NetworkMappingException

Checks that the virtual ports (virtual link end-points) are mapped on the same physical ports that delimit the physical path.

Parameters:

tenantId - the tenant ID

srcDpid - the virtual source datapath ID

ovxSrcPort - the source port number

dstDpid - the virtual destination datapath ID

ovxDstPort - the destination port number

physicalLinks - the path

Throws:

NetworkMappingException

VirtualLinkException

getPhysicalPath

public static List<PhysicalLink> getPhysicalPath(String pathString)

Gets the list of physical link instances based on the given path string.

Parameters:

pathString - the path string

Returns:

list of physical links