[ONOS-6497] Add globally unique numeric ID generator primitive
Change-Id: Ic2d9214cfa885344694b8ba4250054dd6a33144e
diff --git a/core/api/src/main/java/org/onosproject/store/service/AsyncAtomicIdGenerator.java b/core/api/src/main/java/org/onosproject/store/service/AsyncAtomicIdGenerator.java
new file mode 100644
index 0000000..fc0e49b
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/store/service/AsyncAtomicIdGenerator.java
@@ -0,0 +1,57 @@
+/*
+ * Copyright 2017-present Open Networking Laboratory
+ *
+ * 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.util.concurrent.CompletableFuture;
+
+import org.onosproject.store.primitives.DefaultAtomicIdGenerator;
+
+/**
+ * An async ID generator for generating globally unique numbers.
+ */
+public interface AsyncAtomicIdGenerator extends DistributedPrimitive {
+
+ @Override
+ default Type primitiveType() {
+ return Type.ID_GENERATOR;
+ }
+
+ /**
+ * Returns the next globally unique numeric ID.
+ *
+ * @return a future to be completed with the next globally unique identifier
+ */
+ CompletableFuture<Long> nextId();
+
+ /**
+ * Returns a new {@link AtomicIdGenerator} that is backed by this instance.
+ *
+ * @param timeoutMillis timeout duration for the returned ConsistentMap operations
+ * @return new {@code AtomicIdGenerator} instance
+ */
+ default AtomicIdGenerator asAtomicIdGenerator(long timeoutMillis) {
+ return new DefaultAtomicIdGenerator(this, timeoutMillis);
+ }
+
+ /**
+ * Returns a new {@link AtomicIdGenerator} that is backed by this instance and with a default operation timeout.
+ *
+ * @return new {@code AtomicIdGenerator} instance
+ */
+ default AtomicIdGenerator asAtomicIdGenerator() {
+ return new DefaultAtomicIdGenerator(this, DEFAULT_OPERTATION_TIMEOUT_MILLIS);
+ }
+}
diff --git a/core/api/src/main/java/org/onosproject/store/service/AtomicIdGenerator.java b/core/api/src/main/java/org/onosproject/store/service/AtomicIdGenerator.java
new file mode 100644
index 0000000..c56093e
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/store/service/AtomicIdGenerator.java
@@ -0,0 +1,35 @@
+/*
+ * Copyright 2017-present Open Networking Laboratory
+ *
+ * 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;
+
+/**
+ * Generator for globally unique numeric identifiers.
+ */
+public interface AtomicIdGenerator extends DistributedPrimitive {
+
+ @Override
+ default Type primitiveType() {
+ return Type.ID_GENERATOR;
+ }
+
+ /**
+ * Gets the next globally unique numeric identifier.
+ *
+ * @return the next globally unique numeric identifier
+ */
+ long nextId();
+
+}
diff --git a/core/api/src/main/java/org/onosproject/store/service/AtomicIdGeneratorBuilder.java b/core/api/src/main/java/org/onosproject/store/service/AtomicIdGeneratorBuilder.java
new file mode 100644
index 0000000..c8d50f1
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/store/service/AtomicIdGeneratorBuilder.java
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2017-present Open Networking Laboratory
+ *
+ * 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 AtomicIdGenerator.
+ */
+public abstract class AtomicIdGeneratorBuilder
+ extends DistributedPrimitiveBuilder<AtomicIdGeneratorBuilder, AsyncAtomicIdGenerator> {
+ public AtomicIdGeneratorBuilder() {
+ super(DistributedPrimitive.Type.ID_GENERATOR);
+ }
+}
\ 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 21c494b..9142bf5 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
@@ -62,6 +62,11 @@
COUNTER,
/**
+ * Numeric ID generator.
+ */
+ ID_GENERATOR,
+
+ /**
* Atomic counter map.
*/
COUNTER_MAP,
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 e034e57..0e69423 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
@@ -92,6 +92,13 @@
AtomicCounterBuilder atomicCounterBuilder();
/**
+ * Creates a new AtomicIdGeneratorBuilder.
+ *
+ * @return atomic ID generator builder
+ */
+ AtomicIdGeneratorBuilder atomicIdGeneratorBuilder();
+
+ /**
* Creates a new AtomicValueBuilder.
*
* @param <V> atomic value type
@@ -124,6 +131,16 @@
}
/**
+ * Returns an instance of {@code AsyncAtomicIdGenerator} with specified name.
+ *
+ * @param name ID generator name
+ * @return AsyncAtomicIdGenerator instance
+ */
+ default AsyncAtomicIdGenerator getAsyncAtomicIdGenerator(String name) {
+ return atomicIdGeneratorBuilder().withName(name).build();
+ }
+
+ /**
* Returns an instance of {@code AtomicCounter} with specified name.
* @param name counter name
*
@@ -134,6 +151,16 @@
}
/**
+ * Returns an instance of {@code AtomicIdGenerator} with specified name.
+ *
+ * @param name ID generator name
+ * @return AtomicIdGenerator instance
+ */
+ default AtomicIdGenerator getAtomicIdGenerator(String name) {
+ return getAsyncAtomicIdGenerator(name).asAtomicIdGenerator();
+ }
+
+ /**
* Returns an instance of {@code WorkQueue} with specified name.
*
* @param <E> work element type