HONEYCOMB-9: Remove references to VPP from translation layer

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

4 files changed, 310 insertions, 0 deletions

diff --git a/v3po/translate-api/src/main/java/io/fd/honeycomb/v3po/translate/write/ChildWriter.java b/v3po/translate-api/src/main/java/io/fd/honeycomb/v3po/translate/write/ChildWriter.java
new file mode 100644
index 000000000..f933cfd4a
--- /dev/null
+++ b/v3po/translate-api/src/main/java/io/fd/honeycomb/v3po/translate/write/ChildWriter.java
@@ -0,0 +1,66 @@
+/*
+ * 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.write;
+
+import com.google.common.annotations.Beta;
+import javax.annotation.Nonnull;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+/**
+ * Child writer allowing its parent to pass the builder object
+ *
+ * @param <D> Specific DataObject derived type, that is handled by this writer
+ */
+@Beta
+public interface ChildWriter<D extends DataObject> extends Writer<D> {
+
+    /**
+     * Extract data object managed by this writer from parent data and perform write.
+     *
+     * @param parentId Id of parent node
+     * @param parentDataAfter Parent data from modification to extract data object from
+     * @param ctx Write context for current modification
+     */
+    void writeChild(@Nonnull final InstanceIdentifier<? extends DataObject> parentId,
+                    @Nonnull final DataObject parentDataAfter,
+                    @Nonnull final WriteContext ctx);
+
+    /**
+     * Extract data object managed by this writer(if necessary) from parent data and perform delete.
+     *
+     * @param parentId Id of parent node
+     * @param parentDataBefore Parent data before modification to extract data object from
+     * @param ctx Write context for current modification
+     */
+    void deleteChild(@Nonnull final InstanceIdentifier<? extends DataObject> parentId,
+                     @Nonnull final DataObject parentDataBefore,
+                     @Nonnull final WriteContext ctx);
+
+    /**
+     * Extract data object managed by this writer(if necessary) from parent data and perform delete.
+     *
+     * @param parentId Id of parent node
+     * @param parentDataBefore Parent data before modification to extract data object from
+     * @param parentDataAfter Parent data from modification to extract data object from
+     * @param ctx Write context for current modification
+     */
+    void updateChild(@Nonnull final InstanceIdentifier<? extends DataObject> parentId,
+                     @Nonnull final DataObject parentDataBefore,
+                     @Nonnull final DataObject parentDataAfter,
+                     @Nonnull final WriteContext ctx);
+}
diff --git a/v3po/translate-api/src/main/java/io/fd/honeycomb/v3po/translate/write/WriteContext.java b/v3po/translate-api/src/main/java/io/fd/honeycomb/v3po/translate/write/WriteContext.java
new file mode 100644
index 000000000..bb0b33145
--- /dev/null
+++ b/v3po/translate-api/src/main/java/io/fd/honeycomb/v3po/translate/write/WriteContext.java
@@ -0,0 +1,60 @@
+/*
+ * 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.write;
+
+import com.google.common.annotations.Beta;
+import com.google.common.base.Optional;
+import io.fd.honeycomb.v3po.translate.Context;
+import javax.annotation.Nonnull;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+/**
+ * Context providing information about current state of DataTree to writers
+ */
+@Beta
+public interface WriteContext extends AutoCloseable {
+
+    /**
+     * Read any data object before current modification was applied
+     *
+     * @param currentId Id of an object to read
+     *
+     * @return Data before the modification was applied
+     */
+    Optional<DataObject> readBefore(@Nonnull final InstanceIdentifier<? extends DataObject> currentId);
+
+    /**
+     * Read any data object from current modification
+     *
+     * @param currentId Id of an object to read
+     *
+     * @return Data from the modification
+     */
+    Optional<DataObject> readAfter(@Nonnull final InstanceIdentifier<? extends DataObject> currentId);
+
+    /**
+     * Get key value storage for customizers
+     *
+     * @return Context for customizers
+     */
+    @Nonnull
+    Context getContext();
+
+    @Override
+    void close();
+}
diff --git a/v3po/translate-api/src/main/java/io/fd/honeycomb/v3po/translate/write/Writer.java b/v3po/translate-api/src/main/java/io/fd/honeycomb/v3po/translate/write/Writer.java
new file mode 100644
index 000000000..08465fdd7
--- /dev/null
+++ b/v3po/translate-api/src/main/java/io/fd/honeycomb/v3po/translate/write/Writer.java
@@ -0,0 +1,49 @@
+/*
+ * 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.write;
+
+import com.google.common.annotations.Beta;
+import io.fd.honeycomb.v3po.translate.TranslationException;
+import io.fd.honeycomb.v3po.translate.SubtreeManager;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+/**
+ * Base writer, responsible for translation between DataObjects and any other side. Handling all update operations(create,
+ * update, delete)
+ *
+ * @param <D> Specific DataObject derived type, that is handled by this writer
+ */
+@Beta
+public interface Writer<D extends DataObject> extends SubtreeManager<D> {
+
+    /**
+     * 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 ctx        Write context enabling writer to get information about candidate data as well as current data
+     * @throws TranslationException if update failed
+     */
+    void update(@Nonnull final InstanceIdentifier<? extends DataObject> id,
+                @Nullable final DataObject dataBefore,
+                @Nullable final DataObject dataAfter,
+                @Nonnull final WriteContext ctx) throws TranslationException;
+}
diff --git a/v3po/translate-api/src/main/java/io/fd/honeycomb/v3po/translate/write/WriterRegistry.java b/v3po/translate-api/src/main/java/io/fd/honeycomb/v3po/translate/write/WriterRegistry.java
new file mode 100644
index 000000000..c5a8116c8
--- /dev/null
+++ b/v3po/translate-api/src/main/java/io/fd/honeycomb/v3po/translate/write/WriterRegistry.java
@@ -0,0 +1,135 @@
+/*
+ * 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.write;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+import com.google.common.annotations.Beta;
+import com.google.common.collect.ImmutableList;
+import io.fd.honeycomb.v3po.translate.TranslationException;
+import java.util.List;
+import java.util.Map;
+import javax.annotation.Nonnull;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+/**
+ * Special {@link Writer} capable of performing bulk updates
+ */
+@Beta
+public interface WriterRegistry extends Writer<DataObject> {
+
+    /**
+     * Performs bulk update
+     *
+     * @throws BulkUpdateException in case bulk update fails
+     * @throws TranslationException        in case some other error occurs while processing update request
+     */
+    void update(@Nonnull final Map<InstanceIdentifier<?>, DataObject> dataBefore,
+                @Nonnull final Map<InstanceIdentifier<?>, DataObject> dataAfter,
+                @Nonnull final WriteContext ctx) throws TranslationException;
+
+    /**
+     * Thrown when bulk update failed.
+     */
+    @Beta
+    class BulkUpdateException extends TranslationException {
+
+        private final Reverter reverter;
+        private final InstanceIdentifier<?> failedId; // TODO change to VppDataModification
+
+        /**
+         * Constructs an BulkUpdateException.
+         *
+         * @param failedId instance identifier of the data object that caused bulk update to fail.
+         * @param cause    the cause of bulk update failure
+         */
+        public BulkUpdateException(@Nonnull final InstanceIdentifier<?> failedId, @Nonnull final Reverter reverter,
+                                   final Throwable cause) {
+            super("Bulk update failed at " + failedId, cause);
+            this.failedId = checkNotNull(failedId, "failedId should not be null");
+            this.reverter = checkNotNull(reverter, "reverter should not be null");
+        }
+
+        /**
+         * Reverts changes that were successfully applied during bulk update before failure occurred.
+         *
+         * @throws Reverter.RevertFailedException if revert fails
+         */
+        public void revertChanges() throws Reverter.RevertFailedException {
+            reverter.revert();
+        }
+
+        /**
+         * Returns instance identifier of the data object that caused bulk update to fail.
+         *
+         * @return data object's instance identifier
+         */
+        @Nonnull
+        public InstanceIdentifier<?> getFailedId() {
+            return failedId;
+        }
+    }
+
+    /**
+     * Abstraction over revert mechanism in cast of a bulk update failure
+     */
+    @Beta
+    interface Reverter {
+
+        /**
+         * Reverts changes that were successfully applied during bulk update before failure occurred. Changes are
+         * reverted in reverse order they were applied.
+         *
+         * @throws RevertFailedException if not all of applied changes were successfully reverted
+         */
+        void revert() throws RevertFailedException;
+
+        /**
+         * Thrown when some of the changes applied during bulk update were not reverted.
+         */
+        @Beta
+        class RevertFailedException extends TranslationException {
+
+            // TODO change to list of VppDataModifications to make debugging easier
+            private final List<InstanceIdentifier<?>> notRevertedChanges;
+
+            /**
+             * Constructs an RevertFailedException with the list of changes that were not reverted.
+             *
+             * @param notRevertedChanges list of changes that were not reverted
+             * @param cause              the cause of revert failure
+             */
+            public RevertFailedException(@Nonnull final List<InstanceIdentifier<?>> notRevertedChanges,
+                                         final Throwable cause) {
+                super(cause);
+                checkNotNull(notRevertedChanges, "notRevertedChanges should not be null");
+                this.notRevertedChanges = ImmutableList.copyOf(notRevertedChanges);
+            }
+
+            /**
+             * Returns the list of changes that were not reverted.
+             *
+             * @return list of changes that were not reverted
+             */
+            @Nonnull
+            public List<InstanceIdentifier<?>> getNotRevertedChanges() {
+                return notRevertedChanges;
+            }
+        }
+    }
+}
\ No newline at end of file