creates common test functions

[transportpce.git] / test-common / src / main / java / org / opendaylight / transportpce / binding / converter / AbstractDataObjectConverter.java

diff --git a/test-common/src/main/java/org/opendaylight/transportpce/binding/converter/AbstractDataObjectConverter.java b/test-common/src/main/java/org/opendaylight/transportpce/binding/converter/AbstractDataObjectConverter.java
new file mode 100644 (file)
index 0000000..aa35cdf
--- /dev/null
+++ b/test-common/src/main/java/org/opendaylight/transportpce/binding/converter/AbstractDataObjectConverter.java
@@ -0,0 +1,146 @@
+/*
+ * Copyright © 2016 AT&T and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.transportpce.binding.converter;
+
+import com.google.common.base.Preconditions;
+import java.util.Map;
+import java.util.Map.Entry;
+import java.util.Optional;
+import javax.annotation.Nonnull;
+import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
+import org.opendaylight.transportpce.binding.converter.api.DataObjectConverter;
+import org.opendaylight.yangtools.yang.binding.DataContainer;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yangtools.yang.binding.Notification;
+import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
+import org.opendaylight.yangtools.yang.model.api.SchemaContext;
+import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Converts XML and {@link DataObject} vice versa.
+ *
+ */
+public abstract class AbstractDataObjectConverter implements DataObjectConverter {
+
+    private static final Logger LOG = LoggerFactory.getLogger(AbstractDataObjectConverter.class);
+
+    private final SchemaContext schemaContext;
+    private final BindingNormalizedNodeSerializer codecRegistry;
+
+    /**
+     * This is the default constructor, which should be used.
+     *
+     * @param schemaContext schema context for converter
+     * @param codecRegistry codec registry used for converting
+     *
+     */
+    protected AbstractDataObjectConverter(SchemaContext schemaContext, BindingNormalizedNodeSerializer codecRegistry) {
+        this.schemaContext = schemaContext;
+        this.codecRegistry = codecRegistry;
+    }
+
+    public SchemaContext getSchemaContext() {
+        return schemaContext;
+    }
+
+    public BindingNormalizedNodeSerializer getCodecRegistry() {
+        return codecRegistry;
+    }
+
+    /**
+     * Transforms the given input {@link NormalizedNode} into the given
+     * {@link DataObject}.
+     *
+     * @param normalizedNode normalized node you want to convert
+     * @param rootNode {@link QName} of converted normalized node root
+     *
+     * <p>
+     * The input object should be {@link ContainerNode}
+     * </p>
+     */
+    @Override
+    @SuppressWarnings("unchecked")
+    public <T extends DataObject> Optional<T> getDataObject(
+            @Nonnull NormalizedNode<?, ?> normalizedNode,
+            @Nonnull QName rootNode) {
+        Preconditions.checkNotNull(normalizedNode);
+        if (normalizedNode instanceof ContainerNode) {
+            YangInstanceIdentifier.PathArgument directChildIdentifier =
+                    YangInstanceIdentifier.of(rootNode).getLastPathArgument();
+            Optional<NormalizedNode<?, ?>> directChild =
+                    NormalizedNodes.getDirectChild(normalizedNode, directChildIdentifier).toJavaUtil();
+            if (!directChild.isPresent()) {
+                throw new IllegalStateException(String.format("Could not get the direct child of %s", rootNode));
+            }
+            normalizedNode = directChild.get();
+        }
+        YangInstanceIdentifier rootNodeYangInstanceIdentifier = YangInstanceIdentifier.of(rootNode);
+
+        Map.Entry<?, ?> bindingNodeEntry =
+                codecRegistry.fromNormalizedNode(rootNodeYangInstanceIdentifier, normalizedNode);
+        if (bindingNodeEntry == null) {
+            return Optional.empty();
+        }
+        return Optional.ofNullable((T) bindingNodeEntry.getValue());
+    }
+
+    @Override
+    @SuppressWarnings("unchecked")
+    public <T extends DataObject> Optional<T> getDataObjectFromRpc(
+            @Nonnull NormalizedNode<?, ?> normalizedNode,
+            @Nonnull SchemaPath rpcSchemaPath) {
+
+        if (! (normalizedNode instanceof ContainerNode)) {
+            LOG.error("converting normalized node is not ContainerNode. It's actual type is {}",
+                    normalizedNode.getClass().getSimpleName());
+            return Optional.empty();
+        }
+        T rpcDataObject = (T) codecRegistry.fromNormalizedNodeRpcData(rpcSchemaPath, (ContainerNode) normalizedNode);
+        return Optional.ofNullable(rpcDataObject);
+    }
+
+    @Override
+    public <T extends DataObject> Optional<NormalizedNode<?, ?>> toNormalizedNodes(@Nonnull T object,
+            Class<T> dataObjectClass) {
+        Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> normalizedNode =
+                codecRegistry.toNormalizedNode(InstanceIdentifier.create(dataObjectClass), object);
+        return Optional.ofNullable(normalizedNode.getValue());
+    }
+
+    @Override
+    public <T extends DataObject> ConvertType<T> dataContainer() {
+        return (object, objectClass) -> {
+            NormalizedNode<?, ?> value =
+                    getCodecRegistry().toNormalizedNode(InstanceIdentifier.create(objectClass), object).getValue();
+            return Optional.ofNullable(value);
+        };
+    }
+
+    @Override
+    public <T extends DataContainer> ConvertType<T> rpcData() {
+        return (object, objectClass) -> {
+            ContainerNode normalizedNodeRpcData = getCodecRegistry().toNormalizedNodeRpcData(object);
+            return Optional.ofNullable(normalizedNodeRpcData);
+        };
+    }
+
+    @Override
+    public <T extends Notification> ConvertType<T> notification() {
+        return (object, objectClass) -> {
+            ContainerNode normalizedNodeNotification = getCodecRegistry().toNormalizedNodeNotification(object);
+            return Optional.ofNullable(normalizedNodeNotification);
+        };
+    }
+}