org.opendaylight.openflowplugin.applications.frm

Interface ForwardingRulesManager

All Superinterfaces:

AutoCloseable, ConfigurationListener

All Known Implementing Classes:

ForwardingRulesManagerImpl

public interface ForwardingRulesManager
extends ConfigurationListener, AutoCloseable

It represent a central point for whole module. Implementation Flow Provider registers the link FlowChangeListener} and it holds all needed services for link FlowChangeListener}.

Author:

Vaclav Demcak

Method Summary

Modifier and Type	Method and Description
boolean	checkNodeInOperationalDataStore(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<FlowCapableNode> ident) Method returns information : "is Node with send InstanceIdentifier present in operational data store"?.
ForwardingRulesCommiter<Flow>	getFlowCommiter() Content definition method and prevent code duplicity in Reconcil.
FlowNodeConnectorInventoryTranslatorImpl	getFlowNodeConnectorInventoryTranslatorImpl() Content definition method and prevent code duplicity.
ForwardingRulesCommiter<Group>	getGroupCommiter() Content definition method and prevent code duplicity in Reconcil.
ForwardingRulesCommiter<Meter>	getMeterCommiter() Content definition method and prevent code duplicity.
String	getNewTransactionId() Method returns generated transaction ID, which is unique for every transaction.
org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction	getReadTranaction() Method returns Read Transaction.
int	getReconciliationRetryCount() Return number of reconciliation retry are allowed.
SalBundleService	getSalBundleService() Bundle RPC service.
SalFlowService	getSalFlowService() Flow RPC service.
SalGroupService	getSalGroupService() Group RPC service.
SalMeterService	getSalMeterService() Meter RPC service.
SalTableService	getSalTableService() Table RPC service.
ForwardingRulesCommiter<TableFeatures>	getTableFeaturesCommiter() Content definition method and prevent code duplicity.
boolean	isBundleBasedReconciliationEnabled() holds the value read from the configuration file openflowplugin.cfg file.
boolean	isNodeActive(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<FlowCapableNode> ident) Method returns information : "is Node with send InstanceIdentifier connected"?.
boolean	isNodeOwner(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<FlowCapableNode> ident) Method checks if *this* instance of openflowplugin is owner of the given openflow node.
boolean	isReconciliationDisabled() Check if reconciliation is disabled by user.
boolean	isStaleMarkingEnabled() Check if stale marking is enabled for switch reconciliation.
void	start()

Methods inherited from interface org.opendaylight.openflowplugin.api.openflow.configuration.ConfigurationListener

onPropertyChanged

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

start

void start()

isNodeActive

boolean isNodeActive(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<FlowCapableNode> ident)

Method returns information : "is Node with send InstanceIdentifier connected"?.

Parameters:

ident - - the key of the node

Returns:

boolean - true if device is connected

checkNodeInOperationalDataStore

boolean checkNodeInOperationalDataStore(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<FlowCapableNode> ident)

Method returns information : "is Node with send InstanceIdentifier present in operational data store"?.

Parameters:

ident - - the key of the node

Returns:

boolean - true if device is present in operational data store

getNewTransactionId

String getNewTransactionId()

Method returns generated transaction ID, which is unique for every transaction. ID is composite from prefix ("DOM") and unique number.

Returns:

String transactionID for RPC transaction identification

getReadTranaction

org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction getReadTranaction()

Method returns Read Transaction. It is need for Node reconciliation only.

Returns:

ReadOnlyTransaction

getSalFlowService

SalFlowService getSalFlowService()

Flow RPC service.

getSalGroupService

SalGroupService getSalGroupService()

Group RPC service.

getSalMeterService

SalMeterService getSalMeterService()

Meter RPC service.

getSalTableService

SalTableService getSalTableService()

Table RPC service.

getSalBundleService

SalBundleService getSalBundleService()

Bundle RPC service.

Returns:

salBundleService

getFlowCommiter

ForwardingRulesCommiter<Flow> getFlowCommiter()

Content definition method and prevent code duplicity in Reconcil.

Returns:

ForwardingRulesCommiter<Flow>.

getGroupCommiter

ForwardingRulesCommiter<Group> getGroupCommiter()

Content definition method and prevent code duplicity in Reconcil.

Returns:

ForwardingRulesCommiter<Group>

getMeterCommiter

ForwardingRulesCommiter<Meter> getMeterCommiter()

Content definition method and prevent code duplicity.

Returns:

ForwardingRulesCommiter<Meter>

getTableFeaturesCommiter

ForwardingRulesCommiter<TableFeatures> getTableFeaturesCommiter()

Content definition method and prevent code duplicity.

Returns:

ForwardingRulesCommiter<Table>

isReconciliationDisabled

boolean isReconciliationDisabled()

Check if reconciliation is disabled by user.

Returns:

true if reconciliation is disabled, else false

isStaleMarkingEnabled

boolean isStaleMarkingEnabled()

Check if stale marking is enabled for switch reconciliation.

Returns:

true if stale marking is enabled, else false

getReconciliationRetryCount

int getReconciliationRetryCount()

Return number of reconciliation retry are allowed.

Returns:

number of retries.

isNodeOwner

boolean isNodeOwner(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<FlowCapableNode> ident)

Method checks if *this* instance of openflowplugin is owner of the given openflow node.

Returns:

True if owner, else false

getFlowNodeConnectorInventoryTranslatorImpl

FlowNodeConnectorInventoryTranslatorImpl getFlowNodeConnectorInventoryTranslatorImpl()

Content definition method and prevent code duplicity.

Returns:

FlowNodeConnectorInventoryTranslatorImpl

isBundleBasedReconciliationEnabled

boolean isBundleBasedReconciliationEnabled()

holds the value read from the configuration file openflowplugin.cfg file.

Returns:

True if user enables bundle-based-reconciliation-enabled field in config file or False