commit fc5acc731cc20d5ce022271d54b176328250e2e5
author Toshio Koide <t-koide@onlab.us> Tue Aug 12 18:45:46 2014 -0700
committer Saurav Das <sauravdas@alumni.stanford.edu> Fri Sep 05 11:47:21 2014 -0700
tree d19431a213366b7c177157c83e57c575c7a57c88
parent b8cea26de90ab3fcaca7bdbfdb98eacf1d71082e

Update FlowManager's API design and define batch operation map's API.

- FlowManager returns FlowBatchHandle as a handler to the batch execution.
 -- addFlow(), removeFlow() and executeBatch() methods are executed asynchronously.
 -- Users can get the current state of the batch via the FlowBatchHandle.
- Defined FlowOperationMap's inital API designs.

This task is a part of ONOS-1687, ONOS-1842, and ONOS-1692.

Change-Id: Ic9e8ce3ab0378615d9d3016b7755ee6d15e1e47c

src/main/java/net/onrc/onos/core/flowmanager/FlowManagerModule.java

diff --git a/src/main/java/net/onrc/onos/core/flowmanager/FlowManagerModule.java b/src/main/java/net/onrc/onos/core/flowmanager/FlowManagerModule.java
index 8336095..235e38a 100644
--- a/src/main/java/net/onrc/onos/core/flowmanager/FlowManagerModule.java
+++ b/src/main/java/net/onrc/onos/core/flowmanager/FlowManagerModule.java
@@ -4,6 +4,7 @@
 
 import net.onrc.onos.api.flowmanager.ConflictDetectionPolicy;
 import net.onrc.onos.api.flowmanager.Flow;
+import net.onrc.onos.api.flowmanager.FlowBatchHandle;
 import net.onrc.onos.api.flowmanager.FlowBatchOperation;
 import net.onrc.onos.api.flowmanager.FlowId;
 import net.onrc.onos.api.flowmanager.FlowManagerListener;
@@ -17,23 +18,25 @@
  */
 public class FlowManagerModule implements FlowManagerService {
     private ConflictDetectionPolicy conflictDetectionPolicy;
+    private FlowOperationMap flowOperationMap;
 
     /**
      * Constructor.
      */
     public FlowManagerModule() {
         this.conflictDetectionPolicy = ConflictDetectionPolicy.FREE;
+        this.flowOperationMap = new FlowOperationMap();
     }
 
     @Override
-    public boolean addFlow(Flow flow) {
+    public FlowBatchHandle addFlow(Flow flow) {
         FlowBatchOperation ops = new FlowBatchOperation();
         ops.addAddFlowOperation(flow);
         return executeBatch(ops);
     }
 
     @Override
-    public boolean removeFlow(FlowId id) {
+    public FlowBatchHandle removeFlow(FlowId id) {
         FlowBatchOperation ops = new FlowBatchOperation();
         ops.addRemoveFlowOperation(id);
         return executeBatch(ops);
@@ -52,9 +55,15 @@
     }
 
     @Override
-    public boolean executeBatch(FlowBatchOperation ops) {
-        // TODO Auto-generated method stub
-        return false;
+    public FlowBatchHandle executeBatch(FlowBatchOperation ops) {
+        // This method just put the batch-operation object to the global
+        // flow operation map with unique ID. The leader process will get
+        // the appended operation with events notified from the map.
+        FlowBatchHandle handler = flowOperationMap.putOperation(ops);
+
+        // Then it will return a handler to obtain the result of this operation,
+        // control the executing process, etc.
+        return handler;
     }
 
     @Override

src/main/java/net/onrc/onos/core/flowmanager/FlowOperationMap.java

diff --git a/src/main/java/net/onrc/onos/core/flowmanager/FlowOperationMap.java b/src/main/java/net/onrc/onos/core/flowmanager/FlowOperationMap.java
index 744c65e..e9d66c3 100644
--- a/src/main/java/net/onrc/onos/core/flowmanager/FlowOperationMap.java
+++ b/src/main/java/net/onrc/onos/core/flowmanager/FlowOperationMap.java
@@ -1,8 +1,49 @@
 package net.onrc.onos.core.flowmanager;
 
+import net.onrc.onos.api.flowmanager.FlowBatchHandle;
+import net.onrc.onos.api.flowmanager.FlowBatchId;
+import net.onrc.onos.api.flowmanager.FlowBatchOperation;
+import net.onrc.onos.api.flowmanager.FlowBatchState;
+
 /**
  * Manages the set of flow operations throughout the ONOS instances.
  */
 public class FlowOperationMap {
-    // TODO implement it
+    public FlowBatchHandle putOperation(FlowBatchOperation ops) {
+        FlowBatchId id = getUniqueBatchOperationId();
+        if (id == null) {
+            return null;
+        }
+        if (putBatchOperation(id, ops)) {
+            return null;
+        }
+
+        return new FlowBatchHandle(this, id);
+    }
+
+    public void setState(long id, FlowBatchState state) {
+        // TODO implement it
+    }
+
+    public FlowBatchOperation getOperation(long id) {
+        // TODO implement it
+        return null;
+    }
+
+    public FlowBatchState getState(FlowBatchId id) {
+        // TODO implement it
+        return null;
+    }
+
+    // ====== private methods
+
+    private FlowBatchId getUniqueBatchOperationId() {
+        // TODO implement it
+        return null;
+    }
+
+    private boolean putBatchOperation(FlowBatchId id, FlowBatchOperation ops) {
+        // TODO implement it
+        return false;
+    }
 }