Encapsulate OpenFlowPlugin configuration
[openflowplugin.git] / applications / forwardingrules-manager / src / main / java / org / opendaylight / openflowplugin / applications / frm / ForwardingRulesManager.java
index d76dc97be9e04a4ebfde5c7449101d9aa310d903..2bfd84037f68d551544128968f062b404525d74a 100644 (file)
@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
+ * Copyright (c) 2014, 2017 Cisco Systems, Inc. and others.  All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
@@ -8,10 +8,9 @@
 
 package org.opendaylight.openflowplugin.applications.frm;
 
-import org.opendaylight.openflowplugin.applications.frm.impl.ForwardingRulesManagerConfig;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeatures;
-
 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
+import org.opendaylight.openflowplugin.api.openflow.configuration.ConfigurationListener;
+import org.opendaylight.openflowplugin.applications.frm.impl.FlowNodeConnectorInventoryTranslatorImpl;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.Meter;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
@@ -20,24 +19,19 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.Sal
 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.SalMeterService;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.service.rev131026.SalTableService;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeatures;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 
 /**
- * forwardingrules-manager
- * org.opendaylight.openflowplugin.applications.frm
- *
- * ForwardingRulesManager
- * It represent a central point for whole modul. Implementation
+ * 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 <a href="mailto:vdemcak@cisco.com">Vaclav Demcak</a>
- *
- * Created: Aug 25, 2014
  */
-public interface ForwardingRulesManager extends AutoCloseable {
+public interface ForwardingRulesManager extends ConfigurationListener, AutoCloseable {
 
-    public void start();
+    void start();
 
     /**
      * Method returns information :
@@ -46,7 +40,7 @@ public interface ForwardingRulesManager extends AutoCloseable {
      * @param ident - the key of the node
      * @return boolean - true if device is connected
      */
-    public boolean isNodeActive(InstanceIdentifier<FlowCapableNode> ident);
+    boolean isNodeActive(InstanceIdentifier<FlowCapableNode> ident);
 
     /**
      * Method returns information :
@@ -55,25 +49,7 @@ public interface ForwardingRulesManager extends AutoCloseable {
      * @param ident - the key of the node
      * @return boolean - true if device is present in operational data store
      */
-    public boolean checkNodeInOperationalDataStore(InstanceIdentifier<FlowCapableNode> ident);
-
-    /**
-     * Method add new {@link FlowCapableNode} to active Node Holder.
-     * ActiveNodeHolder prevent unnecessary Operational/DS read for identify
-     * pre-configure and serious Configure/DS transactions.
-     *
-     * @param ident - the key of the node
-     */
-    public void registrateNewNode(InstanceIdentifier<FlowCapableNode> ident);
-
-    /**
-     * Method remove disconnected {@link FlowCapableNode} from active Node
-     * Holder. And all next flows or groups or meters will stay in Config/DS
-     * only.
-     *
-     * @param ident - the key of the node
-     */
-    public void unregistrateNode(InstanceIdentifier<FlowCapableNode> ident);
+    boolean checkNodeInOperationalDataStore(InstanceIdentifier<FlowCapableNode> ident);
 
     /**
      * Method returns generated transaction ID, which is unique for
@@ -81,85 +57,97 @@ public interface ForwardingRulesManager extends AutoCloseable {
      *
      * @return String transactionID for RPC transaction identification
      */
-    public String getNewTransactionId();
+    String getNewTransactionId();
 
     /**
      * Method returns Read Transacion. It is need for Node reconciliation only.
      *
      * @return ReadOnlyTransaction
      */
-    public ReadOnlyTransaction getReadTranaction();
+    ReadOnlyTransaction getReadTranaction();
 
     /**
      * Flow RPC service
      *
      * @return
      */
-    public SalFlowService getSalFlowService();
+    SalFlowService getSalFlowService();
 
     /**
      * Group RPC service
      *
      * @return
      */
-    public SalGroupService getSalGroupService();
+    SalGroupService getSalGroupService();
 
     /**
      * Meter RPC service
      *
      * @return
      */
-    public SalMeterService getSalMeterService();
+    SalMeterService getSalMeterService();
 
     /**
      * Table RPC service
      *
      * @return
      */
-    public SalTableService getSalTableService();
+    SalTableService getSalTableService();
 
     /**
      * Content definition method and prevent code duplicity in Reconcil
      * @return ForwardingRulesCommiter&lt;Flow&gt;
      */
-    public ForwardingRulesCommiter<Flow> getFlowCommiter();
+    ForwardingRulesCommiter<Flow> getFlowCommiter();
 
     /**
      * Content definition method and prevent code duplicity in Reconcil
      * @return ForwardingRulesCommiter&lt;Group&gt;
      */
-    public ForwardingRulesCommiter<Group> getGroupCommiter();
+    ForwardingRulesCommiter<Group> getGroupCommiter();
 
     /**
      * Content definition method and prevent code duplicity
      * @return ForwardingRulesCommiter&lt;Meter&gt;
      */
-    public ForwardingRulesCommiter<Meter> getMeterCommiter();
+    ForwardingRulesCommiter<Meter> getMeterCommiter();
 
     /**
      * Content definition method and prevent code duplicity
      * @return ForwardingRulesCommiter&lt;Table&gt;
      */
-    public ForwardingRulesCommiter<TableFeatures> getTableFeaturesCommiter();
+    ForwardingRulesCommiter<TableFeatures> getTableFeaturesCommiter();
 
     /**
-     * Content definition method
-     * @return FlowNodeReconciliation
+     * Check if reconciliation is disabled by user.
+     * @return true if reconciliation is disabled, else false
      */
-    public FlowNodeReconciliation getFlowNodeReconciliation();
+    boolean isReconciliationDisabled();
 
     /**
-     * Returns the config-subsystem/fallback configuration of FRM
-     * @return ForwardingRulesManagerConfig
+     * Check if stale marking is enabled for switch reconciliation.
+     * @return true if stale marking is enabled, else false
      */
-    public ForwardingRulesManagerConfig getConfiguration();
+    boolean isStaleMarkingEnabled();
+
+    /**
+     * Return number of reconciliation retry are allowed.
+     * @return number of retries.
+     */
+    int getReconciliationRetryCount();
 
     /**
      * Method checks if *this* instance of openflowplugin is owner of
      * the given openflow node.
      * @return True if owner, else false
      */
-    public boolean isNodeOwner(InstanceIdentifier<FlowCapableNode> ident);
+    boolean isNodeOwner(InstanceIdentifier<FlowCapableNode> ident);
+
+    /**
+     * Content definition method and prevent code duplicity
+     * @return FlowNodeConnectorInventoryTranslatorImpl
+     */
+    FlowNodeConnectorInventoryTranslatorImpl getFlowNodeConnectorInventoryTranslatorImpl();
 
 }