LeadershipService and MastershipService/Store APIs return CompletableFutures so that callers can (optionally) chain together dependent operations
Change-Id: Ia00fcb7d98fbfce897527f67ea9690abf6fe846a
diff --git a/core/api/src/main/java/org/onosproject/cluster/LeadershipService.java b/core/api/src/main/java/org/onosproject/cluster/LeadershipService.java
index 9b94056..9130f4f 100644
--- a/core/api/src/main/java/org/onosproject/cluster/LeadershipService.java
+++ b/core/api/src/main/java/org/onosproject/cluster/LeadershipService.java
@@ -18,6 +18,7 @@
import java.util.List;
import java.util.Map;
import java.util.Set;
+import java.util.concurrent.CompletableFuture;
/**
* Service for leader election.
@@ -55,16 +56,18 @@
/**
* Joins the leadership contest.
*
- * @param path topic for which this controller node wishes to be a leader.
+ * @param path topic for which this controller node wishes to be a leader
+ * @return {@code Leadership} future
*/
- void runForLeadership(String path);
+ CompletableFuture<Leadership> runForLeadership(String path);
/**
* Withdraws from a leadership contest.
*
- * @param path topic for which this controller node no longer wishes to be a leader.
+ * @param path topic for which this controller node no longer wishes to be a leader
+ * @return future that is successfully completed when withdraw is done
*/
- void withdraw(String path);
+ CompletableFuture<Void> withdraw(String path);
/**
* If the local nodeId is the leader for specified topic, this method causes it to
diff --git a/core/api/src/main/java/org/onosproject/mastership/MastershipAdminService.java b/core/api/src/main/java/org/onosproject/mastership/MastershipAdminService.java
index 6c41fb2..a8835fc 100644
--- a/core/api/src/main/java/org/onosproject/mastership/MastershipAdminService.java
+++ b/core/api/src/main/java/org/onosproject/mastership/MastershipAdminService.java
@@ -15,6 +15,8 @@
*/
package org.onosproject.mastership;
+import java.util.concurrent.CompletableFuture;
+
import org.onosproject.cluster.NodeId;
import org.onosproject.net.DeviceId;
import org.onosproject.net.MastershipRole;
@@ -30,8 +32,9 @@
* @param instance controller instance identifier
* @param deviceId device identifier
* @param role requested role
+ * @return future that is completed when the role is set
*/
- void setRole(NodeId instance, DeviceId deviceId, MastershipRole role);
+ CompletableFuture<Void> setRole(NodeId instance, DeviceId deviceId, MastershipRole role);
/**
* Balances the mastership to be shared as evenly as possibly by all
diff --git a/core/api/src/main/java/org/onosproject/mastership/MastershipService.java b/core/api/src/main/java/org/onosproject/mastership/MastershipService.java
index f03f6c8..450bcc5 100644
--- a/core/api/src/main/java/org/onosproject/mastership/MastershipService.java
+++ b/core/api/src/main/java/org/onosproject/mastership/MastershipService.java
@@ -16,6 +16,7 @@
package org.onosproject.mastership;
import java.util.Set;
+import java.util.concurrent.CompletableFuture;
import org.onosproject.cluster.NodeId;
import org.onosproject.cluster.RoleInfo;
@@ -46,7 +47,7 @@
* @param deviceId the the identifier of the device
* @return the role of this controller instance
*/
- MastershipRole requestRoleFor(DeviceId deviceId);
+ CompletableFuture<MastershipRole> requestRoleFor(DeviceId deviceId);
/**
* Abandons mastership of the specified device on the local node thus
diff --git a/core/api/src/main/java/org/onosproject/mastership/MastershipStore.java b/core/api/src/main/java/org/onosproject/mastership/MastershipStore.java
index 6b64705..81c2d8b 100644
--- a/core/api/src/main/java/org/onosproject/mastership/MastershipStore.java
+++ b/core/api/src/main/java/org/onosproject/mastership/MastershipStore.java
@@ -38,7 +38,7 @@
* @param deviceId device identifier
* @return established or newly negotiated mastership role
*/
- MastershipRole requestRole(DeviceId deviceId);
+ CompletableFuture<MastershipRole> requestRole(DeviceId deviceId);
/**
* Returns the role of a device for a specific controller instance.
diff --git a/core/api/src/test/java/org/onosproject/cluster/LeadershipServiceAdapter.java b/core/api/src/test/java/org/onosproject/cluster/LeadershipServiceAdapter.java
index abc92f5..e1d421d 100644
--- a/core/api/src/test/java/org/onosproject/cluster/LeadershipServiceAdapter.java
+++ b/core/api/src/test/java/org/onosproject/cluster/LeadershipServiceAdapter.java
@@ -18,6 +18,7 @@
import java.util.List;
import java.util.Map;
import java.util.Set;
+import java.util.concurrent.CompletableFuture;
/**
* Test adapter for leadership service.
@@ -40,13 +41,13 @@
}
@Override
- public void runForLeadership(String path) {
-
+ public CompletableFuture<Leadership> runForLeadership(String path) {
+ return null;
}
@Override
- public void withdraw(String path) {
-
+ public CompletableFuture<Void> withdraw(String path) {
+ return null;
}
@Override
diff --git a/core/api/src/test/java/org/onosproject/mastership/MastershipServiceAdapter.java b/core/api/src/test/java/org/onosproject/mastership/MastershipServiceAdapter.java
index be1f4b9..aff67cd 100644
--- a/core/api/src/test/java/org/onosproject/mastership/MastershipServiceAdapter.java
+++ b/core/api/src/test/java/org/onosproject/mastership/MastershipServiceAdapter.java
@@ -21,6 +21,7 @@
import org.onosproject.net.MastershipRole;
import java.util.Set;
+import java.util.concurrent.CompletableFuture;
/**
* Test adapter for mastership service.
@@ -32,7 +33,7 @@
}
@Override
- public MastershipRole requestRoleFor(DeviceId deviceId) {
+ public CompletableFuture<MastershipRole> requestRoleFor(DeviceId deviceId) {
return null;
}