HONEYCOMB-8: Move data layer from impl module into submodules

Change-Id: Ic75793f65cfcad7cc2c96e7a09093e0e1802e4e5
Signed-off-by: Marek Gradzki <mgradzki@cisco.com>
Signed-off-by: Maros Marsalek <mmarsale@cisco.com>

4 files changed, 157 insertions, 0 deletions

diff --git a/v3po/data-api/pom.xml b/v3po/data-api/pom.xml
new file mode 100644
index 000000000..88be38d9f
--- /dev/null
+++ b/v3po/data-api/pom.xml
@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <groupId>io.fd.honeycomb.common</groupId>
+        <artifactId>api-parent</artifactId>
+        <version>1.0.0-SNAPSHOT</version>
+        <relativePath>../../common/api-parent</relativePath>
+    </parent>
+
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>io.fd.honeycomb.v3po</groupId>
+    <artifactId>data-api</artifactId>
+    <version>1.0.0-SNAPSHOT</version>
+    <packaging>bundle</packaging>
+
+    <dependencies>
+        <dependency>
+            <groupId>io.fd.honeycomb.v3po</groupId>
+            <artifactId>translate-api</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.opendaylight.yangtools</groupId>
+            <artifactId>yang-data-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.opendaylight.controller</groupId>
+            <artifactId>sal-common-api</artifactId>
+            <version>1.3.0-Beryllium</version>
+        </dependency>
+
+    </dependencies>
+
+</project>
\ No newline at end of file
diff --git a/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/ReadableVppDataTree.java b/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/ReadableVppDataTree.java
new file mode 100644
index 000000000..22a52aa41
--- /dev/null
+++ b/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/ReadableVppDataTree.java
@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ *
+ * 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 io.fd.honeycomb.v3po.data;
+
+import com.google.common.annotations.Beta;
+import com.google.common.base.Optional;
+import com.google.common.util.concurrent.CheckedFuture;
+import javax.annotation.Nonnull;
+import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+
+/**
+ * Facade over VPP data tree that allows reading tree nodes.
+ */
+@Beta
+public interface ReadableVppDataTree {
+    /**
+     * Reads a particular node from the VPP data tree.
+     *
+     * @param path Path of the node
+     * @return a CheckFuture containing the result of the read.
+     */
+    CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> read(@Nonnull final YangInstanceIdentifier path);
+}
diff --git a/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/VppDataTree.java b/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/VppDataTree.java
new file mode 100644
index 000000000..dffd22d3a
--- /dev/null
+++ b/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/VppDataTree.java
@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ *
+ * 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 io.fd.honeycomb.v3po.data;
+
+import com.google.common.annotations.Beta;
+import io.fd.honeycomb.v3po.translate.TranslationException;
+import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
+import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
+
+/**
+ * Facade over VPP data tree that allows tree modification.
+ */
+@Beta
+public interface VppDataTree {
+    /**
+     * Commits modification to VPP data tree.
+     *
+     * @param modification VPP data tree modification
+     * @throws DataValidationFailedException if modification data is not valid
+     * @throws TranslationException if commit failed while updating VPP state
+     */
+    void commit(final DataTreeModification modification) throws DataValidationFailedException, TranslationException;
+
+    /**
+     * Creates read-only snapshot of a VppDataTree.
+     *
+     * @return Data tree snapshot.
+     */
+    VppDataTreeSnapshot takeSnapshot();
+}
diff --git a/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/VppDataTreeSnapshot.java b/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/VppDataTreeSnapshot.java
new file mode 100644
index 000000000..665a2e0ae
--- /dev/null
+++ b/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/VppDataTreeSnapshot.java
@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ *
+ * 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 io.fd.honeycomb.v3po.data;
+
+import com.google.common.annotations.Beta;
+import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
+
+/**
+ * Read-only snapshot of a {@link ReadableVppDataTree}.
+ */
+@Beta
+public interface VppDataTreeSnapshot extends ReadableVppDataTree {
+
+    /**
+     * Creates a new VPP data tree modification.
+     *
+     * @return A new data tree modification
+     */
+    DataTreeModification newModification();
+}