2 * ============LICENSE_START==========================================
4 * ===================================================================
5 * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
6 * Copyright © 2017-2018 Amdocs
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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============================================
22 package org.onap.aai.modelloader.entity.model;
24 import java.io.StringReader;
25 import java.util.ArrayList;
26 import java.util.List;
27 import java.util.Objects;
28 import java.util.function.BiConsumer;
29 import java.util.stream.Collector;
30 import java.util.stream.IntStream;
31 import javax.xml.parsers.DocumentBuilder;
32 import javax.xml.parsers.DocumentBuilderFactory;
34 import org.onap.aai.cl.api.Logger;
35 import org.onap.aai.cl.eelf.LoggerFactory;
36 import org.onap.aai.modelloader.entity.Artifact;
37 import org.onap.aai.modelloader.service.ModelLoaderMsgs;
39 import org.w3c.dom.Document;
40 import org.w3c.dom.Element;
41 import org.w3c.dom.Node;
42 import org.w3c.dom.NodeList;
43 import org.xml.sax.InputSource;
46 * This class provides common behaviour for implementations of IModelParser.
48 * Some of the common behaviour takes the form of abstract methods that will be implemented in concrete classes.
50 * Some other behaviour will be overridden in concrete classes.
52 public abstract class AbstractModelArtifactParser implements IModelParser {
53 private static Logger logger = LoggerFactory.getInstance().getLogger(AbstractModelArtifactParser.class);
55 protected static final String RELATIONSHIP_DATA = "relationship-data";
56 private static final String RELATIONSHIP_KEY = "relationship-key";
57 private static final String RELATIONSHIP_VALUE = "relationship-value";
59 BiConsumer<Pair<String, String>, Node> applyRelationshipValue = (p, n) -> {
60 if (n.getNodeName().equalsIgnoreCase(RELATIONSHIP_KEY)) {
61 p.setKey(n.getTextContent().trim());
63 p.setValue(n.getTextContent().trim());
69 * This method is responsible for parsing the payload to produce a list of artifacts.
71 * @param artifactPayload the payload to be parsed
72 * @param artifactName the name of the artifact to be parsed
73 * @return List<Artifact> a list of artifacts that have been parsed from the payload.
76 public List<Artifact> parse(String artifactPayload, String artifactName) {
77 List<Artifact> modelList = new ArrayList<>();
80 DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
81 factory.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
82 DocumentBuilder builder = factory.newDocumentBuilder();
83 InputSource is = new InputSource(new StringReader(artifactPayload));
84 Document doc = builder.parse(is);
86 IModelArtifact model = parseModel(doc.getDocumentElement(), artifactPayload);
88 if (!processParsedModel(modelList, artifactName, model)) {
91 } catch (Exception ex) {
92 logger.error(ModelLoaderMsgs.ARTIFACT_PARSE_ERROR,
93 buildArtifactParseExceptionMessage(artifactName, ex.getLocalizedMessage()));
99 private IModelArtifact parseModel(Node modelNode, String payload) {
100 IModelArtifact model = createModelArtifactInstance();
101 model.setPayload(payload);
103 Element e = (Element) modelNode;
104 model.setModelNamespace(e.getAttribute("xmlns"));
106 parseNode(modelNode, model);
108 return modelIsValid(model) ? model : null;
112 * This method is responsible for creating a new instance of IModel that represents the model id for a concrete
113 * implementation of IArtifactParser.
115 * @return IModelArtifact implementation of IModel that represents the model id for a concrete implementation of
118 abstract IModelArtifact createModelArtifactInstance();
121 * This method is responsible for the actual parsing of a node.
123 * It will do one of three things:
125 * <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>
126 * <li>if the node is contains data about the relationship it will parse the node accordingly</li>
127 * <li>if it does neither of option 1 or 2 it will parse the children of this node</li>
130 * @param node node to be parsed
131 * @param model the model artifact to be updated with either the versionId or details of dependent node
133 void parseNode(Node node, IModelArtifact model) {
134 if (node.getNodeName().equalsIgnoreCase(getVersionIdNodeName())) {
135 setVersionId(model, node);
136 } else if (node.getNodeName().equalsIgnoreCase(RELATIONSHIP_DATA)) {
137 parseRelationshipNode(node, model);
139 parseChildNodes(node, model);
144 * This method gets the name of the node that acts as the version Id for the node.
146 * @return String name of the node that acts as the version Id for the node
148 abstract String getVersionIdNodeName();
151 * This method is responsible for setting the values on the model artifact that represent the version Id. Each
152 * implementation of a IModelArtifact has its own properties that define the version Id.
154 * @param model the model artifact upon which the version Id will be set
155 * @param node the source of the data that holds the actual value of the version id to be set on the model artifact
157 abstract void setVersionId(IModelArtifact model, Node node);
160 * @param relationshipNode a node containing child nodes storing relationship data
161 * @param model artifact whose dependent node id will be update with any relationship data if it exists
163 void parseRelationshipNode(Node relationshipNode, IModelArtifact model) {
164 NodeList nodeList = getChildNodes(relationshipNode);
166 IModelId modelId = buildModelId(nodeList);
168 updateModelsDependentNodeId(model, modelId);
171 private NodeList getChildNodes(Node relationshipNode) {
172 Objects.requireNonNull(relationshipNode);
173 NodeList nodeList = relationshipNode.getChildNodes();
174 Objects.requireNonNull(nodeList);
180 * This method is responsible for building an instance of IModelId representing the id of the model.
182 * @param nodeList list of modes used to build the model id.
183 * @return IModelId instance of IModelId representing the id of the model
185 IModelId buildModelId(NodeList nodeList) {
186 Pair<String, String> relationship = IntStream.range(0, nodeList.getLength()).mapToObj(nodeList::item) //
187 .filter(this::filterRelationshipNode)
188 .collect(Collector.of(Pair::new, applyRelationshipValue, (p, n) -> p));
190 IModelId modelId = createModelIdInstance();
191 modelId.setRelationship(relationship);
197 * This method tests if a node is either one that either represents a relationship key or a relationship value.
199 * @param n the node to to be tested
200 * @return <code>true</code> if the node is either represents a relationship key or a relationship value
202 boolean filterRelationshipNode(Node n) {
203 return n.getNodeName().equalsIgnoreCase(RELATIONSHIP_KEY)
204 || n.getNodeName().equalsIgnoreCase(RELATIONSHIP_VALUE);
208 * This method is responsible for creating an instance of {@link AbstractModelArtifactParser.ModelId}
210 * @return IModelId instance of {@link AbstractModelArtifactParser.ModelId}
212 IModelId createModelIdInstance() {
213 return new ModelId();
216 private void updateModelsDependentNodeId(IModelArtifact model, IModelId modelId) {
217 if (modelId.defined()) {
218 model.addDependentModelId(modelId.toString());
223 * This method is responsible for parsing the children of a given node.
225 * @param node node whose children, if any, should be parsed.
226 * @param model model to be updated as a result of parsing the node
228 void parseChildNodes(Node node, IModelArtifact model) {
229 NodeList nodeList = node.getChildNodes();
230 for (int i = 0; i < nodeList.getLength(); i++) {
231 Node childNode = nodeList.item(i);
232 parseNode(childNode, model);
237 * Validates if the mode is valid or not by examining specific properties of the model.
239 * @param model model to be validated
240 * @return <code>true</code> if the mode is valid otherwise <code>false</code>
242 abstract boolean modelIsValid(IModelArtifact model);
245 * This method is responsible for building a message used for logging artifact parsing errors.
247 * @param artifactName the name of the artifact
248 * @param localisedMessage the message associated with the exception that is raised by the error
249 * @return String a message used for logging artifact parsing errors
251 abstract String buildArtifactParseExceptionMessage(String artifactName, String localisedMessage);
254 * This method is responsible for either adding the model artifact to the list of model artifacts or reporting an
257 * If the model is not null then it will be added to the list of artifacts otherwise an error will be logged.
259 * @param modelList the list of artifacts to which the model will be added if it is not null
260 * @param artifactName the name of the artifact
261 * @param artifactModel the model artifact to be added to the list of model artifacts
262 * @return <code>true/code> if the model is not null otherwise <code>false</code>
264 abstract boolean processParsedModel(List<Artifact> modelList, String artifactName, IModelArtifact artifactModel);
266 private class ModelId implements IModelId {
267 private String modelIdValue;
270 public void setRelationship(Pair<String, String> p) {
271 if (getModelElementRelationshipKey().equals(p.getKey())) {
272 modelIdValue = p.getValue();
277 public boolean defined() {
278 return modelIdValue != null;
282 public String toString() {
288 * This method gets the name of the key of the element relationship for the model.
290 * @return String name of the key of the element relationship for the model
292 abstract String getModelElementRelationshipKey();