org.opendaylight.openflowplugin.applications.statistics.manager

Interface StatisticsManager

All Superinterfaces:

AutoCloseable, EventListener, org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener

All Known Implementing Classes:

StatisticsManagerImpl

public interface StatisticsManager
extends AutoCloseable, org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener

statistics-manager org.opendaylight.openflowplugin.applications.statistics.manager StatisticsManager It represent a central point for whole module. Implementation StatisticsManager registers all Operation/DS StatNotifyCommiter and Config/DS StatListeningCommiter, as well as StatPermCollector for statistic collecting and StatRpcMsgManager as Device RPCs provider. In next, StatisticsManager provides all DS contact Transaction services.

Author:

Vaclav Demcak Created: Aug 27, 2014

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StatisticsManager.Pair<L,R>
static class	StatisticsManager.StatDataStoreOperation StatDataStoreOperation Interface represent functionality to submit changes to DataStore.

Method Summary

Modifier and Type	Method and Description
void	collectNextStatistics(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node> nodeIdent, TransactionId xid) Method wraps StatPermCollector.collectNextStatistics to provide parallel statCollection process for Set of Nodes.
void	connectedNodeRegistration(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node> nodeIdent, List<StatPermCollector.StatCapabTypes> statTypes, Short nrOfSwitchTables) Method wraps StatPermCollector.connectedNodeRegistration to provide parallel statCollection process for Set of Nodes.
void	disconnectedNodeUnregistration(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node> nodeIdent) Method wraps StatPermCollector.disconnectedNodeUnregistration to provide parallel statCollection process for Set of Nodes.
void	enqueue(StatisticsManager.StatDataStoreOperation inventoryOper) Method provides read/write DataStore functionality cross applyOperation defined in StatisticsManager.StatDataStoreOperation
StatisticsManagerConfig	getConfiguration()
StatListeningCommiter<Flow,OpendaylightFlowStatisticsListener>	getFlowListenComit() Define Method : Flow Config/DS data change listener -> impl.
UUID	getGeneratedUUIDForNode(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node> nodeInstanceIdentifier) A unique UUID is generated with each node added by the statistics manager implementation in order to uniquely identify a session.
StatListeningCommiter<Group,OpendaylightGroupStatisticsListener>	getGroupListenCommit() Define Method : Group Config/DS data change listener and Operation/DS notify commit functionality
StatListeningCommiter<Meter,OpendaylightMeterStatisticsListener>	getMeterListenCommit() Define Method : Meter Config/DS data change listener and Operation/DS notify commit functionality
StatNodeRegistration	getNodeRegistrator() Define Method : FlowCapableNode Operational/DS data change listener -> impl.
org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService	getOwnershipService() Getting entity-ownership-service
StatNotifyCommiter<OpendaylightPortStatisticsListener>	getPortNotifyCommit() Define Method : Port Operation/DS notify commit functionality
StatListeningCommiter<Queue,OpendaylightQueueStatisticsListener>	getQueueNotifyCommit() Define Method : Queue Config/DS change listener and Operation/DS notify commit functionality
StatRpcMsgManager	getRpcMsgManager() Method provides access to Device RPC methods by wrapped internal method.
StatNotifyCommiter<OpendaylightFlowTableStatisticsListener>	getTableNotifCommit() Define Method : Table Operation/DS notify commit functionality
boolean	isProvidedFlowNodeActive(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node> nodeIdent) Method wraps isProvidedFlowNodeActive(InstanceIdentifier) method to provide parallel statCollection process for Set of Nodes.
void	registerAdditionalNodeFeature(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node> nodeIdent, StatPermCollector.StatCapabTypes statCapab) Method wraps StatPermCollector.registerAdditionalNodeFeature to provide possibility to register additional Node Feature StatPermCollector.StatCapabTypes for statistics collecting.
void	setOwnershipService(org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService ownershipService)
void	start(org.opendaylight.controller.sal.binding.api.NotificationProviderService notifService, org.opendaylight.controller.sal.binding.api.RpcConsumerRegistry rpcRegistry) Method starts whole StatisticManager functionality
void	unregisterNodeStats(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node> nodeIdent, StatPermCollector.StatCapabTypes statCapab) Method wraps StatPermCollector.unregisterNodeStats to provide possibility to unregister Node stats type StatPermCollector.StatCapabTypes from statistics collecting.

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener

onTransactionChainFailed, onTransactionChainSuccessful

Method Detail

start

void start(org.opendaylight.controller.sal.binding.api.NotificationProviderService notifService,
           org.opendaylight.controller.sal.binding.api.RpcConsumerRegistry rpcRegistry)

Method starts whole StatisticManager functionality

Parameters:

notifService -

rpcRegistry -

enqueue

void enqueue(StatisticsManager.StatDataStoreOperation inventoryOper)

Method provides read/write DataStore functionality cross applyOperation defined in StatisticsManager.StatDataStoreOperation

Parameters:

inventoryOper - - operation for DataStore

isProvidedFlowNodeActive

boolean isProvidedFlowNodeActive(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node> nodeIdent)

Method wraps isProvidedFlowNodeActive(InstanceIdentifier) method to provide parallel statCollection process for Set of Nodes. So it has to identify correct Node Set by NodeIdentifier

Parameters:

nodeIdent -

collectNextStatistics

void collectNextStatistics(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node> nodeIdent,
                           TransactionId xid)

Method wraps StatPermCollector.collectNextStatistics to provide parallel statCollection process for Set of Nodes. So it has to identify correct Node Set by NodeIdentifier.

Parameters:

nodeIdent -

connectedNodeRegistration

void connectedNodeRegistration(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node> nodeIdent,
                               List<StatPermCollector.StatCapabTypes> statTypes,
                               Short nrOfSwitchTables)

Method wraps StatPermCollector.connectedNodeRegistration to provide parallel statCollection process for Set of Nodes. So it has to connect node to new or not full Node statCollector Set.

Parameters:

nodeIdent -

statTypes -

nrOfSwitchTables -

disconnectedNodeUnregistration

void disconnectedNodeUnregistration(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node> nodeIdent)

Method wraps StatPermCollector.disconnectedNodeUnregistration to provide parallel statCollection process for Set of Nodes. So it has to identify correct collector for disconnect node.

Parameters:

nodeIdent -

registerAdditionalNodeFeature

void registerAdditionalNodeFeature(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node> nodeIdent,
                                   StatPermCollector.StatCapabTypes statCapab)

Method wraps StatPermCollector.registerAdditionalNodeFeature to provide possibility to register additional Node Feature StatPermCollector.StatCapabTypes for statistics collecting.

Parameters:

nodeIdent -

statCapab -

unregisterNodeStats

void unregisterNodeStats(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node> nodeIdent,
                         StatPermCollector.StatCapabTypes statCapab)

Method wraps StatPermCollector.unregisterNodeStats to provide possibility to unregister Node stats type StatPermCollector.StatCapabTypes from statistics collecting.

Parameters:

nodeIdent -

statCapab -

getRpcMsgManager

StatRpcMsgManager getRpcMsgManager()

Method provides access to Device RPC methods by wrapped internal method. In next StatRpcMsgManager is registered all Multipart device msg response and joining all to be able run all collected statistics in one time (easy identification Data for delete)

Returns:

StatRpcMsgManager

getNodeRegistrator

StatNodeRegistration getNodeRegistrator()

Define Method : FlowCapableNode Operational/DS data change listener -> impl. target -> register FlowCapableNode to Statistic Collecting process

Returns:

StatNodeRegistration

getFlowListenComit

StatListeningCommiter<Flow,OpendaylightFlowStatisticsListener> getFlowListenComit()

Define Method : Flow Config/DS data change listener -> impl. target -> -> make pair between Config/DS FlowId and Device Flow response Hash

Returns:

getMeterListenCommit

StatListeningCommiter<Meter,OpendaylightMeterStatisticsListener> getMeterListenCommit()

Define Method : Meter Config/DS data change listener and Operation/DS notify commit functionality

Returns:

getGroupListenCommit

StatListeningCommiter<Group,OpendaylightGroupStatisticsListener> getGroupListenCommit()

Define Method : Group Config/DS data change listener and Operation/DS notify commit functionality

Returns:

getQueueNotifyCommit

StatListeningCommiter<Queue,OpendaylightQueueStatisticsListener> getQueueNotifyCommit()

Define Method : Queue Config/DS change listener and Operation/DS notify commit functionality

Returns:

getTableNotifCommit

StatNotifyCommiter<OpendaylightFlowTableStatisticsListener> getTableNotifCommit()

Define Method : Table Operation/DS notify commit functionality

Returns:

getPortNotifyCommit

StatNotifyCommiter<OpendaylightPortStatisticsListener> getPortNotifyCommit()

Define Method : Port Operation/DS notify commit functionality

Returns:

getConfiguration

StatisticsManagerConfig getConfiguration()

getGeneratedUUIDForNode

UUID getGeneratedUUIDForNode(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node> nodeInstanceIdentifier)

A unique UUID is generated with each node added by the statistics manager implementation in order to uniquely identify a session.

Parameters:

nodeInstanceIdentifier -

setOwnershipService

void setOwnershipService(org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService ownershipService)

getOwnershipService

org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService getOwnershipService()

Getting entity-ownership-service