org.opendaylight.vtn.manager.internal.util.flow

Class VTNFlowBuilder

java.lang.Object

org.opendaylight.vtn.manager.internal.util.flow.VTNFlowBuilder

All Implemented Interfaces:

VTNDataFlow

public final class VTNFlowBuilder
extends Object
implements VTNDataFlow

VTNFlowBuilder describes a request for adding a new VTN data flow.

Constructor Summary

Constructors

Constructor and Description
VTNFlowBuilder(String tname, VTNMatch vmatch, int pri, int idle, int hard) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
VTNFlowBuilder	addDropFlow(SalPort ingress) Add a flow entry that discards packets.
VTNFlowBuilder	addEgressFlow(SalPort ingress, SalPort egress, int inVid, int outVid, Collection<? extends FlowFilterAction> filters) Add the egress flow entry.
VTNFlowBuilder	addInternalFlow(SalPort src, SalPort dst) Add an intermediate flow entry which forwards packets via the given link edge.
VTNFlowBuilder	addVirtualRoute(Collection<VNodeHop> c) Add the specified sequence of VNodeHop to the tail of the virtual packet routing path.
VTNFlowBuilder	addVirtualRoute(VNodeHop vhop) Add the specified VNodeHop to the tail of the virtual packet routing path.
VtnDataFlow	createVtnDataFlow(VtnFlowId fid) Create a VTN data flow instance.
VtnDataFlow	getDataFlow() Return a VTN data flow instance created by the last call of createVtnDataFlow(VtnFlowId).
Set<SalNode>	getFlowNodes() Return a set of switches related to this data flow.
Set<SalPort>	getFlowPorts() Return a set of switch ports related to this data flow.
String	getIngressMatchKey() Return a string which represents the condition configured in the ingress flow entry.
VtnDataFlowKey	getKey() Return the key assocaited with the VTN data flow in the MD-SAL datastore.
SourceHostFlowsKey	getSourceHostFlowsKey() Return the source L2 host of this data flow.
String	getTenantName() Return the name of the VTN.
VTNFlowBuilder	setEgressVNodeHop(VNodeHop vhop) Set the virtual node hop to the egress virtual node of this flow.
VTNFlowBuilder	setPathPolicyId(int id) Set the identifier of the path policy which routed this flow.

Methods inherited from class java.lang.Object

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

Constructor Detail

VTNFlowBuilder

public VTNFlowBuilder(String tname,
                      VTNMatch vmatch,
                      int pri,
                      int idle,
                      int hard)

Construct a new instance.

Parameters:

tname - The name of the VTN.

vmatch - A VTNMatch instance.

pri - A flow priority.

idle - Idle timeout in seconds.

hard - Hard timeout in seconds.

Method Detail

getTenantName

public String getTenantName()

Return the name of the VTN.

Returns:

The name of the VTN.

addInternalFlow

public VTNFlowBuilder addInternalFlow(SalPort src,
                                      SalPort dst)

Add an intermediate flow entry which forwards packets via the given link edge.

Parameters:

src - The source port of the link edge.

dst - The destination port of the link edge.

Returns:

This instance.

addEgressFlow

public VTNFlowBuilder addEgressFlow(SalPort ingress,
                                    SalPort egress,
                                    int inVid,
                                    int outVid,
                                    Collection<? extends FlowFilterAction> filters)

Add the egress flow entry.

Parameters:

ingress - A SalPort instance corresponding to the ingress switch port.

egress - A SalPort instance corresponding to the egress switch port.

inVid - A VLAN ID configured in the origial packet.

outVid - A VLAN ID to be set.

filters - A collection of actions configured to be applied.

Returns:

This instance.

addDropFlow

public VTNFlowBuilder addDropFlow(SalPort ingress)

Add a flow entry that discards packets.

Parameters:

ingress - A SalPort instance corresponding to the ingress switch port.

Returns:

This instance.

setPathPolicyId

public VTNFlowBuilder setPathPolicyId(int id)

Set the identifier of the path policy which routed this flow.

Parameters:

id - The identifier of the path policy.

Returns:

This instance.

addVirtualRoute

public VTNFlowBuilder addVirtualRoute(VNodeHop vhop)

Add the specified VNodeHop to the tail of the virtual packet routing path.

Parameters:

vhop - A VNodeHop instance.

Returns:

This instance.

addVirtualRoute

public VTNFlowBuilder addVirtualRoute(Collection<VNodeHop> c)

Add the specified sequence of VNodeHop to the tail of the virtual packet routing path.

Parameters:

c - A collection of VNodeHop instances.

Returns:

This instance.

setEgressVNodeHop

public VTNFlowBuilder setEgressVNodeHop(VNodeHop vhop)

Set the virtual node hop to the egress virtual node of this flow.

Parameters:

vhop - A VNodeHop instance which represents the hop to the egress virtual node. Specifying null or an empty route means that this VTN flow always discards packets.

Returns:

This instance.

createVtnDataFlow

public VtnDataFlow createVtnDataFlow(VtnFlowId fid)

Create a VTN data flow instance.

Parameters:

fid - The identifier for this data flow.

Returns:

A VtnDataFlow instance.

getDataFlow

public VtnDataFlow getDataFlow()

Return a VTN data flow instance created by the last call of createVtnDataFlow(VtnFlowId).

Returns:

A VtnDataFlow or null.

getKey

public VtnDataFlowKey getKey()

Return the key assocaited with the VTN data flow in the MD-SAL datastore.

Note that this method must be called after the data flow is created by createVtnDataFlow(VtnFlowId).

Specified by:

getKey in interface VTNDataFlow

Returns:

A VtnDataFlowKey instance.

getIngressMatchKey

public String getIngressMatchKey()

Return a string which represents the condition configured in the ingress flow entry.

Note that this method needs to be called after all flow entries are configured.

Specified by:

getIngressMatchKey in interface VTNDataFlow

Returns:

A string which representse the ingress match condition.

getFlowNodes

public Set<SalNode> getFlowNodes()

Return a set of switches related to this data flow.

• Note that this method returns a read-only set.
• Note that this method needs to be called after all flow entries are configured.

Specified by:

getFlowNodes in interface VTNDataFlow

Returns:

A set of SalNode instances.

getFlowPorts

public Set<SalPort> getFlowPorts()

Return a set of switch ports related to this data flow.

• Note that this method returns a read-only set.
• Note that this method needs to be called after all flow entries are configured.

Specified by:

getFlowPorts in interface VTNDataFlow

Returns:

A set of SalPort instances.

getSourceHostFlowsKey

public SourceHostFlowsKey getSourceHostFlowsKey()

Return the source L2 host of this data flow.

Note that this method needs to be called after all flow entries are configured.

Specified by:

getSourceHostFlowsKey in interface VTNDataFlow

Returns:

A SourceHostFlowsKey instance which specifies the source L2 host. null if the source L2 host could not be determined.