net.onrc.openvirtex.elements.link

Class OVXLinkUtils

java.lang.Object

net.onrc.openvirtex.elements.link.OVXLinkUtils

public class OVXLinkUtils
extends Object

This class provides some useful methods to encapsulate/decapsulate the virtual link identifiers (tenantId, linkId, flowId) inside the packet fields (MAC addresses or VLAN).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OVXLinkUtils() Instantiates a new link utils instance.
	OVXLinkUtils(Integer tenantId, Integer linkId, Integer flowId) Instantiates a new link utils from tenantId, linkId and flowId.
	OVXLinkUtils(MACAddress srcMac, MACAddress dstMac) Instantiates a new link utils instance from the MAC addresses couple.

Method Summary

Methods

Modifier and Type	Method and Description
MACAddress	getDstMac() Gets the destination MAC address.
Integer	getFlowId() Gets the flow id.
Integer	getLinkId() Gets the link id.
LinkedList<MACAddress>	getOriginalMacAddresses() Gets the original MAC addresses in a list.
MACAddress	getSrcMac() Gets the source MAC address.
Integer	getTenantId() Gets the tenant id.
Short	getVlan() Gets the VLAN.
boolean	isValid() Checks if the link utils instance is valid.
void	rewriteMatch(OFMatch match) Rewrites the given match according to the current instance.
List<OFAction>	setLinkFields() Gets a list of actions based on the current instance.
String	toString()
List<OFAction>	unsetLinkFields(boolean skipSrcMac, boolean skipDstMac) Gets a list of actions based on the original MAC addresses.

Methods inherited from class java.lang.Object

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

Constructor Detail

OVXLinkUtils

protected OVXLinkUtils()

Instantiates a new link utils instance. Never called by external classes.

OVXLinkUtils

public OVXLinkUtils(MACAddress srcMac,
            MACAddress dstMac)

Instantiates a new link utils instance from the MAC addresses couple. Automatically decapsulate and set tenantId, linkId and flowId from the parameters given.

Parameters:

srcMac - the src mac

dstMac - the dst mac

OVXLinkUtils

public OVXLinkUtils(Integer tenantId,
            Integer linkId,
            Integer flowId)

Instantiates a new link utils from tenantId, linkId and flowId. Automatically encapsulate and set these values in the MAC addresses and in the VLAN.

Parameters:

tenantId - the tenant id

linkId - the link id

flowId - the flow id

Method Detail

isValid

public boolean isValid()

Checks if the link utils instance is valid. To be valid, the instance has to have tenantId, linkId and flowId set. Moreover, both MAC addresses or the VLAN field has to be set too.

Returns:

true if valid, false otherwise

getTenantId

public Integer getTenantId()

Gets the tenant id.

Returns:

the tenant id

getLinkId

public Integer getLinkId()

Gets the link id.

Returns:

the link id

getFlowId

public Integer getFlowId()

Gets the flow id.

Returns:

the flow id

getSrcMac

public MACAddress getSrcMac()

Gets the source MAC address.

Returns:

the source MAC

getDstMac

public MACAddress getDstMac()

Gets the destination MAC address.

Returns:

the destination MAC

getVlan

public Short getVlan()

Gets the VLAN.

Returns:

the VLAN

getOriginalMacAddresses

public LinkedList<MACAddress> getOriginalMacAddresses()
                                               throws NetworkMappingException

Gets the original MAC addresses in a list.

Returns:

list of original MAC addresses

Throws:

NetworkMappingException - if the tenant ID is invalid

toString

public String toString()

Overrides:

toString in class Object

rewriteMatch

public void rewriteMatch(OFMatch match)

Rewrites the given match according to the current instance.

Parameters:

match - the OpenFlow match

setLinkFields

public List<OFAction> setLinkFields()

Gets a list of actions based on the current instance.

Returns:

list of actions

unsetLinkFields

public List<OFAction> unsetLinkFields(boolean skipSrcMac,
                             boolean skipDstMac)

Gets a list of actions based on the original MAC addresses.

Parameters:

skipSrcMac - Skip rewriting the source MAC address.

skipDstMac - Skip rewriting the destination MAC address.

Returns:

list of actions