ONOS-5552 DocumentTree builder not available
Change-Id: Id0e9e0c647146c27e21e2ec2b2014789bbd9eca9
diff --git a/apps/vtn/vtnrsc/src/test/java/org/onosproject/vtnrsc/util/VtnStorageServiceAdapter.java b/apps/vtn/vtnrsc/src/test/java/org/onosproject/vtnrsc/util/VtnStorageServiceAdapter.java
deleted file mode 100644
index ebad932..0000000
--- a/apps/vtn/vtnrsc/src/test/java/org/onosproject/vtnrsc/util/VtnStorageServiceAdapter.java
+++ /dev/null
@@ -1,90 +0,0 @@
-/*
- * Copyright 2015-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.vtnrsc.util;
-
-import org.onosproject.store.service.AsyncDocumentTree;
-import org.onosproject.store.service.Topic;
-import org.onosproject.store.service.ConsistentTreeMapBuilder;
-import org.onosproject.store.service.WorkQueue;
-import org.onosproject.store.service.EventuallyConsistentMapBuilder;
-import org.onosproject.store.service.ConsistentMapBuilder;
-import org.onosproject.store.service.DistributedSetBuilder;
-import org.onosproject.store.service.AtomicCounterBuilder;
-import org.onosproject.store.service.AtomicValueBuilder;
-import org.onosproject.store.service.LeaderElectorBuilder;
-import org.onosproject.store.service.Serializer;
-import org.onosproject.store.service.TransactionContextBuilder;
-import org.onosproject.store.service.StorageService;
-
-/**
- * Adapter for the storage service.
- */
-public class VtnStorageServiceAdapter implements StorageService {
- @Override
- public <K, V> EventuallyConsistentMapBuilder<K, V> eventuallyConsistentMapBuilder() {
- return null;
- }
-
- @Override
- public <K, V> ConsistentMapBuilder<K, V> consistentMapBuilder() {
- return null;
- }
-
- @Override
- public <V> ConsistentTreeMapBuilder<V> consistentTreeMapBuilder() {
- return null;
- }
-
- @Override
- public <E> DistributedSetBuilder<E> setBuilder() {
- return null;
- }
-
- @Override
- public AtomicCounterBuilder atomicCounterBuilder() {
- return null;
- }
-
- @Override
- public <V> AtomicValueBuilder<V> atomicValueBuilder() {
- return null;
- }
-
- @Override
- public TransactionContextBuilder transactionContextBuilder() {
- return null;
- }
-
- @Override
- public LeaderElectorBuilder leaderElectorBuilder() {
- return null;
- }
-
- @Override
- public <E> WorkQueue<E> getWorkQueue(String name, Serializer serializer) {
- return null;
- }
-
- @Override
- public <T> Topic<T> getTopic(String name, Serializer serializer) {
- return null;
- }
-
- @Override
- public <V> AsyncDocumentTree<V> getDocumentTree(String name, Serializer serializer) {
- return null;
- }
-}
diff --git a/apps/vtn/vtnrsc/src/test/java/org/onosproject/vtnrsc/util/VtnStorageServiceTest.java b/apps/vtn/vtnrsc/src/test/java/org/onosproject/vtnrsc/util/VtnStorageServiceTest.java
index 064279f..e408e89 100644
--- a/apps/vtn/vtnrsc/src/test/java/org/onosproject/vtnrsc/util/VtnStorageServiceTest.java
+++ b/apps/vtn/vtnrsc/src/test/java/org/onosproject/vtnrsc/util/VtnStorageServiceTest.java
@@ -16,8 +16,9 @@
package org.onosproject.vtnrsc.util;
import org.onosproject.store.service.EventuallyConsistentMapBuilder;
+import org.onosproject.store.service.StorageServiceAdapter;
-public class VtnStorageServiceTest extends VtnStorageServiceAdapter {
+public class VtnStorageServiceTest extends StorageServiceAdapter {
@Override
public <K, V> EventuallyConsistentMapBuilder<K, V> eventuallyConsistentMapBuilder() {
return VtnEventuallyConsistentMapTest.builder();
diff --git a/core/api/src/main/java/org/onosproject/store/service/DocumentTreeBuilder.java b/core/api/src/main/java/org/onosproject/store/service/DocumentTreeBuilder.java
new file mode 100644
index 0000000..4b8d011
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/store/service/DocumentTreeBuilder.java
@@ -0,0 +1,60 @@
+/*
+ * Copyright 2016-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 {@link DocumentTree}.
+ */
+public abstract class DocumentTreeBuilder<V>
+ extends DistributedPrimitiveBuilder<DocumentTreeBuilder<V>, AsyncDocumentTree<V>> {
+
+ private boolean purgeOnUninstall = false;
+
+ public DocumentTreeBuilder() {
+ super(DistributedPrimitive.Type.DOCUMENT_TREE);
+ }
+
+ /**
+ * Clears document tree contents when the owning application is uninstalled.
+ *
+ * @return this builder
+ */
+ public DocumentTreeBuilder<V> withPurgeOnUninstall() {
+ purgeOnUninstall = true;
+ return this;
+ }
+
+ /**
+ * Return if document tree entries need to be cleared when owning application is uninstalled.
+ *
+ * @return true if items are to be cleared on uninstall
+ */
+ public boolean purgeOnUninstall() {
+ return purgeOnUninstall;
+ }
+
+ /**
+ * Builds the distributed Document tree based on the configuration options supplied
+ * to this builder.
+ *
+ * @return new distributed document tree
+ * @throws java.lang.RuntimeException if a mandatory parameter is missing
+ */
+ public abstract AsyncDocumentTree<V> buildDocumentTree();
+}
\ No newline at end of file
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 2e2acfb..21fdfda 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
@@ -44,6 +44,14 @@
<K, V> ConsistentMapBuilder<K, V> consistentMapBuilder();
/**
+ * Creates a new ConsistentMapBuilder.
+ *
+ * @param <V> value type
+ * @return builder for a consistent map
+ */
+ <V> DocumentTreeBuilder<V> documentTreeBuilder();
+
+ /**
* Creates a new {@code AsyncConsistentTreeMapBuilder}.
*
* @param <V> value type
diff --git a/core/api/src/test/java/org/onosproject/store/service/StorageServiceAdapter.java b/core/api/src/test/java/org/onosproject/store/service/StorageServiceAdapter.java
index 01cc065..29dd72d 100644
--- a/core/api/src/test/java/org/onosproject/store/service/StorageServiceAdapter.java
+++ b/core/api/src/test/java/org/onosproject/store/service/StorageServiceAdapter.java
@@ -30,6 +30,11 @@
}
@Override
+ public <V> DocumentTreeBuilder<V> documentTreeBuilder() {
+ return null;
+ }
+
+ @Override
public <E> DistributedSetBuilder<E> setBuilder() {
return null;
}
diff --git a/core/store/primitives/src/main/java/org/onosproject/store/primitives/impl/DefaultDocumentTreeBuilder.java b/core/store/primitives/src/main/java/org/onosproject/store/primitives/impl/DefaultDocumentTreeBuilder.java
new file mode 100644
index 0000000..8d21e60
--- /dev/null
+++ b/core/store/primitives/src/main/java/org/onosproject/store/primitives/impl/DefaultDocumentTreeBuilder.java
@@ -0,0 +1,52 @@
+/*
+ * Copyright 2016-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.primitives.impl;
+
+import org.onosproject.store.primitives.DistributedPrimitiveCreator;
+import org.onosproject.store.service.AsyncDocumentTree;
+import org.onosproject.store.service.DocumentTreeBuilder;
+
+/**
+ * Default {@link AsyncDocumentTree} builder.
+ *
+ * @param <V> type for document tree value
+ */
+public class DefaultDocumentTreeBuilder<V> extends DocumentTreeBuilder<V> {
+
+ private final DistributedPrimitiveCreator primitiveCreator;
+
+ public DefaultDocumentTreeBuilder(DistributedPrimitiveCreator primitiveCreator) {
+ this.primitiveCreator = primitiveCreator;
+ }
+
+ @Override
+ public AsyncDocumentTree<V> buildDocumentTree() {
+ return primitiveCreator.newAsyncDocumentTree(name(), serializer());
+ }
+
+ //TODO
+ /*
+ public ConsistentDocumentTree<V> build() {
+ return buildDocumentTree().asDocumentTree();
+ }
+ }*/
+ //writing a dummy implementation till we have ConsistentDocumentTree.
+ @Deprecated
+ @Override
+ public AsyncDocumentTree<V> build() {
+ return primitiveCreator.newAsyncDocumentTree(name(), serializer());
+ }
+}
\ No newline at end of file
diff --git a/core/store/primitives/src/main/java/org/onosproject/store/primitives/impl/StorageManager.java b/core/store/primitives/src/main/java/org/onosproject/store/primitives/impl/StorageManager.java
index 8e04d5a..4d9c1a6 100644
--- a/core/store/primitives/src/main/java/org/onosproject/store/primitives/impl/StorageManager.java
+++ b/core/store/primitives/src/main/java/org/onosproject/store/primitives/impl/StorageManager.java
@@ -50,6 +50,7 @@
import org.onosproject.store.service.ConsistentMapBuilder;
import org.onosproject.store.service.ConsistentTreeMapBuilder;
import org.onosproject.store.service.DistributedSetBuilder;
+import org.onosproject.store.service.DocumentTreeBuilder;
import org.onosproject.store.service.EventuallyConsistentMapBuilder;
import org.onosproject.store.service.LeaderElectorBuilder;
import org.onosproject.store.service.MapInfo;
@@ -133,6 +134,12 @@
}
@Override
+ public <V> DocumentTreeBuilder<V> documentTreeBuilder() {
+ checkPermission(STORAGE_WRITE);
+ return new DefaultDocumentTreeBuilder<V>(federatedPrimitiveCreator);
+ }
+
+ @Override
public <V> ConsistentTreeMapBuilder<V> consistentTreeMapBuilder() {
return new DefaultConsistentTreeMapBuilder<V>(
federatedPrimitiveCreator);
diff --git a/protocols/pcep/ctl/src/test/java/org/onosproject/pcelabelstore/util/StorageServiceAdapter.java b/protocols/pcep/ctl/src/test/java/org/onosproject/pcelabelstore/util/StorageServiceAdapter.java
index 6799c09..4f60b06 100644
--- a/protocols/pcep/ctl/src/test/java/org/onosproject/pcelabelstore/util/StorageServiceAdapter.java
+++ b/protocols/pcep/ctl/src/test/java/org/onosproject/pcelabelstore/util/StorageServiceAdapter.java
@@ -21,6 +21,7 @@
import org.onosproject.store.service.ConsistentMapBuilder;
import org.onosproject.store.service.ConsistentTreeMapBuilder;
import org.onosproject.store.service.DistributedSetBuilder;
+import org.onosproject.store.service.DocumentTreeBuilder;
import org.onosproject.store.service.EventuallyConsistentMapBuilder;
import org.onosproject.store.service.LeaderElectorBuilder;
import org.onosproject.store.service.Serializer;
@@ -44,6 +45,11 @@
}
@Override
+ public <V> DocumentTreeBuilder<V> documentTreeBuilder() {
+ return null;
+ }
+
+ @Override
public <E> DistributedSetBuilder<E> setBuilder() {
return null;
}