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

Class FlowStatsUtils

java.lang.Object

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

public final class FlowStatsUtils
extends Object

FlowStatsUtils class is a collection of utility class methods for flow statistics management.

Method Summary

Modifier and Type	Method and Description
static FlowStatsHistory	addNonPeriodic(FlowStatsHistory history, FlowStatsRecord newRecord) Add a non-periodic flow statistics record to the statistics history.
static FlowStatsHistory	addPeriodic(FlowStatsHistory history, Long sysTime, org.opendaylight.yang.gen.v1.urn.opendaylight.model.statistics.types.rev130925.GenericStatistics gstats) Add a periodic flow statistics record to the statistics history.
static String	check(org.opendaylight.yang.gen.v1.urn.opendaylight.model.statistics.types.rev130925.GenericStatistics fstats) Ensure that the given flow statistics contains valid values.
static org.opendaylight.yang.gen.v1.urn.opendaylight.direct.statistics.rev160511.GetFlowStatisticsInput	createGetFlowStatsInput(SalNode snode) Construct an RPC input which requests statistics information about all VTN flow entries present in the given switch.
static org.opendaylight.yang.gen.v1.urn.opendaylight.direct.statistics.rev160511.GetFlowStatisticsInput	createGetFlowStatsInput(VtnFlowEntry vfent) Construct an RPC input which requests flow statistics for the given VTN flow entry.
static String	createTransactionKey(String nid, BigInteger xid) Create a key string which identifies the transaction for getting flow statistics from switch.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.flow.statistics.FlowStatistics>	getIdentifier(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId node, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId flowId) Create the instance identifier of the statistics information for the given MD-SAL flow.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<FlowStatsHistory>	getIdentifier(String name, VtnDataFlowKey flowKey) Create the instance identifier for the statistics history of the given VTN data flow.
static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.flow.statistics.FlowStatistics	read(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx, org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId node, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId flowId) Read statistics information for the given MD-SAL flow.
static NavigableMap<Long,FlowStatsRecord>	toNavigableMap(FlowStatsHistory history) Put all the flow statistics records in the given statistics history into a new navigable map.

Methods inherited from class java.lang.Object

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

Method Detail

getIdentifier

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

Create the instance identifier for the statistics history of the given VTN 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<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.flow.statistics.FlowStatistics> getIdentifier(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId node,
                                                                                                                                                                                               org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId flowId)

Create the instance identifier of the statistics information for the given MD-SAL flow.

Parameters:

node - The MD-SAL node identifier.

flowId - The MD-SAL flow identifier.

Returns:

An InstanceIdentifier instance.

createGetFlowStatsInput

public static org.opendaylight.yang.gen.v1.urn.opendaylight.direct.statistics.rev160511.GetFlowStatisticsInput createGetFlowStatsInput(VtnFlowEntry vfent)

Construct an RPC input which requests flow statistics for the given VTN flow entry.

Parameters:

vfent - The target VTN flow entry.

Returns:

A GetFlowStatisticsInput instance.

createGetFlowStatsInput

public static org.opendaylight.yang.gen.v1.urn.opendaylight.direct.statistics.rev160511.GetFlowStatisticsInput createGetFlowStatsInput(SalNode snode)

Construct an RPC input which requests statistics information about all VTN flow entries present in the given switch.

Note that this method uses flow cookie to select VTN flow entries. So OpenFlow 1.0 switch will return all the flow entries when it receives an input returned by this method.

Parameters:

snode - A SalNode instance which specifies the target switch.

Returns:

A GetFlowStatisticsInput instance.

read

public static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.flow.statistics.FlowStatistics read(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx,
                                                                                                                          org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId node,
                                                                                                                          org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId flowId)
                                                                                                                   throws VTNException

Read statistics information for the given MD-SAL flow.

Parameters:

rtx - A ReadTransaction instance.

node - The MD-SAL node identifier.

flowId - The MD-SAL flow identifier.

Returns:

A FlowStatistics instance if available. null if not available.

Throws:

VTNException - An error occurred.

check

public static String check(org.opendaylight.yang.gen.v1.urn.opendaylight.model.statistics.types.rev130925.GenericStatistics fstats)

Ensure that the given flow statistics contains valid values.

Parameters:

fstats - A flow statistics to be checked.

Returns:

null if the given flow statistics is valid. An error message if the given flow statistics is invalid.

toNavigableMap

public static NavigableMap<Long,FlowStatsRecord> toNavigableMap(FlowStatsHistory history)

Put all the flow statistics records in the given statistics history into a new navigable map.

All statistics records are associated with its creation time in a returned map.

Parameters:

history - History of flow statistics.

Returns:

A NavigableMap instance.

addPeriodic

public static FlowStatsHistory addPeriodic(FlowStatsHistory history,
                                           Long sysTime,
                                           org.opendaylight.yang.gen.v1.urn.opendaylight.model.statistics.types.rev130925.GenericStatistics gstats)

Add a periodic flow statistics record to the statistics history.

Parameters:

history - History of flow statistics.

sysTime - The system time when the statistics is derived.

gstats - A statistics record to be added.

Returns:

A FlowStatsHistory instance.

addNonPeriodic

public static FlowStatsHistory addNonPeriodic(FlowStatsHistory history,
                                              FlowStatsRecord newRecord)

Add a non-periodic flow statistics record to the statistics history.

Parameters:

history - History of flow statistics.

newRecord - A flow statistics record to be added. Note that periodic flag in this record must be false.

Returns:

A FlowStatsHistory instance if the statistics history needs to be updated. Otherwise null.

createTransactionKey

public static String createTransactionKey(String nid,
                                          BigInteger xid)

Create a key string which identifies the transaction for getting flow statistics from switch.

Parameters:

nid - A MD-SAL node identifier which specifies the switch.

xid - A OpenFlow transaction ID.

Returns:

A key string which identifies the read transaction.