Add distributed lock primitive
Change-Id: I60f4581d5acb5fc9b9a21d4191874bb56348af58
diff --git a/core/api/src/main/java/org/onosproject/store/service/AsyncDistributedLock.java b/core/api/src/main/java/org/onosproject/store/service/AsyncDistributedLock.java
new file mode 100644
index 0000000..be35b5e
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/store/service/AsyncDistributedLock.java
@@ -0,0 +1,69 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.store.service;
+
+import java.time.Duration;
+import java.util.Optional;
+import java.util.concurrent.CompletableFuture;
+
+import org.onosproject.store.primitives.DefaultDistributedLock;
+
+/**
+ * Asynchronous lock primitive.
+ */
+public interface AsyncDistributedLock extends DistributedPrimitive {
+ @Override
+ default Type primitiveType() {
+ return Type.LOCK;
+ }
+
+ /**
+ * Acquires the lock, blocking until it's available.
+ *
+ * @return future to be completed once the lock has been acquired
+ */
+ CompletableFuture<Version> lock();
+
+ /**
+ * Attempts to acquire the lock.
+ *
+ * @return future to be completed with a boolean indicating whether the lock was acquired
+ */
+ CompletableFuture<Optional<Version>> tryLock();
+
+ /**
+ * Attempts to acquire the lock for a specified amount of time.
+ *
+ * @param timeout the timeout after which to give up attempting to acquire the lock
+ * @return future to be completed with a boolean indicating whether the lock was acquired
+ */
+ CompletableFuture<Optional<Version>> tryLock(Duration timeout);
+
+ /**
+ * Unlocks the lock.
+ *
+ * @return future to be completed once the lock has been released
+ */
+ CompletableFuture<Void> unlock();
+
+ default DistributedLock asLock() {
+ return asLock(-1);
+ }
+
+ default DistributedLock asLock(long timeoutMillis) {
+ return new DefaultDistributedLock(this, timeoutMillis);
+ }
+}
diff --git a/core/api/src/main/java/org/onosproject/store/service/DistributedLock.java b/core/api/src/main/java/org/onosproject/store/service/DistributedLock.java
new file mode 100644
index 0000000..cce53ff
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/store/service/DistributedLock.java
@@ -0,0 +1,56 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.store.service;
+
+import java.time.Duration;
+import java.util.Optional;
+
+/**
+ * Asynchronous lock primitive.
+ */
+public interface DistributedLock extends DistributedPrimitive {
+ @Override
+ default Type primitiveType() {
+ return Type.LOCK;
+ }
+
+ /**
+ * Acquires the lock, blocking until it's available.
+ *
+ * @return the acquired lock version
+ */
+ Version lock();
+
+ /**
+ * Attempts to acquire the lock.
+ *
+ * @return indicates whether the lock was acquired
+ */
+ Optional<Version> tryLock();
+
+ /**
+ * Attempts to acquire the lock for a specified amount of time.
+ *
+ * @param timeout the timeout after which to give up attempting to acquire the lock
+ * @return indicates whether the lock was acquired
+ */
+ Optional<Version> tryLock(Duration timeout);
+
+ /**
+ * Unlocks the lock.
+ */
+ void unlock();
+}
diff --git a/core/api/src/main/java/org/onosproject/store/service/DistributedLockBuilder.java b/core/api/src/main/java/org/onosproject/store/service/DistributedLockBuilder.java
new file mode 100644
index 0000000..7e61c6a
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/store/service/DistributedLockBuilder.java
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.store.service;
+
+import org.onosproject.store.primitives.DistributedPrimitiveBuilder;
+
+/**
+ * Builder for DistributedLock.
+ */
+public abstract class DistributedLockBuilder
+ extends DistributedPrimitiveBuilder<DistributedLockBuilder, AsyncDistributedLock> {
+ public DistributedLockBuilder() {
+ super(DistributedPrimitive.Type.LOCK);
+ }
+}
\ No newline at end of file
diff --git a/core/api/src/main/java/org/onosproject/store/service/DistributedPrimitive.java b/core/api/src/main/java/org/onosproject/store/service/DistributedPrimitive.java
index 8a440f3..620e16d 100644
--- a/core/api/src/main/java/org/onosproject/store/service/DistributedPrimitive.java
+++ b/core/api/src/main/java/org/onosproject/store/service/DistributedPrimitive.java
@@ -99,7 +99,12 @@
/**
* Transaction Context.
*/
- TRANSACTION_CONTEXT
+ TRANSACTION_CONTEXT,
+
+ /**
+ * Distributed lock.
+ */
+ LOCK,
}
/**
diff --git a/core/api/src/main/java/org/onosproject/store/service/StorageService.java b/core/api/src/main/java/org/onosproject/store/service/StorageService.java
index d863983..96e6037 100644
--- a/core/api/src/main/java/org/onosproject/store/service/StorageService.java
+++ b/core/api/src/main/java/org/onosproject/store/service/StorageService.java
@@ -107,6 +107,13 @@
<V> AtomicValueBuilder<V> atomicValueBuilder();
/**
+ * Creates a new DistributedLockBuilder.
+ *
+ * @return lock builder
+ */
+ DistributedLockBuilder lockBuilder();
+
+ /**
* Creates a new LeaderElectorBuilder.
*
* @return leader elector builder