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

Class FlowCache

java.lang.Object

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

All Implemented Interfaces:

VTNDataFlow

public final class FlowCache
extends Object
implements VTNDataFlow

FlowCache describes a set of cached attributes for a data flow.

Note that this class is not synchronized.

Constructor Summary

Constructors

Constructor and Description
FlowCache(VtnDataFlow vdf) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
VtnDataFlow	getDataFlow() Return a VtnDataFlow instance associated with the target data flow.
DataFlowSource	getDataFlowSource() Return the source L2 host of the data flow.
org.apache.commons.lang3.tuple.Pair<L2Host,L2Host>	getEdgeHosts() Get two L2Host instances which represents host information matched by edge flow entries.
List<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action>	getEgressActions() Return a list of MD-SAL flow actions configured in the egress flow entry of the data flow.
VtnFlowEntry	getEgressFlow() Return the egress flow entry of the data flow.
VirtualNodePath	getEgressPath() Return the path to the virtual node which maps the egress flow.
List<VtnFlowEntry>	getFlowEntries() Return a list of flow entries sorted in order of order value.
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.
VtnFlowEntry	getIngressFlow() Return the ingress flow entry of the data flow.
String	getIngressMatchKey() Return a string which represents the condition configured in the ingress flow entry.
VirtualNodePath	getIngressPath() Return the path to the virtual node which maps the ingress flow.
VtnDataFlowKey	getKey() Return the key assocaited with the VTN data flow in the MD-SAL datastore.
List<PhysicalRoute>	getPhysicalRoute(InventoryReader inv) Return a list of PhysicalRoute instances which indicates the physical route of the data flow.
L2Host	getSourceHost() Return the source L2 host of the data flow.
SourceHostFlowsKey	getSourceHostFlowsKey() Return the source L2 host of this data flow.
List<VirtualRoute>	getVirtualRoute() Return a list of VirtualRoute instances which indicates the virtual route of the data flow.
DataFlowInfoBuilder	toDataFlowInfoBuilder(InventoryReader inv, DataFlowMode mode) Return a DataFlowInfoBuilder that contains information about the data flow.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowCache

public FlowCache(VtnDataFlow vdf)

Construct a new instance.

Parameters:

vdf - A VtnDataFlow instance. Specifying null results in undefined behavior.

Method Detail

getDataFlow

public VtnDataFlow getDataFlow()

Return a VtnDataFlow instance associated with the target data flow.

Returns:

A VtnDataFlow instance.

getFlowEntries

public List<VtnFlowEntry> getFlowEntries()

Return a list of flow entries sorted in order of order value.

Note that this method returns unmodifiable list.

Returns:

A list of VtnFlowEntry instances.

getIngressFlow

public VtnFlowEntry getIngressFlow()

Return the ingress flow entry of the data flow.

Returns:

The first VtnFlowEntry instance in the flow entry list. null if the data flow has no flow entry.

getEgressFlow

public VtnFlowEntry getEgressFlow()

Return the egress flow entry of the data flow.

Returns:

The last VtnFlowEntry instance in the flow entry list. null if the data flow has no flow entry.

getSourceHost

public L2Host getSourceHost()

Return the source L2 host of the data flow.

Returns:

A L2Host instance if found. null if not found.

getDataFlowSource

public DataFlowSource getDataFlowSource()

Return the source L2 host of the data flow.

Returns:

A DataFlowSource instance if found. null if not found.

getEdgeHosts

public org.apache.commons.lang3.tuple.Pair<L2Host,L2Host> getEdgeHosts()

Get two L2Host instances which represents host information matched by edge flow entries.

Returns:

A Pair instance which contains two L2Host instances. A L2Host instance which represents incoming host address is set to the left side, and outgoing host address is set to the right side. Note that null may be set for outgoing host. null is returned if not found.

getVirtualRoute

public List<VirtualRoute> getVirtualRoute()

Return a list of VirtualRoute instances which indicates the virtual route of the data flow.

Note that this method returns unmodifiable list.

Returns:

A list of VirtualRoute instances.

getIngressPath

public VirtualNodePath getIngressPath()
                               throws VTNException

Return the path to the virtual node which maps the ingress flow.

Returns:

A path to virtual node which maps the ingress flow if found. null if not found.

Throws:

VTNException - An error occurred.

getEgressPath

public VirtualNodePath getEgressPath()
                              throws VTNException

Return the path to the virtual node which maps the egress flow.

Returns:

A path to virtual node which maps the egress flow if found. null if not found.

Throws:

VTNException - An error occurred.

getPhysicalRoute

public List<PhysicalRoute> getPhysicalRoute(InventoryReader inv)

Return a list of PhysicalRoute instances which indicates the physical route of the data flow.

Note that this method returns unmodifiable list.

Parameters:

inv - An InventoryReader instance.

Returns:

A list of PhysicalRoute instances. null if no physical route is configured.

getEgressActions

public List<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action> getEgressActions()

Return a list of MD-SAL flow actions configured in the egress flow entry of the data flow.

• Actions in the returned list are sorted in ascending order of flow order.
• Note that this method returns unmodifiable list.

Returns:

A list of Action instances.

toDataFlowInfoBuilder

public DataFlowInfoBuilder toDataFlowInfoBuilder(InventoryReader inv,
                                                 DataFlowMode mode)
                                          throws VTNException

Return a DataFlowInfoBuilder that contains information about the data flow.

Note that this method does not set flow statistics.

Parameters:

inv - An InventoryReader instance.

mode - A DataFlowMode instance which determines fields to copy.

Returns:

A DataFlowInfoBuilder instance.

Throws:

VTNException - An error occurred.

getKey

public VtnDataFlowKey getKey()

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

Specified by:

getKey in interface VTNDataFlow

Returns:

A VtnDataFlowKey instance.

getIngressMatchKey

public String getIngressMatchKey()
                          throws VTNException

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

Specified by:

getIngressMatchKey in interface VTNDataFlow

Returns:

A string which representse the ingress match condition.

Throws:

VTNException - An error occurred.

getFlowNodes

public Set<SalNode> getFlowNodes()

Return a set of switches related to this data flow.

Note that this method returns a read-only set.

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.

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.

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.