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

Class FlowUtils

java.lang.Object

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

public final class FlowUtils
extends Object

FlowUtils class is a collection of utility class methods for flow entry management.

Field Summary

Fields

Modifier and Type	Field and Description
static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie	COOKIE_MASK_ALL A flow cookie mask that specifies all bits in the cookie.
static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie	COOKIE_MASK_VTN A flow cookie mask that specifies the COOKIE_MASKVAL_VTN bits.
static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie	COOKIE_MISS A fixed flow cookie for a table miss flow entry.
static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie	COOKIE_VTN A flow cookie that specifies cookie bits for VTN flows.
static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.Match	EMPTY_MATCH A MD-SAL flow match that matches every packets.
static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowModFlags	FLOW_MOD_FLAGS Flags for FLOW_MOD message that contains only SEND_FLOW_REM flag.
static long	MAX_FLOW_ID The maximum value of the VTN flow ID.
static long	MIN_FLOW_ID The minimum value of the VTN flow ID.
static short	TABLE_ID Flow Table ID to install flow entries.

Method Summary

Modifier and Type	Method and Description
static int	compare(org.opendaylight.yang.gen.v1.urn.opendaylight.model.statistics.types.rev130925.duration.Duration d1, org.opendaylight.yang.gen.v1.urn.opendaylight.model.statistics.types.rev130925.duration.Duration d2) Compare the given two Duration instances.
static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInput	createAddFlowInput(VtnFlowId flowId, VtnFlowEntry vfent) Construct an RPC input to install the specified flow entry.
static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie	createCookie(VtnFlowId fid) Create a flow cookie from the given VTN flow ID.
static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId	createMdFlowId(BigInteger id) Create a MD-SAL flow ID to be associated with the ingress flow entry in a VTN data flow.
static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId	createMdFlowId(BigInteger id, Integer index) Create a MD-SAL flow ID to be associated with a flow entry in a VTN data flow.
static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowInputBuilder	createRemoveFlowInputBuilder(SalNode snode) Construct an RPC input builder to uninstall all the VTN flow entries from the given switch.
static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowInputBuilder	createRemoveFlowInputBuilder(SalNode snode, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.Flow flow, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri uri) Construct an RPC input builder to uninstall the specified MD-SAL flow entry.
static List<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowInputBuilder>	createRemoveFlowInputBuilder(SalNode snode, SalPort sport) Construct an RPC input builder to uninstall flow entries related to the given switch port.
static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowInputBuilder	createRemoveFlowInputBuilder(SalNode snode, VtnFlowEntry vfent) Construct an RPC input builder to uninstall the specified flow entry.
static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowInputBuilder	createRemoveFlowInputBuilder(SalNode snode, VtnFlowEntry vfent, InventoryReader reader) Construct an RPC input builder to uninstall the specified flow entry.
static String	createTableMissFlowId(SalNode snode) Create a MD-SAL flow ID to be associated with a table miss flow entry.
static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInput	createTableMissInput(SalNode snode) Construct an RPC input to install a table miss flow entry for the specified switch.
static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri	createTxUri(VtnFlowEntry vfent, String prefix) Create a MD-SAL transaction URI for the given flow entryu.
static boolean	equalsFlowTimeoutConfig(VtnFlowTimeoutConfig vftc1, VtnFlowTimeoutConfig vftc2) Determine whether the given two VtnFlowTimeoutConfig instances contain the same configuration or not.
static List<VtnFlowTable>	getFlowTables(org.opendaylight.controller.md.sal.binding.api.ReadTransaction tx) Return a list of all existing VTN flow tables.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnFlowTable>	getIdentifier(String name) Create the instance identifier for the VTN flow table.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<MatchFlows>	getIdentifier(String name, MatchFlowsKey cond) Create the instance identifier for the flow index for the given flow match condition.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<PortFlows>	getIdentifier(String name, org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId portId) Create the instance identifier for the flow index for the given switch port.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<NodeFlows>	getIdentifier(String name, org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId nodeId) Create the instance identifier for the flow index for the given switch.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<SourceHostFlows>	getIdentifier(String name, SourceHostFlowsKey hostId) Create the instance identifier for the flow index for the given source L2 host.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnDataFlow>	getIdentifier(String name, VtnDataFlowKey flowKey) Create the instance identifier for the specified data flow.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnDataFlow>	getIdentifier(String name, VtnFlowId flowId) Create the instance identifier for the specified data flow.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnFlowTable>	getIdentifier(VtnFlowTableKey key) Create the instance identifier for the VTN flow table.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<NodeFlows>	getIdentifier(VtnFlowTableKey key, NodeFlowsKey nodeKey) Create the instance identifier for the flow index for the given switch.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<PortFlows>	getIdentifier(VtnFlowTableKey key, PortFlowsKey portKey) Create the instance identifier for the flow index for the given switch port.
static VtnFlowId	getInitialFlowId() Return the initial value of the VTN flow ID.
static short	getTableId(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.GenericFlowAttributes flow) Return the table ID configured in the given MD-SAL flow.
static VtnFlowId	getVtnFlowId(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie cookie) Return the VTN flow ID embedded in the given flow cookie.
static boolean	removeDataFlow(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx, String tname, VTNDataFlow df) Remove the given data flow from the MD-SAL datastore.
static void	removedLog(org.slf4j.Logger logger, String desc, FlowCache fc) Record a debug log message which indicates the specified data flow has been removed.
static RemoveFlowRpcList	removeFlowEntries(FlowRpcWatcher watcher, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowService sfs, List<FlowCache> flows, InventoryReader reader) Remove all flow entries in the given VTN data flows.
static RemoveFlowRpcList	removeFlowEntries(FlowRpcWatcher watcher, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowService sfs, List<FlowCache> flows, SalPort sport, InventoryReader reader) Remove all flow entries in the given VTN data flows.
static <T extends FlowIdSet> boolean	removeFlowIdSet(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> path) Remove the given flow ID set if it is empty.
static void	removeIndex(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnFlowTable> path, VTNDataFlow df) Remove the given data flow from all flow indices in the MD-SAL datastore.
static void	removeIndex(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnFlowTable> path, VTNDataFlow df, FlowIdListKey idKey) Remove the given data flow from all flow indices in the MD-SAL datastore.
static void	setDescription(StringBuilder builder, VtnFlowTimeoutConfig vftc, String separator) Append strings that describes the specified flow timeout configuration into the specified string builder.
static void	verifyFlowTimeout(Integer idle, Integer hard) Verify the given flow timeout values.
static void	verifyFlowTimeout(Integer idle, Integer hard, boolean present) Verify the given flow timeout values.
static void	verifyFlowTimeout(VtnFlowTimeoutConfig vftc) Verify timeout values in the given VtnFlowTimeoutConfig instance.

Methods inherited from class java.lang.Object

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

Field Detail

TABLE_ID

public static final short TABLE_ID

Flow Table ID to install flow entries.

See Also:

Constant Field Values

COOKIE_VTN

public static final org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie COOKIE_VTN

A flow cookie that specifies cookie bits for VTN flows.

COOKIE_MISS

public static final org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie COOKIE_MISS

A fixed flow cookie for a table miss flow entry.

COOKIE_MASK_ALL

public static final org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie COOKIE_MASK_ALL

A flow cookie mask that specifies all bits in the cookie.

COOKIE_MASK_VTN

public static final org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie COOKIE_MASK_VTN

A flow cookie mask that specifies the COOKIE_MASKVAL_VTN bits.

MIN_FLOW_ID

public static final long MIN_FLOW_ID

The minimum value of the VTN flow ID.

See Also:

Constant Field Values

MAX_FLOW_ID

public static final long MAX_FLOW_ID

The maximum value of the VTN flow ID.

See Also:

Constant Field Values

EMPTY_MATCH

public static final org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.Match EMPTY_MATCH

A MD-SAL flow match that matches every packets.

FLOW_MOD_FLAGS

public static final org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowModFlags FLOW_MOD_FLAGS

Flags for FLOW_MOD message that contains only SEND_FLOW_REM flag.

Method Detail

verifyFlowTimeout

public static void verifyFlowTimeout(Integer idle,
                                     Integer hard)
                              throws RpcException

Verify the given flow timeout values.

Parameters:

idle - The idle-timeout value.

hard - The hard-timeout value.

Throws:

RpcException - The given flow timeout values are invalid.

verifyFlowTimeout

public static void verifyFlowTimeout(Integer idle,
                                     Integer hard,
                                     boolean present)
                              throws RpcException

Verify the given flow timeout values.

Parameters:

idle - The idle-timeout value.

hard - The hard-timeout value.

present - true means that the flow timeout configuration must be present.

Throws:

RpcException - The given flow timeout values are invalid.

verifyFlowTimeout

public static void verifyFlowTimeout(VtnFlowTimeoutConfig vftc)
                              throws RpcException

Verify timeout values in the given VtnFlowTimeoutConfig instance.

Parameters:

vftc - A VtnFlowTimeoutConfig instance.

Throws:

RpcException - The given instance contains invalid timeout values.

equalsFlowTimeoutConfig

public static boolean equalsFlowTimeoutConfig(VtnFlowTimeoutConfig vftc1,
                                              VtnFlowTimeoutConfig vftc2)

Determine whether the given two VtnFlowTimeoutConfig instances contain the same configuration or not.

Parameters:

vftc1 - The first instance to be compared.

vftc2 - The second instance to be compared.

Returns:

true only if the given instances contains the same configuration.

setDescription

public static void setDescription(StringBuilder builder,
                                  VtnFlowTimeoutConfig vftc,
                                  String separator)

Append strings that describes the specified flow timeout configuration into the specified string builder.

Parameters:

builder - A string builder.

vftc - The flow timeout configuration.

separator - A string to be used for field separator.

getInitialFlowId

public static VtnFlowId getInitialFlowId()

Return the initial value of the VTN flow ID.

Returns:

The initial value of the VTN flow ID.

compare

public static int compare(org.opendaylight.yang.gen.v1.urn.opendaylight.model.statistics.types.rev130925.duration.Duration d1,
                          org.opendaylight.yang.gen.v1.urn.opendaylight.model.statistics.types.rev130925.duration.Duration d2)

Compare the given two Duration instances.

Parameters:

d1 - The first instance to be compared.

d2 - The second instance to be compared.

Returns:

A negative integer, zero, or a positive integer as the first instance is less than, equal to, or greater than the second instance.

createCookie

public static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie createCookie(VtnFlowId fid)

Create a flow cookie from the given VTN flow ID.

Parameters:

fid - The identifier of the VTN data flow.

Returns:

A FlowCookie instance.

getVtnFlowId

public static VtnFlowId getVtnFlowId(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie cookie)

Return the VTN flow ID embedded in the given flow cookie.

Parameters:

cookie - A FlowCookie instance.

Returns:

A VtnFlowId instance on success. null on failure.

getIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnFlowTable> getIdentifier(String name)

Create the instance identifier for the VTN flow table.

Parameters:

name - The name of the VTN.

Returns:

An InstanceIdentifier instance.

getIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnFlowTable> getIdentifier(VtnFlowTableKey key)

Create the instance identifier for the VTN flow table.

Parameters:

key - A VtnFlowTableKey which contains the name of the target VTN.

Returns:

An InstanceIdentifier instance.

getIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnDataFlow> getIdentifier(String name,
                                                                                                    VtnFlowId flowId)

Create the instance identifier for the specified data flow.

Parameters:

name - The name of the VTN.

flowId - The flow identifier.

Returns:

An InstanceIdentifier instance.

getIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnDataFlow> getIdentifier(String name,
                                                                                                    VtnDataFlowKey flowKey)

Create the instance identifier for the specified data flow.

Parameters:

name - The name of the VTN.

flowKey - A VtnDataFlowKey instance which contains the target flow ID.

Returns:

An InstanceIdentifier instance.

getIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<NodeFlows> getIdentifier(String name,
                                                                                                  org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId nodeId)

Create the instance identifier for the flow index for the given switch.

Parameters:

name - The name of the VTN.

nodeId - A NodeId instance.

Returns:

An InstanceIdentifier instance.

getIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<NodeFlows> getIdentifier(VtnFlowTableKey key,
                                                                                                  NodeFlowsKey nodeKey)

Create the instance identifier for the flow index for the given switch.

Parameters:

key - A VtnFlowTableKey which contains the name of the target VTN.

nodeKey - A NodeFlowsKey instance which contains the target node identifier.

Returns:

An InstanceIdentifier instance.

getIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<PortFlows> getIdentifier(String name,
                                                                                                  org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId portId)

Create the instance identifier for the flow index for the given switch port.

Parameters:

name - The name of the VTN.

portId - A NodeConnectorId instance.

Returns:

An InstanceIdentifier instance.

getIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<PortFlows> getIdentifier(VtnFlowTableKey key,
                                                                                                  PortFlowsKey portKey)

Create the instance identifier for the flow index for the given switch port.

Parameters:

key - A VtnFlowTableKey which contains the name of the target VTN.

portKey - A PortFlowsKey instance which contains the target port identifier.

Returns:

An InstanceIdentifier instance.

getIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<SourceHostFlows> getIdentifier(String name,
                                                                                                        SourceHostFlowsKey hostId)

Create the instance identifier for the flow index for the given source L2 host.

Parameters:

name - The name of the VTN.

hostId - A SourceHostFlowsKey instance.

Returns:

An InstanceIdentifier instance.

getIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<MatchFlows> getIdentifier(String name,
                                                                                                   MatchFlowsKey cond)

Create the instance identifier for the flow index for the given flow match condition.

Parameters:

name - The name of the VTN.

cond - A string which indicates the ingress flow match.

Returns:

An InstanceIdentifier instance.

createTxUri

public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri createTxUri(VtnFlowEntry vfent,
                                                                                                                 String prefix)

Create a MD-SAL transaction URI for the given flow entryu.

Parameters:

vfent - A VtnFlowEntry instance.

prefix - Prefix of the URI.

Returns:

An Uri instance.

createAddFlowInput

public static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInput createAddFlowInput(VtnFlowId flowId,
                                                                                                                   VtnFlowEntry vfent)

Construct an RPC input to install the specified flow entry.

Parameters:

flowId - A VTN flow ID.

vfent - A VtnFlowEntry instance.

Returns:

A AddFlowInput instance.

createMdFlowId

public static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId createMdFlowId(BigInteger id)

Create a MD-SAL flow ID to be associated with the ingress flow entry in a VTN data flow.

Parameters:

id - A VTN flow ID.

Returns:

A MD-SAL flow ID.

createMdFlowId

public static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId createMdFlowId(BigInteger id,
                                                                                                           Integer index)

Create a MD-SAL flow ID to be associated with a flow entry in a VTN data flow.

Parameters:

id - A VTN flow ID.

index - An index value that specifies a flow entry in a VTN data flow.

Returns:

A MD-SAL flow ID.

createTableMissFlowId

public static String createTableMissFlowId(SalNode snode)

Create a MD-SAL flow ID to be associated with a table miss flow entry.

Parameters:

snode - A SalNode instance that specifies the target switch.

Returns:

A MD-SAL flow ID.

createTableMissInput

public static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInput createTableMissInput(SalNode snode)

Construct an RPC input to install a table miss flow entry for the specified switch.

Parameters:

snode - A SalNode instance which specifies the target switch.

Returns:

An AddFlowInput instance.

createRemoveFlowInputBuilder

@Nonnull
public static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowInputBuilder createRemoveFlowInputBuilder(SalNode snode)

Construct an RPC input builder to uninstall all the VTN flow entries from the given switch.

Note that the caller must ensure that the specified switch is present and supports OF 1.3 protocol.

Parameters:

snode - A SalNode instance which specifies the target switch.

Returns:

A RemoveFlowInputBuilder instance. Note that this method never sets barrier flag into the returned input builder.

createRemoveFlowInputBuilder

@Nullable
public static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowInputBuilder createRemoveFlowInputBuilder(SalNode snode,
                                                                                                                                                 VtnFlowEntry vfent,
                                                                                                                                                 InventoryReader reader)
                                                                                                                                          throws VTNException

Construct an RPC input builder to uninstall the specified flow entry.

Parameters:

snode - A SalNode instance which specifies the target switch.

vfent - A VtnFlowEntry instance.

reader - A InventoryReader instance.

Returns:

A RemoveFlowInputBuilder instance on success. null if the target node is not present. Note that this method never sets barrier flag into the returned input builder.

Throws:

VTNException - An error occurred.

createRemoveFlowInputBuilder

@Nonnull
public static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowInputBuilder createRemoveFlowInputBuilder(SalNode snode,
                                                                                                                                                VtnFlowEntry vfent)

Construct an RPC input builder to uninstall the specified flow entry.

Note that the caller must ensure that the specified switch is present.

Parameters:

snode - A SalNode instance which specifies the target switch.

vfent - A VtnFlowEntry instance.

Returns:

A RemoveFlowInputBuilder instance. Note that this method never sets barrier flag into the returned input builder.

createRemoveFlowInputBuilder

@Nonnull
public static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowInputBuilder createRemoveFlowInputBuilder(SalNode snode,
                                                                                                                                                org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.Flow flow,
                                                                                                                                                org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri uri)

Construct an RPC input builder to uninstall the specified MD-SAL flow entry.

Note that the caller must ensure that the specified switch is present.

Parameters:

snode - A SalNode instance which specifies the target switch.

flow - A Flow instance.

uri - A Uri to be assigned to the input.

Returns:

A RemoveFlowInputBuilder instance. Note that this method never sets barrier flag into the returned input builder.

createRemoveFlowInputBuilder

@Nonnull
public static List<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowInputBuilder> createRemoveFlowInputBuilder(SalNode snode,
                                                                                                                                                      SalPort sport)

Construct an RPC input builder to uninstall flow entries related to the given switch port.

This method returns a bulk flow remove request to uninstall the following flow entries.

• Flow entries that match packets received from the given port.
• Flow entries that transmit packets to the given port.

Note that the caller must ensure that the specified switch is present.

Parameters:

snode - A SalNode instance which specifies the target switch.

sport - A SalPort instance which specifies the switch port.

Returns:

A list of RemoveFlowInputBuilder instances. Note that this method never sets barrier flag into the returned input builder.

removeFlowIdSet

public static <T extends FlowIdSet> boolean removeFlowIdSet(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx,
                                                            org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> path)
                                                     throws VTNException

Remove the given flow ID set if it is empty.

Type Parameters:

T - The type of the flow ID set.

Parameters:

tx - A ReadWriteTransaction instance.

path - Path to the flow ID set.

Returns:

true if the specified flow ID set was removed. Otherwise false.

Throws:

VTNException - An error occurred.

removeIndex

public static void removeIndex(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx,
                               org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnFlowTable> path,
                               VTNDataFlow df)
                        throws VTNException

Remove the given data flow from all flow indices in the MD-SAL datastore.

Parameters:

tx - A ReadWriteTransaction instance.

path - Path to the VTN flow table in the MD-SAL datastore.

df - A VTNDataFlow instance.

Throws:

VTNException - An error occurred.

removeIndex

public static void removeIndex(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx,
                               org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnFlowTable> path,
                               VTNDataFlow df,
                               FlowIdListKey idKey)
                        throws VTNException

Remove the given data flow from all flow indices in the MD-SAL datastore.

Parameters:

tx - A ReadWriteTransaction instance.

path - Path to the VTN flow table in the MD-SAL datastore.

df - A VTNDataFlow instance.

idKey - A FlowIdListKey instance which contains the data flow identifier.

Throws:

VTNException - An error occurred.

removeDataFlow

public static boolean removeDataFlow(org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction tx,
                                     String tname,
                                     VTNDataFlow df)
                              throws VTNException

Remove the given data flow from the MD-SAL datastore.

Parameters:

tx - A ReadWriteTransaction instance.

tname - The name of the VTN.

df - A VTNDataFlow instance.

Returns:

true if the specified data flow was removed. false if the specified data flow is not present.

Throws:

VTNException - An error occurred.

removeFlowEntries

public static RemoveFlowRpcList removeFlowEntries(FlowRpcWatcher watcher,
                                                  org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowService sfs,
                                                  List<FlowCache> flows,
                                                  InventoryReader reader)
                                           throws VTNException

Remove all flow entries in the given VTN data flows.

Parameters:

watcher - The flow RPC watcher.

sfs - MD-SAL flow service.

flows - A list of FlowCache instances.

reader - A InventoryReader instance.

Returns:

A RemoveFlowRpcList instance.

Throws:

VTNException - An error occurred.

removeFlowEntries

public static RemoveFlowRpcList removeFlowEntries(FlowRpcWatcher watcher,
                                                  org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowService sfs,
                                                  List<FlowCache> flows,
                                                  SalPort sport,
                                                  InventoryReader reader)
                                           throws VTNException

Remove all flow entries in the given VTN data flows.

Flow entries related to the given switch port will be unsinstalled by a bulk flow remove request.

Parameters:

watcher - The node-routed RPC watcher.

sfs - MD-SAL flow service.

flows - A list of FlowCache instances.

sport - A SalPort instance which specifies the switch port.

reader - A InventoryReader instance.

Returns:

A RemoveFlowRpcList instance.

Throws:

VTNException - An error occurred.

getFlowTables

public static List<VtnFlowTable> getFlowTables(org.opendaylight.controller.md.sal.binding.api.ReadTransaction tx)
                                        throws VTNException

Return a list of all existing VTN flow tables.

Parameters:

tx - A ReadTransaction instance.

Returns:

A list of VTN flow tables.

Throws:

VTNException - An error occurred.

removedLog

public static void removedLog(org.slf4j.Logger logger,
                              String desc,
                              FlowCache fc)

Record a debug log message which indicates the specified data flow has been removed.

Parameters:

logger - A logger instance.

desc - A brief description about flow remover.

fc - A FlowCache instance which contains the removed data flow.

getTableId

public static short getTableId(@Nonnull
                               org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.GenericFlowAttributes flow)

Return the table ID configured in the given MD-SAL flow.

Parameters:

flow - The MD-SAL flow.

Returns:

The table ID in the given MD-SAL flow. Note that this method returns zero if no table ID is present in the given MD-SAL flow. This is because OF 1.0 flow does not have table ID.