Implement support for v10 model entities.
[aai/model-loader.git] / src / main / java / org / openecomp / modelloader / entity / model / ModelArtifactParser.java
index 625145f..de27924 100644 (file)
-/*-
- * ============LICENSE_START=======================================================
- * MODEL LOADER SERVICE
- * ================================================================================
- * Copyright (C) 2017 AT&T Intellectual Property. 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.openecomp.modelloader.entity.model;
-
-import org.openecomp.cl.api.Logger;
-import org.openecomp.cl.eelf.LoggerFactory;
-import org.openecomp.modelloader.entity.Artifact;
-import org.openecomp.modelloader.entity.ArtifactType;
-import org.openecomp.modelloader.service.ModelLoaderMsgs;
-import org.openecomp.modelloader.util.JsonXmlConverter;
-import org.w3c.dom.Document;
-import org.w3c.dom.Node;
-import org.w3c.dom.NodeList;
-import org.xml.sax.InputSource;
-
-import java.io.StringReader;
-import java.io.StringWriter;
-import java.util.ArrayList;
-import java.util.List;
-
-import javax.xml.parsers.DocumentBuilder;
-import javax.xml.parsers.DocumentBuilderFactory;
-import javax.xml.transform.OutputKeys;
-import javax.xml.transform.Transformer;
-import javax.xml.transform.TransformerException;
-import javax.xml.transform.TransformerFactory;
-import javax.xml.transform.dom.DOMSource;
-import javax.xml.transform.stream.StreamResult;
-
-public class ModelArtifactParser {
-
-  private static String MODELS_ELEMENT = "models";
-  private static String MODEL_ELEMENT = "model";
-  private static String NAMED_QUERIES_ELEMENT = "named-queries";
-  private static String NAMED_QUERY_ELEMENT = "named-query";
-  private static String MODEL_NAME_VERSION_ID = "model-name-version-id";
-  private static String NAMED_QUERY_VERSION_ID = "named-query-uuid";
-  private static String RELATIONSHIP_DATA = "relationship-data";
-  private static String RELATIONSHIP_KEY = "relationship-key";
-  private static String RELATIONSHIP_VALUE = "relationship-value";
-  private static String MODEL_ELEMENT_RELATIONSHIP_KEY = "model.model-name-version-id";
-
-  private static Logger logger = LoggerFactory.getInstance()
-      .getLogger(ModelArtifactParser.class.getName());
-
-  /**
-   * This method parses the given artifact payload in byte array format and
-   * generates a list of model artifacts according to the content.
-   * 
-   * @param artifactPayload
-   *          artifact content to be parsed
-   * @param artifactName
-   *          name of the artifact
-   * @return a list of model artifacts
-   */
-  public List<Artifact> parse(byte[] artifactPayload, String artifactName) {
-    String payload = new String(artifactPayload);
-    List<Artifact> modelList = new ArrayList<Artifact>();
-
-    try {
-      // Artifact could be JSON or XML
-      if (JsonXmlConverter.isValidJson(payload)) {
-        payload = JsonXmlConverter.convertJsonToXml(payload);
-      }
-
-      DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
-      DocumentBuilder builder = factory.newDocumentBuilder();
-      InputSource is = new InputSource(new StringReader(payload));
-      Document doc = builder.parse(is);
-
-      if ((doc.getDocumentElement().getNodeName().equalsIgnoreCase(MODEL_ELEMENT))
-          || (doc.getDocumentElement().getNodeName().equalsIgnoreCase(NAMED_QUERY_ELEMENT))) {
-        ModelArtifact model = parseModel(doc.getDocumentElement(), payload);
-        if (model != null) {
-          modelList.add(model);
-        } else {
-          // TODO: A WARN message?
-          logger.info(ModelLoaderMsgs.DISTRIBUTION_EVENT,
-              "Unable to parse artifact " + artifactName);
-        }
-      } else if ((doc.getDocumentElement().getNodeName().equalsIgnoreCase(MODELS_ELEMENT))
-          || (doc.getDocumentElement().getNodeName().equalsIgnoreCase(NAMED_QUERIES_ELEMENT))) {
-        // The complete set of models/named-queries were contained in this
-        // artifact
-        NodeList nodeList = doc.getDocumentElement().getChildNodes();
-        for (int i = 0; i < nodeList.getLength(); i++) {
-          Node childNode = nodeList.item(i);
-          if ((childNode.getNodeName().equalsIgnoreCase(MODEL_ELEMENT))
-              || (childNode.getNodeName().equalsIgnoreCase(NAMED_QUERY_ELEMENT))) {
-            String modelPayload = nodeToString(childNode);
-            ModelArtifact model = parseModel(childNode, modelPayload);
-            if (model != null) {
-              modelList.add(model);
-            } else {
-              // TODO: A WARN message?
-              logger.info(ModelLoaderMsgs.DISTRIBUTION_EVENT,
-                  "Unable to parse artifact " + artifactName);
-              modelList.clear();
-              break;
-            }
-          }
-        }
-      }
-    } catch (Exception ex) {
-      // This may not be an error. We may be receiving an artifact that is
-      // unrelated
-      // to models. In this case, we just ignore it.
-      // TODO: A WARN message?
-      logger.info(ModelLoaderMsgs.DISTRIBUTION_EVENT,
-          "Unable to parse artifact " + artifactName + ": " + ex.getLocalizedMessage());
-    }
-
-    return modelList;
-  }
-
-  private ModelArtifact parseModel(Node modelNode, String payload) {
-    ModelArtifact model = new ModelArtifact();
-    model.setPayload(payload);
-
-    if (modelNode.getNodeName().equalsIgnoreCase(MODEL_ELEMENT)) {
-      model.setType(ArtifactType.MODEL);
-    } else {
-      model.setType(ArtifactType.NAMED_QUERY);
-    }
-
-    parseNode(modelNode, model);
-
-    if (model.getNameVersionId() == null) {
-      return null;
-    }
-
-    return model;
-  }
-
-  private void parseNode(Node node, ModelArtifact model) {
-    if (node.getNodeName().equalsIgnoreCase(MODEL_NAME_VERSION_ID)) {
-      model.setNameVersionId(node.getTextContent().trim());
-    } else if (node.getNodeName().equalsIgnoreCase(NAMED_QUERY_VERSION_ID)) {
-      model.setNameVersionId(node.getTextContent().trim());
-    } else if (node.getNodeName().equalsIgnoreCase(RELATIONSHIP_DATA)) {
-      parseRelationshipNode(node, model);
-    } else {
-      NodeList nodeList = node.getChildNodes();
-      for (int i = 0; i < nodeList.getLength(); i++) {
-        Node childNode = nodeList.item(i);
-        parseNode(childNode, model);
-      }
-    }
-  }
-
-  private void parseRelationshipNode(Node node, ModelArtifact model) {
-    String key = null;
-    String value = null;
-
-    NodeList nodeList = node.getChildNodes();
-    for (int i = 0; i < nodeList.getLength(); i++) {
-      Node childNode = nodeList.item(i);
-      if (childNode.getNodeName().equalsIgnoreCase(RELATIONSHIP_KEY)) {
-        key = childNode.getTextContent().trim();
-      } else if (childNode.getNodeName().equalsIgnoreCase(RELATIONSHIP_VALUE)) {
-        value = childNode.getTextContent().trim();
-      }
-    }
-
-    if ((key != null) && (key.equalsIgnoreCase(MODEL_ELEMENT_RELATIONSHIP_KEY))) {
-      if (value != null) {
-        model.addDependentModelId(value);
-      }
-    }
-  }
-
-  private String nodeToString(Node node) throws TransformerException {
-    StringWriter sw = new StringWriter();
-    Transformer transfomer = TransformerFactory.newInstance().newTransformer();
-    transfomer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes");
-    transfomer.transform(new DOMSource(node), new StreamResult(sw));
-    return sw.toString();
-  }
-}
+/**\r
+ * ============LICENSE_START=======================================================\r
+ * Model Loader\r
+ * ================================================================================\r
+ * Copyright © 2017 AT&T Intellectual Property.\r
+ * Copyright © 2017 Amdocs\r
+ * All rights reserved.\r
+ * ================================================================================\r
+ * Licensed under the Apache License, Version 2.0 (the "License");\r
+ * you may not use this file except in compliance with the License.\r
+ * You may obtain a copy of the License at\r
+ * http://www.apache.org/licenses/LICENSE-2.0\r
+ * Unless required by applicable law or agreed to in writing, software\r
+ * distributed under the License is distributed on an "AS IS" BASIS,\r
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * See the License for the specific language governing permissions and\r
+ * limitations under the License.\r
+ * ============LICENSE_END=========================================================\r
+ *\r
+ * ECOMP and OpenECOMP are trademarks\r
+ * and service marks of AT&T Intellectual Property.\r
+ */\r
+package org.openecomp.modelloader.entity.model;\r
+\r
+import org.openecomp.cl.api.Logger;\r
+import org.openecomp.cl.eelf.LoggerFactory;\r
+import org.openecomp.modelloader.entity.Artifact;\r
+import org.openecomp.modelloader.entity.ArtifactType;\r
+import org.openecomp.modelloader.service.ModelLoaderMsgs;\r
+import org.openecomp.modelloader.util.JsonXmlConverter;\r
+\r
+import org.w3c.dom.Document;\r
+import org.w3c.dom.Element;\r
+import org.w3c.dom.Node;\r
+import org.w3c.dom.NodeList;\r
+import org.xml.sax.InputSource;\r
+\r
+import java.io.StringReader;\r
+import java.io.StringWriter;\r
+import java.util.ArrayList;\r
+import java.util.List;\r
+\r
+import javax.xml.XMLConstants;\r
+import javax.xml.parsers.DocumentBuilder;\r
+import javax.xml.parsers.DocumentBuilderFactory;\r
+import javax.xml.transform.OutputKeys;\r
+import javax.xml.transform.Transformer;\r
+import javax.xml.transform.TransformerException;\r
+import javax.xml.transform.TransformerFactory;\r
+import javax.xml.transform.dom.DOMSource;\r
+import javax.xml.transform.stream.StreamResult;\r
+\r
+\r
+public class ModelArtifactParser {\r
+\r
+       private static String MODELS_ELEMENT = "models";\r
+       private static String MODEL_ELEMENT = "model";\r
+       private static String NAMED_QUERIES_ELEMENT = "named-queries";\r
+       private static String NAMED_QUERY_ELEMENT = "named-query";\r
+       private static String MODEL_NAME_VERSION_ID = "model-name-version-id";\r
+       private static String MODEL_VER = "model-ver";\r
+       private static String MODEL_VERSION_ID = "model-version-id";\r
+       private static String MODEL_INVARIANT_ID = "model-invariant-id";\r
+       private static String NAMED_QUERY_VERSION_ID = "named-query-uuid";\r
+       private static String RELATIONSHIP_DATA = "relationship-data";\r
+       private static String RELATIONSHIP_KEY = "relationship-key";\r
+       private static String RELATIONSHIP_VALUE = "relationship-value";\r
+       private static String MODEL_ELEMENT_RELATIONSHIP_KEY = "model.model-invariant-id";\r
+       private static String MODEL_VER_ELEMENT_RELATIONSHIP_KEY = "model-ver.model-version-id";\r
+       \r
+       private  static Logger logger = LoggerFactory.getInstance().getLogger(ModelArtifactParser.class.getName());\r
+       \r
+       public List<Artifact> parse(byte[] artifactPayload, String artifactName) {\r
+         String payload = new String(artifactPayload);\r
+         List<Artifact> modelList = new ArrayList<Artifact>();\r
+\r
+         try {\r
+           // Artifact could be JSON or XML\r
+           if (JsonXmlConverter.isValidJson(payload)) {\r
+             payload = JsonXmlConverter.convertJsonToXml(payload);\r
+           }\r
+\r
+           DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();\r
+           DocumentBuilder builder = factory.newDocumentBuilder();\r
+           InputSource is = new InputSource(new StringReader(payload));\r
+           Document doc = builder.parse(is);\r
+\r
+           if ( (doc.getDocumentElement().getNodeName().equalsIgnoreCase(MODEL_ELEMENT)) || \r
+               (doc.getDocumentElement().getNodeName().equalsIgnoreCase(NAMED_QUERY_ELEMENT)) ) {\r
+\r
+             ModelArtifact model = parseModel(doc.getDocumentElement(), payload);\r
+\r
+             if (model != null) {\r
+               if ( ArtifactType.MODEL.equals(model.getType())) {\r
+                 logger.info( ModelLoaderMsgs.DISTRIBUTION_EVENT, "Model parsed =====>>>> "\r
+                     + "Model-invariant-Id: "+ model.getModelInvariantId()\r
+                     + " Model-Version-Id: "+ model.getModelVerId());\r
+               }\r
+               modelList.add(model);\r
+             }\r
+             else {\r
+               logger.error(ModelLoaderMsgs.ARTIFACT_PARSE_ERROR, "Unable to parse artifact " + artifactName);\r
+               return null;\r
+             }\r
+           }\r
+           else if ( (doc.getDocumentElement().getNodeName().equalsIgnoreCase(MODELS_ELEMENT)) ||\r
+               (doc.getDocumentElement().getNodeName().equalsIgnoreCase(NAMED_QUERIES_ELEMENT)) ) {\r
+             // The complete set of models/named-queries were contained in this artifact\r
+             NodeList nodeList = doc.getDocumentElement().getChildNodes();\r
+             for (int i = 0; i < nodeList.getLength(); i++) {\r
+               Node childNode = nodeList.item(i);\r
+               if ( (childNode.getNodeName().equalsIgnoreCase(MODEL_ELEMENT)) || \r
+                   (childNode.getNodeName().equalsIgnoreCase(NAMED_QUERY_ELEMENT)) ) {\r
+                 String modelPayload = nodeToString(childNode);\r
+                 ModelArtifact model = parseModel(childNode, modelPayload);\r
+                 if (model != null) {\r
+                   modelList.add(model);\r
+                 }\r
+                 else {\r
+                   logger.error(ModelLoaderMsgs.ARTIFACT_PARSE_ERROR, "Unable to parse artifact " + artifactName);\r
+                   modelList.clear();\r
+                   break;\r
+                 }\r
+               }\r
+             }\r
+           }\r
+         }\r
+         catch (Exception ex) {\r
+           logger.error(ModelLoaderMsgs.ARTIFACT_PARSE_ERROR, "Unable to parse artifact " + artifactName + ": " + ex.getLocalizedMessage());\r
+         }\r
+\r
+         return modelList;\r
+       }\r
+\r
+       private void printDetails(Node modelVer) throws TransformerException {\r
+         logger.info(ModelLoaderMsgs.DISTRIBUTION_EVENT, nodeToString(modelVer));\r
+       }\r
+\r
+       private ModelArtifact parseModel(Node modelNode, String payload) {\r
+         ModelArtifact model = new ModelArtifact();\r
+         model.setPayload(payload);\r
+\r
+         if (modelNode.getNodeName().equalsIgnoreCase(MODEL_ELEMENT)) {\r
+           //compare with Model-ver\r
+           model.setType(ArtifactType.MODEL);\r
+         }\r
+         else {\r
+           model.setType(ArtifactType.NAMED_QUERY);\r
+         }\r
+\r
+         Element e = (Element)modelNode;\r
+         model.setModelNamespace(e.getAttribute("xmlns"));\r
+\r
+         parseNode(modelNode, model);\r
+\r
+         if (model.getModelInvariantId() == null  && model.getNameVersionId() == null) {\r
+           return null;\r
+         }\r
+\r
+         return model;\r
+       }\r
+\r
+       private void parseNode(Node node, ModelArtifact model) {\r
+\r
+         if(node.getNodeName().equalsIgnoreCase(MODEL_NAME_VERSION_ID)){\r
+           model.setModelVerId(node.getTextContent().trim());\r
+           model.setV9Artifact(false);\r
+         }\r
+         else if(node.getNodeName().equalsIgnoreCase("model-id")){\r
+           model.setModelInvariantId(node.getTextContent().trim());\r
+           model.setV9Artifact(false);\r
+         }\r
+\r
+         else if (node.getNodeName().equalsIgnoreCase(MODEL_INVARIANT_ID)) {\r
+           model.setModelInvariantId(node.getTextContent().trim());\r
+         }\r
+         else if (node.getNodeName().equalsIgnoreCase(MODEL_VERSION_ID)) {\r
+           model.setModelVerId(node.getTextContent().trim());\r
+           //Change to Model Invariant Id\r
+         }\r
+         else if (node.getNodeName().equalsIgnoreCase(NAMED_QUERY_VERSION_ID)) {\r
+           model.setNameVersionId(node.getTextContent().trim());\r
+         }\r
+         else if (node.getNodeName().equalsIgnoreCase(RELATIONSHIP_DATA)) {\r
+           parseRelationshipNode(node, model);\r
+           if(model.getModelModelInvariantId()!=null && model.getModelVerModelVersionId()!=null && !model.getModelModelInvariantId().isEmpty() && !model.getModelVerModelVersionId().isEmpty()){\r
+             model.addDependentModelId(model.getModelModelInvariantId() + "|" + model.getModelVerModelVersionId());\r
+             model.setModelModelInvariantId("");\r
+             model.setModelVerModelVersionId("");\r
+           }\r
+         }\r
+         else {\r
+\r
+           if (node.getNodeName().equalsIgnoreCase(MODEL_VER)) {\r
+             model.setModelVer(node);\r
+             if ( (model.getModelNamespace() != null) && (!model.getModelNamespace().isEmpty()) ) {\r
+               Element e = (Element) node;\r
+               e.setAttributeNS(XMLConstants.XMLNS_ATTRIBUTE_NS_URI, "xmlns", model.getModelNamespace());\r
+               System.out.println("Setting NS: " + e.getAttribute("xmlns"));\r
+             }\r
+           }\r
+\r
+           NodeList nodeList = node.getChildNodes();\r
+\r
+           for (int i = 0; i < nodeList.getLength(); i++) {\r
+             Node childNode = nodeList.item(i); \r
+             parseNode(childNode, model);\r
+           }\r
+         }\r
+       }\r
+\r
+       private void parseRelationshipNode(Node node, ModelArtifact model) {\r
+\r
+         //invariant-id comes before model-version-id .. create a list of values\r
+         String key = null;\r
+         String value = null;\r
+         String modelVersionIdKey=null;\r
+         String modelInvariantIdIdKey=null;\r
+         String modelVersionIdValue=null;\r
+         String modelInvariantIdIdValue=null;\r
+\r
+         NodeList nodeList = node.getChildNodes();\r
+         for (int i = 0; i < nodeList.getLength(); i++) {\r
+           Node childNode = nodeList.item(i);\r
+\r
+\r
+           if (childNode.getNodeName().equalsIgnoreCase(RELATIONSHIP_KEY)) {\r
+             key = childNode.getTextContent().trim();\r
+             if(key.equalsIgnoreCase(MODEL_VER_ELEMENT_RELATIONSHIP_KEY)){\r
+               modelVersionIdKey = key;\r
+             }\r
+             else if(key.equalsIgnoreCase(MODEL_ELEMENT_RELATIONSHIP_KEY)){\r
+               modelInvariantIdIdKey = key;\r
+             }\r
+           }\r
+           else if (childNode.getNodeName().equalsIgnoreCase(RELATIONSHIP_VALUE)) {\r
+             value = childNode.getTextContent().trim();\r
+             if(modelVersionIdKey!=null){\r
+               modelVersionIdValue = value;\r
+               model.setModelVerModelVersionId(modelVersionIdValue);\r
+             }\r
+             else if(modelInvariantIdIdKey!=null){\r
+               modelInvariantIdIdValue = value;\r
+               model.setModelModelInvariantId(modelInvariantIdIdValue);\r
+             } \r
+\r
+           }\r
+         }\r
+\r
+         if ( (key != null) && (key.equalsIgnoreCase(MODEL_ELEMENT_RELATIONSHIP_KEY )) && \r
+             (model.isV9Artifact == false ||ArtifactType.NAMED_QUERY.equals(model.getType())) ) {\r
+           if (value != null) {\r
+             model.addDependentModelId(value);\r
+           }\r
+         }\r
+       }\r
+\r
+       private String nodeToString(Node node) throws TransformerException {\r
+         StringWriter sw = new StringWriter();\r
+         Transformer t = TransformerFactory.newInstance().newTransformer();\r
+         t.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes");\r
+         t.transform(new DOMSource(node), new StreamResult(sw));\r
+         return sw.toString();\r
+       }\r
+}\r