org.opendaylight.openflowplugin.applications.statistics.manager

Interface StatRpcMsgManager

All Superinterfaces:

AutoCloseable, Runnable

All Known Implementing Classes:

StatRpcMsgManagerImpl

public interface StatRpcMsgManager
extends Runnable, AutoCloseable

statistics-manager org.opendaylight.openflowplugin.applications.statistics.manager StatRpcMsgManager It represent access point for Device statistics RPC services which are filtered for needed methods only and they are wrapped in simply way. Many statistics responses are Multipart messages, so StatRpcMsgManager provide a functionality to add all multipart msg and provides back whole stack to listener when listener catch the last Multipart msg.

Author:

Vaclav Demcak Created: Aug 29, 2014

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	StatRpcMsgManager.RpcJobsQueue
static interface	StatRpcMsgManager.TransactionCacheContainer<T extends org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionAware> Transaction container is definition for Multipart transaction join container for all Multipart msg with same TransactionId Input DataObject is a possible light-weight DataObject which is used for identification (e.g.

Method Summary

Modifier and Type	Method and Description
<T extends org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionAware> void	addNotification(T notification, org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId nodeId) Method adds Notification which is marked as Multipart to the transaction cash to wait for the last one.
void	getAggregateFlowStat(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nodeRef, org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableId tableId) Method wraps OpendaylightFlowStatisticsService.getAggregateFlowStatisticsFromFlowTableForAllFlows and registers to Transaction Cache
Future<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId>	getAllFlowsStat(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nodeRef) Method wraps OpendaylightFlowStatisticsService.getAllFlowsStatisticsFromAllFlowTables and registers to Transaction Cache
Future<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId>	getAllGroupsConfStats(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nodeRef) Method wraps OpendaylightGroupStatisticsService.getGroupDescription and registers to Transaction Cache
Future<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId>	getAllGroupsStat(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nodeRef) Method wraps OpendaylightGroupStatisticsService.getAllGroupStatistics and registers to Transaction Cache
Future<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId>	getAllMeterConfigStat(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nodeRef) Method wraps OpendaylightMeterStatisticsService.getAllMeterConfigStatistics and registers to Transaction Cache
Future<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId>	getAllMetersStat(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nodeRef) Method wraps OpendaylightMeterStatisticsService.getAllMeterStatistics and registers to Transaction Cache
Future<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId>	getAllPortsStat(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nodeRef) Method wraps OpendaylightPortStatisticsService.getAllNodeConnectorsStatistics and registers to Transaction Cache
Future<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId>	getAllQueueStat(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nodeRef) Method wraps OpendaylightQueueStatisticsService.getAllQueuesStatisticsFromAllPorts and registers to Transaction Cache
Future<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId>	getAllTablesStat(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nodeRef) Method wraps OpendaylightFlowTableStatisticsService.getFlowTablesStatistics and registers to Transaction Cache
void	getGroupFeaturesStat(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nodeRef) Method wraps OpendaylightMeterStatisticsService.getGroupFeatures and registers to Transaction Cache
void	getMeterFeaturesStat(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nodeRef) Method wraps OpendaylightMeterStatisticsService.getMeterFeatures and registers to Transaction Cache
Future<com.google.common.base.Optional<StatRpcMsgManager.TransactionCacheContainer<?>>>	getTransactionCacheContainer(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId id, org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId nodeId) The last Multipart should inform code about possibility to take all previous messages for next processing.
Future<Boolean>	isExpectedStatistics(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId id, org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId nodeId) Method is used for check a transaction registration for multipart cache holder
<T extends org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionAware,D extends org.opendaylight.yangtools.yang.binding.DataObject> void	registrationRpcFutureCallBack(Future<org.opendaylight.yangtools.yang.common.RpcResult<T>> future, D inputObj, org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef ref, com.google.common.util.concurrent.SettableFuture<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId> resultTransId) Method converts Future object to listenenable future which is registered for Multipart Notification Statistics Collecting processing.

Methods inherited from interface java.lang.Runnable

run

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

isExpectedStatistics

Future<Boolean> isExpectedStatistics(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId id,
                                     org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId nodeId)

Method is used for check a transaction registration for multipart cache holder

Parameters:

id -

Returns:

true if the transaction has been correctly registered

registrationRpcFutureCallBack

<T extends org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionAware,D extends org.opendaylight.yangtools.yang.binding.DataObject> void registrationRpcFutureCallBack(Future<org.opendaylight.yangtools.yang.common.RpcResult<T>> future,
                                                                                                                                                                                                      D inputObj,
                                                                                                                                                                                                      org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef ref,
                                                                                                                                                                                                      com.google.common.util.concurrent.SettableFuture<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId> resultTransId)

Method converts Future object to listenenable future which is registered for Multipart Notification Statistics Collecting processing.

Parameters:

future - - result every Device RPC call

addNotification

<T extends org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionAware> void addNotification(T notification,
                                                                                                                           org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId nodeId)

Method adds Notification which is marked as Multipart to the transaction cash to wait for the last one.

Parameters:

notification -

getTransactionCacheContainer

Future<com.google.common.base.Optional<StatRpcMsgManager.TransactionCacheContainer<?>>> getTransactionCacheContainer(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId id,
                                                                                                                     org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId nodeId)

The last Multipart should inform code about possibility to take all previous messages for next processing. The method take all msg and possible input object and build all to TransactionCacheContainer Object to return. This process clean all instances in Cache.

Parameters:

id -

Returns:

TransactionCacheContainer

getAllGroupsStat

Future<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId> getAllGroupsStat(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nodeRef)

Method wraps OpendaylightGroupStatisticsService.getAllGroupStatistics and registers to Transaction Cache

Parameters:

nodeRef -

getAllGroupsConfStats

Future<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId> getAllGroupsConfStats(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nodeRef)

Method wraps OpendaylightGroupStatisticsService.getGroupDescription and registers to Transaction Cache

Parameters:

nodeRef -

getGroupFeaturesStat

void getGroupFeaturesStat(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nodeRef)

Method wraps OpendaylightMeterStatisticsService.getGroupFeatures and registers to Transaction Cache

Parameters:

nodeRef -

getAllMetersStat

Future<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId> getAllMetersStat(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nodeRef)

Method wraps OpendaylightMeterStatisticsService.getAllMeterStatistics and registers to Transaction Cache

Parameters:

nodeRef -

getAllMeterConfigStat

Future<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId> getAllMeterConfigStat(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nodeRef)

Method wraps OpendaylightMeterStatisticsService.getAllMeterConfigStatistics and registers to Transaction Cache

Parameters:

nodeRef -

getMeterFeaturesStat

void getMeterFeaturesStat(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nodeRef)

Method wraps OpendaylightMeterStatisticsService.getMeterFeatures and registers to Transaction Cache

Parameters:

nodeRef -

getAllFlowsStat

Future<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId> getAllFlowsStat(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nodeRef)

Method wraps OpendaylightFlowStatisticsService.getAllFlowsStatisticsFromAllFlowTables and registers to Transaction Cache

Parameters:

nodeRef -

getAggregateFlowStat

void getAggregateFlowStat(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nodeRef,
                          org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableId tableId)

Method wraps OpendaylightFlowStatisticsService.getAggregateFlowStatisticsFromFlowTableForAllFlows and registers to Transaction Cache

Parameters:

nodeRef -

tableId -

getAllPortsStat

Future<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId> getAllPortsStat(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nodeRef)

Method wraps OpendaylightPortStatisticsService.getAllNodeConnectorsStatistics and registers to Transaction Cache

Parameters:

nodeRef -

getAllTablesStat

Future<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId> getAllTablesStat(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nodeRef)

Method wraps OpendaylightFlowTableStatisticsService.getFlowTablesStatistics and registers to Transaction Cache

Parameters:

nodeRef -

getAllQueueStat

Future<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId> getAllQueueStat(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nodeRef)

Method wraps OpendaylightQueueStatisticsService.getAllQueuesStatisticsFromAllPorts and registers to Transaction Cache

Parameters:

nodeRef -