Adding additional APIs for YANG serializers

Adding APIs for YANG based properties node serializer

Change-Id: Ic76204e0292fdbaede4ff47f4ddda91dcfa3b764
Issue-ID: CCSDK-377
Signed-off-by: Gaurav Agrawal <gaurav.agrawal@huawei.com>

14 files changed, 334 insertions, 10 deletions

diff --git a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/Annotation.java b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/Annotation.java
index 13f1c323..7271c3d7 100644
--- a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/Annotation.java
+++ b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/Annotation.java
@@ -18,7 +18,7 @@
  * ============LICENSE_END=========================================================
  */
 
-package org.onap.ccsdk.sli.plugins.yangserializers;
+package org.onap.ccsdk.sli.plugins.yangserializers.dfserializer;
 
 /**
  * Representation of an entity that represents annotated attribute.
diff --git a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/DataFormat.java b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/DataFormat.java
index 0d1928b3..6fb11e70 100644
--- a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/DataFormat.java
+++ b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/DataFormat.java
@@ -18,7 +18,7 @@
  * ============LICENSE_END=========================================================
  */
 
-package org.onap.ccsdk.sli.plugins.yangserializers;
+package org.onap.ccsdk.sli.plugins.yangserializers.dfserializer;
 
 /**
  * Representation of data format.
diff --git a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/DataFormatSerializer.java b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/DataFormatSerializer.java
index bcd5991d..e703b173 100644
--- a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/DataFormatSerializer.java
+++ b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/DataFormatSerializer.java
@@ -18,7 +18,7 @@
  * ============LICENSE_END=========================================================
  */
 
-package org.onap.ccsdk.sli.plugins.yangserializers;
+package org.onap.ccsdk.sli.plugins.yangserializers.dfserializer;
 
 import java.util.List;
 import java.util.Map;
diff --git a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/DataFormatSerializerContext.java b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/DataFormatSerializerContext.java
index 50cb2daf..e2ead53f 100644
--- a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/DataFormatSerializerContext.java
+++ b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/DataFormatSerializerContext.java
@@ -18,7 +18,7 @@
  * ============LICENSE_END=========================================================
  */
 
-package org.onap.ccsdk.sli.plugins.yangserializers;
+package org.onap.ccsdk.sli.plugins.yangserializers.dfserializer;
 
 import java.util.Map;
 
diff --git a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/JsonSerializer.java b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/JsonSerializer.java
index 072cfb09..6013664c 100644
--- a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/JsonSerializer.java
+++ b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/JsonSerializer.java
@@ -18,7 +18,7 @@
  * ============LICENSE_END=========================================================
  */
 
-package org.onap.ccsdk.sli.plugins.yangserializers;
+package org.onap.ccsdk.sli.plugins.yangserializers.dfserializer;
 
 import java.util.List;
 import java.util.Map;
diff --git a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/Listener.java b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/Listener.java
index a0976822..e5812dbb 100644
--- a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/Listener.java
+++ b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/Listener.java
@@ -18,7 +18,7 @@
  * ============LICENSE_END=========================================================
  */
 
-package org.onap.ccsdk.sli.plugins.yangserializers;
+package org.onap.ccsdk.sli.plugins.yangserializers.dfserializer;
 
 /**
  * Abstraction of listener.
diff --git a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/MdsalSerializerHelper.java b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/MdsalSerializerHelper.java
index c9bda511..311fc2d6 100644
--- a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/MdsalSerializerHelper.java
+++ b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/MdsalSerializerHelper.java
@@ -18,7 +18,7 @@
  * ============LICENSE_END=========================================================
  */
 
-package org.onap.ccsdk.sli.plugins.yangserializers;
+package org.onap.ccsdk.sli.plugins.yangserializers.dfserializer;
 
 import java.util.Map;
 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
diff --git a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/NodeType.java b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/NodeType.java
index 5a63d632..ffa35e2b 100644
--- a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/NodeType.java
+++ b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/NodeType.java
@@ -18,7 +18,7 @@
  * ============LICENSE_END=========================================================
  */
 
-package org.onap.ccsdk.sli.plugins.yangserializers;
+package org.onap.ccsdk.sli.plugins.yangserializers.dfserializer;
 
 /**
  * Representation of type of data node.
diff --git a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/SerializerHelper.java b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/SerializerHelper.java
index a4bbce52..4e6d2944 100644
--- a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/SerializerHelper.java
+++ b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/SerializerHelper.java
@@ -18,7 +18,7 @@
  * ============LICENSE_END=========================================================
  */
 
-package org.onap.ccsdk.sli.plugins.yangserializers;
+package org.onap.ccsdk.sli.plugins.yangserializers.dfserializer;
 
 import java.util.Map;
 
diff --git a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/XmlSerializer.java b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/XmlSerializer.java
index ba5d8ed2..0cfb4d17 100644
--- a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/XmlSerializer.java
+++ b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/dfserializer/XmlSerializer.java
@@ -18,7 +18,7 @@
  * ============LICENSE_END=========================================================
  */
 
-package org.onap.ccsdk.sli.plugins.yangserializers;
+package org.onap.ccsdk.sli.plugins.yangserializers.dfserializer;
 
 import java.util.List;
 import java.util.Map;
diff --git a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/pnserializer/MdsalPropertiesNodeSerializer.java b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/pnserializer/MdsalPropertiesNodeSerializer.java
new file mode 100644
index 00000000..67e9c1e5
--- /dev/null
+++ b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/pnserializer/MdsalPropertiesNodeSerializer.java
@@ -0,0 +1,59 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - CCSDK
+ * ================================================================================
+ * Copyright (C) 2018 Huawei Technologies Co., Ltd. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.ccsdk.sli.plugins.yangserializers.pnserializer;
+
+import java.util.Map;
+import org.opendaylight.yangtools.yang.model.api.SchemaContext;
+import org.opendaylight.yangtools.yang.model.api.SchemaNode;
+import org.slf4j.Logger;
+import static org.slf4j.LoggerFactory.getLogger;
+
+/**
+ * Representation of mdsal based properties node serializer implementation.
+ */
+public class MdsalPropertiesNodeSerializer extends PropertiesNodeSerializer<SchemaNode, SchemaContext> {
+
+    private SchemaNode curSchema;
+    private PropertiesNode node;
+    private static final Logger LOG = getLogger(MdsalPropertiesNodeSerializer.class);
+
+    /**
+     * Creates the properties node serializer.
+     *
+     * @param schemaNode schema node.
+     * @param schemaCtx  schema context
+     * @param uri        URL of the request
+     */
+    public MdsalPropertiesNodeSerializer(SchemaNode schemaNode, SchemaContext schemaCtx, String uri) {
+        super(schemaNode, schemaCtx, uri);
+    }
+
+    @Override
+    public PropertiesNode encode(Map<String, String> paramMap) {
+        return null;
+    }
+
+    @Override
+    public Map<String, String> decode(PropertiesNode propertiesNode) {
+        return null;
+    }
+
+}
diff --git a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/pnserializer/NodeType.java b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/pnserializer/NodeType.java
new file mode 100644
index 00000000..94f2915a
--- /dev/null
+++ b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/pnserializer/NodeType.java
@@ -0,0 +1,33 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - CCSDK
+ * ================================================================================
+ * Copyright (C) 2018 Huawei Technologies Co., Ltd. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.ccsdk.sli.plugins.yangserializers.pnserializer;
+
+/**
+ * Representation of types of node in properties node tree.
+ */
+public enum NodeType {
+    SINGLE_INSTANCE_NODE,
+    MULTI_INSTANCE_NODE,
+    SINGLE_INSTANCE_LEAF_NODE,
+    MULTI_INSTANCE_LEAF_NODE,
+    MULTI_INSTANCE_HOLDER_NODE,
+    MULTI_INSTANCE_LEAF_HOLDER_NODE
+}
diff --git a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/pnserializer/PropertiesNode.java b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/pnserializer/PropertiesNode.java
new file mode 100644
index 00000000..fccfa6a9
--- /dev/null
+++ b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/pnserializer/PropertiesNode.java
@@ -0,0 +1,124 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - CCSDK
+ * ================================================================================
+ * Copyright (C) 2018 Huawei Technologies Co., Ltd. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.ccsdk.sli.plugins.yangserializers.pnserializer;
+
+/**
+ * Abstraction of properties node data tree. This intermediate representation
+ * will enable data format serializers to be agnostic of DG context memory
+ * nuances and thereby will enable faster development of new data faormat
+ * serializers.
+ */
+public abstract class PropertiesNode {
+
+    private String name;
+    private String namespace;
+    private String uri;
+    private PropertiesNode parent;
+
+    /**
+     * Creates an instance of properties node.
+     */
+    protected PropertiesNode() {
+    }
+
+    /**
+     * Creates an instance of properties node.
+     *
+     * @param name name of node
+     * @param namespace namespace of node, null indicates parent namespace
+     * @param uri URI of this node, if null its calculated based on parent and
+     * current value of name and namespace
+     * @param parent parent's node
+     */
+    protected PropertiesNode(String name, String namespace, String uri, PropertiesNode parent) {
+        this.name = name;
+        this.namespace = namespace;
+        this.uri = uri;
+        this.parent = parent;
+    }
+
+    /**
+     * Adds a child to a current node.
+     *
+     * @param name name of child
+     * @param namespace namespace of child, null represents parent namespace
+     * @param type type of node
+     * @return added properties node
+     */
+    public abstract PropertiesNode addChild(String name, String namespace, NodeType type);
+
+    /**
+     * Adds a child with value to a current node.
+     *
+     * @param name name of child
+     * @param namespace namespace of child, null represents parent namespace
+     * @param type type of node
+     * @param value value of node
+     * @return added properties node
+     */
+    public abstract PropertiesNode addChild(String name, String namespace, NodeType type, String value);
+
+    /**
+     * Adds a child at a given index to a current node. To be used in case of
+     * leaf holder child's which is multi instance node.
+     *
+     * @param index index at which node is to be added
+     * @param name name of child
+     * @param namespace namespace of child, null represents parent namespace
+     * @param type type of node
+     * @return added properties node
+     */
+    public abstract PropertiesNode addChild(String index, String name, String namespace, NodeType type);
+
+    public void name(String name) {
+        this.name = name;
+    }
+
+    public void namespace(String namespace) {
+        this.namespace = namespace;
+    }
+
+    public void uri(String uri) {
+        this.uri = uri;
+    }
+
+    public void parent(PropertiesNode parent) {
+        this.parent = parent;
+    }
+
+    public PropertiesNode parent() {
+        return parent;
+    }
+
+    public String name() {
+        return name;
+    }
+
+    public String namespace() {
+        return namespace;
+    }
+
+    public String uri() {
+        return uri;
+    }
+
+}
+
diff --git a/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/pnserializer/PropertiesNodeSerializer.java b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/pnserializer/PropertiesNodeSerializer.java
new file mode 100644
index 00000000..81609a6d
--- /dev/null
+++ b/restconf-client/provider/src/main/java/org/onap/ccsdk/sli/plugins/yangserializers/pnserializer/PropertiesNodeSerializer.java
@@ -0,0 +1,108 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - CCSDK
+ * ================================================================================
+ * Copyright (C) 2018 Huawei Technologies Co., Ltd. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.ccsdk.sli.plugins.yangserializers.pnserializer;
+
+import java.util.Map;
+
+/**
+ * Abstraction of an entity to enable encoding and decoding of properties
+ * to an abstract properties node tree using YANG based schema.
+ * This serializer will be used by other data format serializers and will keep
+ * them abstract from properties nuances thereby enabling quick addition of any
+ * new data format serializer.
+ *
+ * @param <T> type of schema node
+ * @param <P> schema context of the model
+ */
+public abstract class PropertiesNodeSerializer<T, P> {
+
+    /**
+     * Schema node from which the property is made.
+     */
+    private T schemaNode;
+
+    /**
+     * Schema context of the model.
+     */
+    private P schemaCtx;
+
+    /**
+     * URL pointing to the schema node.
+     */
+    private String uri;
+
+    /**
+     * Creates the properties node serializer.
+     *
+     * @param schemaNode schema node.
+     * @param schemaCtx schema context
+     * @param uri URL of the request
+     */
+    public PropertiesNodeSerializer(T schemaNode, P schemaCtx, String uri) {
+        this.schemaNode = schemaNode;
+        this.schemaCtx = schemaCtx;
+        this.uri = uri;
+    }
+
+
+    /**
+     * Encodes from properties to properties-node tree.
+     *
+     * @param paramMap parameter map
+     * @return properties node
+     */
+    public abstract PropertiesNode encode(Map<String, String> paramMap);
+
+    /**
+     * Decodes from properties-node to properties map.
+     *
+     * @param propertiesNode properties-node
+     * @return parameter map
+     */
+    public abstract Map<String, String> decode(PropertiesNode propertiesNode);
+
+    /**
+     * Returns the schema node of the property
+     *
+     * @return schema node
+     */
+    public T getSchemaNode(){
+        return schemaNode;
+    }
+
+    /**
+     * Returns the schema context
+     *
+     * @return schema node
+     */
+    public P getSchemaCtx() {
+        return schemaCtx;
+    }
+
+    /**
+     * Returns the URI.
+     *
+     * @return uri
+     */
+    public String getUri() {
+        return uri;
+    }
+}