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>

4 files changed, 354 insertions, 0 deletions

diff --git a/infra/translate-impl/src/main/java/io/fd/honeycomb/v3po/translate/impl/read/GenericListReader.java b/infra/translate-impl/src/main/java/io/fd/honeycomb/v3po/translate/impl/read/GenericListReader.java
new file mode 100644
index 000000000..defb2e51b
--- /dev/null
+++ b/infra/translate-impl/src/main/java/io/fd/honeycomb/v3po/translate/impl/read/GenericListReader.java
@@ -0,0 +1,117 @@
+/*
+ * 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.impl.read;
+
+import static com.google.common.base.Preconditions.checkArgument;
+
+import com.google.common.annotations.Beta;
+import com.google.common.base.Optional;
+import io.fd.honeycomb.v3po.translate.read.ListReader;
+import io.fd.honeycomb.v3po.translate.read.ReadContext;
+import io.fd.honeycomb.v3po.translate.read.ReadFailedException;
+import io.fd.honeycomb.v3po.translate.spi.read.ListReaderCustomizer;
+import io.fd.honeycomb.v3po.translate.util.RWUtils;
+import io.fd.honeycomb.v3po.translate.util.read.AbstractGenericReader;
+import java.util.ArrayList;
+import java.util.List;
+import javax.annotation.Nonnull;
+import javax.annotation.concurrent.ThreadSafe;
+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;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Composite implementation of {@link ListReader} able to place the read result into parent builder object intended
+ * for list node type.
+ * <p/>
+ * This reader checks if the IDs are wildcarded in which case it performs read of all list entries. In case the ID has a
+ * key, it reads only the specified value.
+ */
+@Beta
+@ThreadSafe
+public final class GenericListReader<C extends DataObject & Identifiable<K>, K extends Identifier<C>, B extends Builder<C>>
+        extends AbstractGenericReader<C, B> implements ListReader<C, K, B> {
+
+    private static final Logger LOG = LoggerFactory.getLogger(GenericListReader.class);
+
+    private final ListReaderCustomizer<C, K, B> customizer;
+
+    /**
+     * Create new {@link GenericListReader}
+     *
+     * @param managedDataObjectType Class object for managed data type. Must come from a list node type.
+     * @param customizer            Customizer instance to customize this generic reader
+     */
+    public GenericListReader(@Nonnull final InstanceIdentifier<C> managedDataObjectType,
+                             @Nonnull final ListReaderCustomizer<C, K, B> customizer) {
+        super(managedDataObjectType);
+        this.customizer = customizer;
+    }
+
+    @Override
+    @Nonnull
+    public List<C> readList(@Nonnull final InstanceIdentifier<C> id,
+                            @Nonnull final ReadContext ctx) throws ReadFailedException {
+        LOG.trace("{}: Reading all list entries", this);
+        final List<K> allIds = getAllIds(id, ctx);
+        LOG.debug("{}: Reading list entries for: {}", this, allIds);
+
+        final ArrayList<C> allEntries = new ArrayList<>(allIds.size());
+        for (K key : allIds) {
+            final InstanceIdentifier.IdentifiableItem<C, K> currentBdItem = RWUtils.getCurrentIdItem(id, key);
+            final InstanceIdentifier<C> keyedId = RWUtils.replaceLastInId(id, currentBdItem);
+            final Optional<C> read = readCurrent(keyedId, ctx);
+            if (read.isPresent()) {
+                final DataObject singleItem = read.get();
+                checkArgument(getManagedDataObjectType().getTargetType().isAssignableFrom(singleItem.getClass()));
+                allEntries.add(getManagedDataObjectType().getTargetType().cast(singleItem));
+            }
+        }
+        return allEntries;
+    }
+
+    @Override
+    public List<K> getAllIds(@Nonnull final InstanceIdentifier<C> id, @Nonnull final ReadContext ctx)
+            throws ReadFailedException {
+        LOG.trace("{}: Getting all list ids", this);
+        final List<K> allIds = customizer.getAllIds(id, ctx);
+        LOG.debug("{}: All list ids: {}", this, allIds);
+        return allIds;
+    }
+
+    @Override
+    public void merge(@Nonnull final Builder<? extends DataObject> builder, @Nonnull final List<C> readData) {
+        customizer.merge(builder, readData);
+    }
+
+    @Override
+    public void readCurrentAttributes(@Nonnull final InstanceIdentifier<C> id, @Nonnull final B builder,
+                                      @Nonnull final ReadContext ctx)
+            throws ReadFailedException {
+        customizer.readCurrentAttributes(id, builder, ctx);
+    }
+
+    @Override
+    public B getBuilder(@Nonnull final InstanceIdentifier<C> id) {
+        return customizer.getBuilder(id);
+    }
+
+}
diff --git a/infra/translate-impl/src/main/java/io/fd/honeycomb/v3po/translate/impl/read/GenericReader.java b/infra/translate-impl/src/main/java/io/fd/honeycomb/v3po/translate/impl/read/GenericReader.java
new file mode 100644
index 000000000..eace7fa89
--- /dev/null
+++ b/infra/translate-impl/src/main/java/io/fd/honeycomb/v3po/translate/impl/read/GenericReader.java
@@ -0,0 +1,70 @@
+/*
+ * 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.impl.read;
+
+import com.google.common.annotations.Beta;
+import io.fd.honeycomb.v3po.translate.read.ReadContext;
+import io.fd.honeycomb.v3po.translate.read.ReadFailedException;
+import io.fd.honeycomb.v3po.translate.read.Reader;
+import io.fd.honeycomb.v3po.translate.spi.read.ReaderCustomizer;
+import io.fd.honeycomb.v3po.translate.util.read.AbstractGenericReader;
+import javax.annotation.Nonnull;
+import javax.annotation.concurrent.ThreadSafe;
+import org.opendaylight.yangtools.concepts.Builder;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+/**
+ * Composite implementation of {@link Reader}.
+ */
+@Beta
+@ThreadSafe
+public final class GenericReader<C extends DataObject, B extends Builder<C>> extends AbstractGenericReader<C, B>
+    implements Reader<C, B> {
+
+    private final ReaderCustomizer<C, B> customizer;
+
+    /**
+     * Create a new {@link GenericReader}.
+     *
+     * @param id Instance identifier for managed data type
+     * @param customizer Customizer instance to customize this generic reader
+     */
+    public GenericReader(@Nonnull final InstanceIdentifier<C> id,
+                         @Nonnull final ReaderCustomizer<C, B> customizer) {
+        super(id);
+        this.customizer = customizer;
+    }
+
+    @Override
+    public void readCurrentAttributes(@Nonnull final InstanceIdentifier<C> id,
+                                      @Nonnull final B builder,
+                                      @Nonnull final ReadContext ctx) throws ReadFailedException {
+        customizer.readCurrentAttributes(id, builder, ctx);
+    }
+
+    @Override
+    public B getBuilder(@Nonnull final InstanceIdentifier<C> id) {
+        return customizer.getBuilder(id);
+    }
+
+    @Override
+    public void merge(@Nonnull final Builder<? extends DataObject> parentBuilder, @Nonnull final C readValue) {
+        customizer.merge(parentBuilder, readValue);
+    }
+
+}
diff --git a/infra/translate-impl/src/main/java/io/fd/honeycomb/v3po/translate/impl/write/GenericListWriter.java b/infra/translate-impl/src/main/java/io/fd/honeycomb/v3po/translate/impl/write/GenericListWriter.java
new file mode 100644
index 000000000..32daf5975
--- /dev/null
+++ b/infra/translate-impl/src/main/java/io/fd/honeycomb/v3po/translate/impl/write/GenericListWriter.java
@@ -0,0 +1,106 @@
+/*
+ * 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.impl.write;
+
+import io.fd.honeycomb.v3po.translate.spi.write.ListWriterCustomizer;
+import io.fd.honeycomb.v3po.translate.spi.write.WriterCustomizer;
+import io.fd.honeycomb.v3po.translate.util.RWUtils;
+import io.fd.honeycomb.v3po.translate.util.write.AbstractGenericWriter;
+import io.fd.honeycomb.v3po.translate.write.ListWriter;
+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.Identifiable;
+import org.opendaylight.yangtools.yang.binding.Identifier;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+/**
+ * Generic list node writer with customizable behavior thanks to injected customizer.
+ */
+public final class GenericListWriter<D extends DataObject & Identifiable<K>, K extends Identifier<D>> extends
+        AbstractGenericWriter<D> implements ListWriter<D, K> {
+
+    private final WriterCustomizer<D> customizer;
+
+    public GenericListWriter(@Nonnull final InstanceIdentifier<D> type,
+                             @Nonnull final ListWriterCustomizer<D, K> customizer) {
+        super(type);
+        this.customizer = customizer;
+    }
+
+    @Override
+    protected void writeCurrentAttributes(@Nonnull final InstanceIdentifier<D> id, @Nonnull final D data,
+                                          @Nonnull final WriteContext ctx) throws WriteFailedException {
+        customizer.writeCurrentAttributes(id, data, ctx);
+    }
+
+    @Override
+    protected void deleteCurrentAttributes(@Nonnull final InstanceIdentifier<D> id, @Nonnull final D dataBefore,
+                                           @Nonnull final WriteContext ctx) throws WriteFailedException {
+        customizer.deleteCurrentAttributes(id, dataBefore, ctx);
+    }
+
+    @Override
+    protected void updateCurrentAttributes(@Nonnull final InstanceIdentifier<D> id, @Nonnull final D dataBefore,
+                                           @Nonnull final D dataAfter, @Nonnull final WriteContext ctx)
+        throws WriteFailedException {
+        customizer.updateCurrentAttributes(id, dataBefore, dataAfter, ctx);
+    }
+
+    @Override
+    protected void writeCurrent(final InstanceIdentifier<D> id, final D data, final WriteContext ctx)
+        throws WriteFailedException {
+        // Make sure the key is present
+        if (isWildcarded(id)) {
+            super.writeCurrent(getSpecificId(id, data), data, ctx);
+        } else {
+            super.writeCurrent(id, data, ctx);
+        }
+    }
+
+    @Override
+    protected void updateCurrent(final InstanceIdentifier<D> id, final D dataBefore, final D dataAfter,
+                                 final WriteContext ctx) throws WriteFailedException {
+        // Make sure the key is present
+        if (isWildcarded(id)) {
+            super.updateCurrent(getSpecificId(id, dataBefore), dataBefore, dataAfter, ctx);
+        } else {
+            super.updateCurrent(id, dataBefore, dataAfter, ctx);
+        }
+    }
+
+    @Override
+    protected void deleteCurrent(final InstanceIdentifier<D> id, final D dataBefore, final WriteContext ctx)
+        throws WriteFailedException {
+        // Make sure the key is present
+        if (isWildcarded(id)) {
+            super.deleteCurrent(getSpecificId(id, dataBefore), dataBefore, ctx);
+        } else {
+            super.deleteCurrent(id, dataBefore, ctx);
+        }
+    }
+
+    private boolean isWildcarded(final InstanceIdentifier<D> id) {
+        return id.firstIdentifierOf(getManagedDataObjectType().getTargetType()).isWildcarded();
+    }
+
+    private InstanceIdentifier<D> getSpecificId(final InstanceIdentifier<D> currentId, final D current) {
+        return RWUtils.replaceLastInId(currentId,
+            new InstanceIdentifier.IdentifiableItem<>(currentId.getTargetType(), current.getKey()));
+    }
+}
diff --git a/infra/translate-impl/src/main/java/io/fd/honeycomb/v3po/translate/impl/write/GenericWriter.java b/infra/translate-impl/src/main/java/io/fd/honeycomb/v3po/translate/impl/write/GenericWriter.java
new file mode 100644
index 000000000..65c192ffa
--- /dev/null
+++ b/infra/translate-impl/src/main/java/io/fd/honeycomb/v3po/translate/impl/write/GenericWriter.java
@@ -0,0 +1,61 @@
+/*
+ * 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.impl.write;
+
+import io.fd.honeycomb.v3po.translate.spi.write.WriterCustomizer;
+import io.fd.honeycomb.v3po.translate.util.write.AbstractGenericWriter;
+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;
+
+/**
+ * Generic writer with customizable behavior thanks to injected customizer.
+ */
+public final class GenericWriter<D extends DataObject> extends AbstractGenericWriter<D> {
+
+    private final WriterCustomizer<D> customizer;
+
+    public GenericWriter(@Nonnull final InstanceIdentifier<D> type,
+                         @Nonnull final WriterCustomizer<D> customizer) {
+        super(type);
+        this.customizer = customizer;
+    }
+
+    @Override
+    protected void writeCurrentAttributes(@Nonnull final InstanceIdentifier<D> id, @Nonnull final D data,
+                                          @Nonnull final WriteContext ctx) throws WriteFailedException {
+        // TODO wrap all customizer invocations in try catch, and wrap runtime exceptions in ReadFailed
+        // TODO same for readers
+        customizer.writeCurrentAttributes(id, data, ctx);
+    }
+
+    @Override
+    protected void deleteCurrentAttributes(@Nonnull final InstanceIdentifier<D> id, @Nonnull final D dataBefore,
+                                           @Nonnull final WriteContext ctx) throws WriteFailedException {
+        customizer.deleteCurrentAttributes(id, dataBefore, ctx);
+    }
+
+    @Override
+    protected void updateCurrentAttributes(@Nonnull final InstanceIdentifier<D> id,
+                                           @Nonnull final D dataBefore,
+                                           @Nonnull final D dataAfter,
+                                           @Nonnull final WriteContext ctx) throws WriteFailedException {
+        customizer.updateCurrentAttributes(id, dataBefore, dataAfter, ctx);
+    }
+}