HONEYCOMB-130: Separate v3po plugin from HC infra

Creating folders:
- common/
- infra/
- v3po/
- vpp-common/

Change-Id: I2c39e1b17e39e7c0f0628f44aa5fe08563fa06e4
Signed-off-by: Maros Marsalek <mmarsale@cisco.com>

6 files changed, 311 insertions, 0 deletions

diff --git a/infra/translate-spi/Readme.adoc b/infra/translate-spi/Readme.adoc
new file mode 100644
index 000000000..755538c07
--- /dev/null
+++ b/infra/translate-spi/Readme.adoc
@@ -0,0 +1,4 @@
+= Honeycomb translation layer SPI
+
+Provides root, child and list customizer interfaces for extending readers/writers.
+Customizers can be used to implement actual data reads and writes.
\ No newline at end of file
diff --git a/infra/translate-spi/pom.xml b/infra/translate-spi/pom.xml
new file mode 100644
index 000000000..f8c20140b
--- /dev/null
+++ b/infra/translate-spi/pom.xml
@@ -0,0 +1,72 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright (c) 2015 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.
+-->
+<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</groupId>
+    <artifactId>translate-spi</artifactId>
+    <version>1.0.0-SNAPSHOT</version>
+    <packaging>bundle</packaging>
+
+    <dependencyManagement>
+        <dependencies>
+            <dependency>
+                <groupId>org.opendaylight.mdsal</groupId>
+                <artifactId>mdsal-artifacts</artifactId>
+                <version>2.0.2-Beryllium-SR2</version>
+                <type>pom</type>
+                <scope>import</scope>
+            </dependency>
+        </dependencies>
+    </dependencyManagement>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>translate-api</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.opendaylight.mdsal</groupId>
+            <artifactId>mdsal-binding-api</artifactId>
+        </dependency>
+
+        <!-- Testing Dependencies -->
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-all</artifactId>
+            <scope>test</scope>
+        </dependency>
+
+    </dependencies>
+
+</project>
diff --git a/infra/translate-spi/src/main/java/io/fd/honeycomb/v3po/translate/spi/read/ListReaderCustomizer.java b/infra/translate-spi/src/main/java/io/fd/honeycomb/v3po/translate/spi/read/ListReaderCustomizer.java
new file mode 100644
index 000000000..59557554f
--- /dev/null
+++ b/infra/translate-spi/src/main/java/io/fd/honeycomb/v3po/translate/spi/read/ListReaderCustomizer.java
@@ -0,0 +1,63 @@
+/*
+ * 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.translate.spi.read;
+
+import com.google.common.annotations.Beta;
+import io.fd.honeycomb.v3po.translate.read.ReadContext;
+import io.fd.honeycomb.v3po.translate.read.ReadFailedException;
+import java.util.Collections;
+import java.util.List;
+import javax.annotation.Nonnull;
+import org.opendaylight.yangtools.concepts.Builder;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.Identifiable;
+import org.opendaylight.yangtools.yang.binding.Identifier;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+/**
+ * CompositeListReader SPI to customize its behavior.
+ *
+ * @param <C> Specific DataObject derived type (Identifiable), that is handled by this customizer
+ * @param <K> Specific Identifier for handled type (C)
+ * @param <B> Specific Builder for handled type (C)
+ */
+@Beta
+public interface ListReaderCustomizer<C extends DataObject & Identifiable<K>, K extends Identifier<C>, B extends Builder<C>>
+    extends ReaderCustomizer<C, B> {
+
+    /**
+     * Return list with IDs of all list nodes to be read.
+     *
+     * @param id Wildcarded ID pointing to list node managed by enclosing reader
+     * @param context Read context
+     * @throws ReadFailedException if the list of IDs could not be read
+     */
+    @Nonnull
+    List<K> getAllIds(@Nonnull final InstanceIdentifier<C> id, @Nonnull final ReadContext context) throws
+            ReadFailedException;
+    // TODO does it make sense with vpp APIs ? Should we replace it with a simple readAll ?
+
+    /**
+     * Merge read data into provided parent builder.
+     */
+    void merge(@Nonnull final Builder<? extends DataObject> builder, @Nonnull final List<C> readData);
+
+    @Override
+    default void merge(@Nonnull final Builder<? extends DataObject> parentBuilder, @Nonnull final C readValue) {
+        merge(parentBuilder, Collections.singletonList(readValue));
+    }
+}
diff --git a/infra/translate-spi/src/main/java/io/fd/honeycomb/v3po/translate/spi/read/ReaderCustomizer.java b/infra/translate-spi/src/main/java/io/fd/honeycomb/v3po/translate/spi/read/ReaderCustomizer.java
new file mode 100644
index 000000000..270da8beb
--- /dev/null
+++ b/infra/translate-spi/src/main/java/io/fd/honeycomb/v3po/translate/spi/read/ReaderCustomizer.java
@@ -0,0 +1,63 @@
+/*
+ * 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.translate.spi.read;
+
+import com.google.common.annotations.Beta;
+import io.fd.honeycomb.v3po.translate.read.ReadContext;
+import io.fd.honeycomb.v3po.translate.read.ReadFailedException;
+import javax.annotation.Nonnull;
+import org.opendaylight.yangtools.concepts.Builder;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+/**
+ * CompositeChildReader SPI to customize its behavior.
+ *
+ * @param <C> Specific DataObject derived type (Identifiable), that is handled by this customizer
+ * @param <B> Specific Builder for handled type (C)
+ */
+@Beta
+public interface ReaderCustomizer<C extends DataObject, B extends Builder<C>> {
+
+    /**
+     * Creates new builder that will be used to build read value.
+     */
+    @Nonnull
+    B getBuilder(@Nonnull final InstanceIdentifier<C> id);
+
+    /**
+     * Adds current data (identified by id) to the provided builder.
+     *
+     * @param id      id of current data object
+     * @param builder builder for creating read value
+     * @param ctx
+     * @throws ReadFailedException if read was unsuccessful
+     */
+    void readCurrentAttributes(@Nonnull final InstanceIdentifier<C> id,
+                               @Nonnull final B builder,
+                               @Nonnull final ReadContext ctx) throws ReadFailedException;
+
+    // FIXME need to capture parent builder type, but that's inconvenient at best, is it ok to leave it Builder<?> and
+    // cast in specific customizers ? ... probably better than adding another type parameter
+
+    /**
+     * Merge read data into provided parent builder.
+     */
+    void merge(@Nonnull final Builder<? extends DataObject> parentBuilder, @Nonnull final C readValue);
+
+
+}
diff --git a/infra/translate-spi/src/main/java/io/fd/honeycomb/v3po/translate/spi/write/ListWriterCustomizer.java b/infra/translate-spi/src/main/java/io/fd/honeycomb/v3po/translate/spi/write/ListWriterCustomizer.java
new file mode 100644
index 000000000..41cdb94b6
--- /dev/null
+++ b/infra/translate-spi/src/main/java/io/fd/honeycomb/v3po/translate/spi/write/ListWriterCustomizer.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.translate.spi.write;
+
+import com.google.common.annotations.Beta;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.Identifiable;
+import org.opendaylight.yangtools.yang.binding.Identifier;
+
+/**
+ * CompositeListWriter SPI to customize its behavior.
+ *
+ * @param <C> Specific DataObject derived type (Identifiable), that is handled by this customizer
+ * @param <K> Specific Identifier for handled type (C)
+ */
+@Beta
+public interface ListWriterCustomizer<C extends DataObject & Identifiable<K>, K extends Identifier<C>> extends
+    WriterCustomizer<C> {
+
+}
\ No newline at end of file
diff --git a/infra/translate-spi/src/main/java/io/fd/honeycomb/v3po/translate/spi/write/WriterCustomizer.java b/infra/translate-spi/src/main/java/io/fd/honeycomb/v3po/translate/spi/write/WriterCustomizer.java
new file mode 100644
index 000000000..06ce3f814
--- /dev/null
+++ b/infra/translate-spi/src/main/java/io/fd/honeycomb/v3po/translate/spi/write/WriterCustomizer.java
@@ -0,0 +1,75 @@
+/*
+ * 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.translate.spi.write;
+
+import com.google.common.annotations.Beta;
+import io.fd.honeycomb.v3po.translate.write.WriteContext;
+import io.fd.honeycomb.v3po.translate.write.WriteFailedException;
+import javax.annotation.Nonnull;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+/**
+ * CompositeChildWriter SPI to customize its behavior.
+ *
+ * @param <D> Specific DataObject derived type (Identifiable), that is handled by this customizer
+ */
+@Beta
+public interface WriterCustomizer<D extends DataObject> {
+
+    /**
+     * Handle write operation. C from CRUD.
+     *
+     * @param id Identifier(from root) of data being written
+     * @param dataAfter New data to be written
+     * @param writeContext Write context can be used to store any useful information and then utilized by other customizers
+     *
+     * @throws WriteFailedException if write was unsuccessful
+     */
+    void writeCurrentAttributes(@Nonnull final InstanceIdentifier<D> id,
+                                @Nonnull final D dataAfter,
+                                @Nonnull final WriteContext writeContext) throws WriteFailedException;
+
+    /**
+     * Handle update operation. U from CRUD.
+     *
+     * @param id Identifier(from root) of data being written
+     * @param dataBefore Old data
+     * @param dataAfter New, updated data
+     * @param writeContext Write context can be used to store any useful information and then utilized by other customizers
+     *
+     * @throws WriteFailedException if update was unsuccessful
+     */
+    void updateCurrentAttributes(@Nonnull final InstanceIdentifier<D> id,
+                                 @Nonnull final D dataBefore,
+                                 @Nonnull final D dataAfter,
+                                 @Nonnull final WriteContext writeContext) throws WriteFailedException;
+
+    /**
+     * Handle delete operation. D from CRUD.
+     *
+     * @param id Identifier(from root) of data being written
+     * @param dataBefore Old data being deleted
+     * @param writeContext Write context can be used to store any useful information and then utilized by other customizers
+     *
+     * @throws WriteFailedException if delete was unsuccessful
+     */
+    void deleteCurrentAttributes(@Nonnull final InstanceIdentifier<D> id,
+                                 @Nonnull final D dataBefore,
+                                 @Nonnull final WriteContext writeContext) throws WriteFailedException;
+
+}