src/main/java/org/onap/aai/modelloader/entity/model/AbstractModelArtifactParser.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * Copyright © 2017-2018 European Software Marketing Ltd.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *       http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21 package org.onap.aai.modelloader.entity.model;
  22
  23 import java.io.StringReader;
  24 import java.util.ArrayList;
  25 import java.util.List;
  26 import java.util.Objects;
  27 import java.util.function.BiConsumer;
  28 import java.util.stream.Collector;
  29 import java.util.stream.IntStream;
  30 import javax.xml.parsers.DocumentBuilder;
  31 import javax.xml.parsers.DocumentBuilderFactory;
  32 import org.onap.aai.cl.api.Logger;
  33 import org.onap.aai.cl.eelf.LoggerFactory;
  34 import org.onap.aai.modelloader.entity.Artifact;
  35 import org.onap.aai.modelloader.service.ModelLoaderMsgs;
  36 import org.w3c.dom.Document;
  37 import org.w3c.dom.Element;
  38 import org.w3c.dom.Node;
  39 import org.w3c.dom.NodeList;
  40 import org.xml.sax.InputSource;
  41
  42 /**
  43  * This class provides common behaviour for implementations of IModelParser.
  44  *
  45  * Some of the common behaviour takes the form of abstract methods that will be implemented in concrete classes.
  46  *
  47  * Some other behaviour will be overridden in concrete classes.
  48  */
  49 public abstract class AbstractModelArtifactParser implements IModelParser {
  50     private static Logger logger = LoggerFactory.getInstance().getLogger(AbstractModelArtifactParser.class);
  51
  52     protected static final String RELATIONSHIP_DATA = "relationship-data";
  53     private static final String RELATIONSHIP_KEY = "relationship-key";
  54     private static final String RELATIONSHIP_VALUE = "relationship-value";
  55
  56     BiConsumer<Pair<String, String>, Node> applyRelationshipValue = (p, n) -> {
  57         if (n.getNodeName().equalsIgnoreCase(RELATIONSHIP_KEY)) {
  58             p.setKey(n.getTextContent().trim());
  59         } else {
  60             p.setValue(n.getTextContent().trim());
  61         }
  62     };
  63
  64
  65     /**
  66      * This method is responsible for parsing the payload to produce a list of artifacts.
  67      *
  68      * @param artifactPayload the payload to be parsed
  69      * @param artifactName the name of the artifact to be parsed
  70      * @return List<Artifact> a list of artifacts that have been parsed from the payload.
  71      */
  72     @Override
  73     public List<Artifact> parse(String artifactPayload, String artifactName) {
  74         List<Artifact> modelList = new ArrayList<>();
  75
  76         try {
  77             DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
  78             factory.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
  79             DocumentBuilder builder = factory.newDocumentBuilder();
  80             InputSource is = new InputSource(new StringReader(artifactPayload));
  81             Document doc = builder.parse(is);
  82
  83             IModelArtifact model = parseModel(doc.getDocumentElement(), artifactPayload);
  84
  85             if (!processParsedModel(modelList, artifactName, model)) {
  86                 modelList = null;
  87             }
  88         } catch (Exception ex) {
  89             logger.error(ModelLoaderMsgs.ARTIFACT_PARSE_ERROR,
  90                     buildArtifactParseExceptionMessage(artifactName, ex.getLocalizedMessage()));
  91         }
  92
  93         return modelList;
  94     }
  95
  96     private IModelArtifact parseModel(Node modelNode, String payload) {
  97         IModelArtifact model = createModelArtifactInstance();
  98         model.setPayload(payload);
  99
 100         Element e = (Element) modelNode;
 101         model.setModelNamespace(e.getAttribute("xmlns"));
 102
 103         parseNode(modelNode, model);
 104
 105         return modelIsValid(model) ? model : null;
 106     }
 107
 108     /**
 109      * This method is responsible for creating a new instance of IModel that represents the model id for a concrete
 110      * implementation of IArtifactParser.
 111      *
 112      * @return IModelArtifact implementation of IModel that represents the model id for a concrete implementation of
 113      *         IArtifactParser
 114      */
 115     abstract IModelArtifact createModelArtifactInstance();
 116
 117     /**
 118      * This method is responsible for the actual parsing of a node.
 119      *
 120      * It will do one of three things:
 121      * <ol>
 122      * <li>set the version id if the name of the node is the same as the name of the node that is the version Id</li>
 123      * <li>if the node is contains data about the relationship it will parse the node accordingly</li>
 124      * <li>if it does neither of option 1 or 2 it will parse the children of this node</li>
 125      * </ol>
 126      *
 127      * @param node node to be parsed
 128      * @param model the model artifact to be updated with either the versionId or details of dependent node
 129      */
 130     void parseNode(Node node, IModelArtifact model) {
 131         if (node.getNodeName().equalsIgnoreCase(getVersionIdNodeName())) {
 132             setVersionId(model, node);
 133         } else if (node.getNodeName().equalsIgnoreCase(RELATIONSHIP_DATA)) {
 134             parseRelationshipNode(node, model);
 135         } else {
 136             parseChildNodes(node, model);
 137         }
 138     }
 139
 140     /**
 141      * This method gets the name of the node that acts as the version Id for the node.
 142      *
 143      * @return String name of the node that acts as the version Id for the node
 144      */
 145     abstract String getVersionIdNodeName();
 146
 147     /**
 148      * This method is responsible for setting the values on the model artifact that represent the version Id. Each
 149      * implementation of a IModelArtifact has its own properties that define the version Id.
 150      *
 151      * @param model the model artifact upon which the version Id will be set
 152      * @param node the source of the data that holds the actual value of the version id to be set on the model artifact
 153      */
 154     abstract void setVersionId(IModelArtifact model, Node node);
 155
 156     /**
 157      * @param relationshipNode a node containing child nodes storing relationship data
 158      * @param model artifact whose dependent node id will be update with any relationship data if it exists
 159      */
 160     void parseRelationshipNode(Node relationshipNode, IModelArtifact model) {
 161         NodeList nodeList = getChildNodes(relationshipNode);
 162
 163         IModelId modelId = buildModelId(nodeList);
 164
 165         updateModelsDependentNodeId(model, modelId);
 166     }
 167
 168     private NodeList getChildNodes(Node relationshipNode) {
 169         Objects.requireNonNull(relationshipNode);
 170         NodeList nodeList = relationshipNode.getChildNodes();
 171         Objects.requireNonNull(nodeList);
 172
 173         return nodeList;
 174     }
 175
 176     /**
 177      * This method is responsible for building an instance of IModelId representing the id of the model.
 178      *
 179      * @param nodeList list of modes used to build the model id.
 180      * @return IModelId instance of IModelId representing the id of the model
 181      */
 182     IModelId buildModelId(NodeList nodeList) {
 183         Pair<String, String> relationship = IntStream.range(0, nodeList.getLength()).mapToObj(nodeList::item) //
 184                 .filter(this::filterRelationshipNode)
 185                 .collect(Collector.of(Pair::new, applyRelationshipValue, (p, n) -> p));
 186
 187         IModelId modelId = createModelIdInstance();
 188         modelId.setRelationship(relationship);
 189
 190         return modelId;
 191     }
 192
 193     /**
 194      * This method tests if a node is either one that either represents a relationship key or a relationship value.
 195      *
 196      * @param n the node to to be tested
 197      * @return <code>true</code> if the node is either represents a relationship key or a relationship value
 198      */
 199     boolean filterRelationshipNode(Node n) {
 200         return n.getNodeName().equalsIgnoreCase(RELATIONSHIP_KEY)
 201                 || n.getNodeName().equalsIgnoreCase(RELATIONSHIP_VALUE);
 202     }
 203
 204     /**
 205      * This method is responsible for creating an instance of {@link AbstractModelArtifactParser.ModelId}
 206      *
 207      * @return IModelId instance of {@link AbstractModelArtifactParser.ModelId}
 208      */
 209     IModelId createModelIdInstance() {
 210         return new ModelId();
 211     }
 212
 213     private void updateModelsDependentNodeId(IModelArtifact model, IModelId modelId) {
 214         if (modelId.defined()) {
 215             model.addDependentModelId(modelId.toString());
 216         }
 217     }
 218
 219     /**
 220      * This method is responsible for parsing the children of a given node.
 221      *
 222      * @param node node whose children, if any, should be parsed.
 223      * @param model model to be updated as a result of parsing the node
 224      */
 225     void parseChildNodes(Node node, IModelArtifact model) {
 226         NodeList nodeList = node.getChildNodes();
 227         for (int i = 0; i < nodeList.getLength(); i++) {
 228             Node childNode = nodeList.item(i);
 229             parseNode(childNode, model);
 230         }
 231     }
 232
 233     /**
 234      * Validates if the mode is valid or not by examining specific properties of the model.
 235      *
 236      * @param model model to be validated
 237      * @return <code>true</code> if the mode is valid otherwise <code>false</code>
 238      */
 239     abstract boolean modelIsValid(IModelArtifact model);
 240
 241     /**
 242      * This method is responsible for building a message used for logging artifact parsing errors.
 243      *
 244      * @param artifactName the name of the artifact
 245      * @param localisedMessage the message associated with the exception that is raised by the error
 246      * @return String a message used for logging artifact parsing errors
 247      */
 248     abstract String buildArtifactParseExceptionMessage(String artifactName, String localisedMessage);
 249
 250     /**
 251      * This method is responsible for either adding the model artifact to the list of model artifacts or reporting an
 252      * error.
 253      *
 254      * If the model is not null then it will be added to the list of artifacts otherwise an error will be logged.
 255      *
 256      * @param modelList the list of artifacts to which the model will be added if it is not null
 257      * @param artifactName the name of the artifact
 258      * @param artifactModel the model artifact to be added to the list of model artifacts
 259      * @return <code>true/code> if the model is not null otherwise <code>false</code>
 260      */
 261     abstract boolean processParsedModel(List<Artifact> modelList, String artifactName, IModelArtifact artifactModel);
 262
 263     private class ModelId implements IModelId {
 264         private String modelIdValue;
 265
 266         @Override
 267         public void setRelationship(Pair<String, String> p) {
 268             if (getModelElementRelationshipKey().equals(p.getKey())) {
 269                 modelIdValue = p.getValue();
 270             }
 271         }
 272
 273         @Override
 274         public boolean defined() {
 275             return modelIdValue != null;
 276         }
 277
 278         @Override
 279         public String toString() {
 280             return modelIdValue;
 281         }
 282     }
 283
 284     /**
 285      * This method gets the name of the key of the element relationship for the model.
 286      *
 287      * @return String name of the key of the element relationship for the model
 288      */
 289     abstract String getModelElementRelationshipKey();
 290 }