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

Interface VTNDataFlow

All Known Implementing Classes:

FlowCache, VTNFlowBuilder

public interface VTNDataFlow

VTNDataFlow describes a VTN data flow information in the MD-SAL datastore.

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

getKey

VtnDataFlowKey getKey()

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

Returns:

A VtnDataFlowKey instance.

getIngressMatchKey

String getIngressMatchKey()
                   throws VTNException

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

Returns:

A string which representse the ingress match condition.

Throws:

VTNException - An error occurred.

getFlowNodes

Set<SalNode> getFlowNodes()

Return a set of switches related to this data flow.

Note that this method returns a read-only set.

Returns:

A set of SalNode instances.

getFlowPorts

Set<SalPort> getFlowPorts()

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

Note that this method returns a read-only set.

Returns:

A set of SalPort instances.

getSourceHostFlowsKey

SourceHostFlowsKey getSourceHostFlowsKey()

Return the source L2 host of this data flow.

Returns:

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