2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END=========================================================
20 package org.onap.aai.schemaservice.nodeschema.validation;
22 import com.google.common.collect.ArrayListMultimap;
23 import com.google.common.collect.Multimap;
24 import org.onap.aai.schemaservice.nodeschema.SchemaVersion;
25 import org.w3c.dom.Document;
26 import org.w3c.dom.NodeList;
27 import org.xml.sax.SAXException;
29 import javax.xml.XMLConstants;
30 import javax.xml.parsers.DocumentBuilder;
31 import javax.xml.parsers.DocumentBuilderFactory;
32 import javax.xml.parsers.ParserConfigurationException;
33 import java.io.FileInputStream;
34 import java.io.IOException;
35 import java.io.InputStream;
36 import java.util.Collection;
37 import java.util.List;
40 * Default duplicate rules for A&AI -
41 * node types may never have a duplicate definition
42 * within the same Version's file set.
44 * Finds all duplicates and what files they're in.
47 public class DefaultDuplicateNodeDefinitionValidationModule implements DuplicateNodeDefinitionValidationModule {
50 * @see org.onap.aai.nodes.validation.DuplicateNodeDefinitionValidationModule#findDuplicates(java.util.List)
53 public String findDuplicates(List<String> files, SchemaVersion v) {
55 final DocumentBuilderFactory docFactory = DocumentBuilderFactory.newInstance();
56 docFactory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true);
57 docFactory.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
58 docFactory.setFeature("http://xml.org/sax/features/external-general-entities", false);
59 docFactory.setFeature("http://xml.org/sax/features/external-parameter-entities", false);
60 docFactory.setAttribute(XMLConstants.ACCESS_EXTERNAL_DTD, "");
61 docFactory.setAttribute(XMLConstants.ACCESS_EXTERNAL_SCHEMA, "");
62 final DocumentBuilder docBuilder = docFactory.newDocumentBuilder();
64 Multimap<String, String> types = ArrayListMultimap.create();
65 boolean foundDups = false;
66 for (String file : files) {
67 InputStream inputStream = new FileInputStream(file);
68 final Document doc = docBuilder.parse(inputStream);
69 final NodeList list = doc.getElementsByTagName("java-type");
71 for (int i = 0; i < list.getLength(); i++) {
72 String type = list.item(i).getAttributes().getNamedItem("name").getNodeValue();
73 if (types.containsKey(type)) {
76 types.put(type, file);
81 return buildErrorMsg(types, v);
85 } catch (ParserConfigurationException | SAXException | IOException e) {
86 // TODO something useful with this information
87 return e.getMessage();
91 private String buildErrorMsg(Multimap<String, String> types, SchemaVersion v) {
92 StringBuilder errorMsg = new StringBuilder().append("Duplicates found in version ").append(v.toString()).append(". ");
93 for (String nodeType : types.keySet()) {
94 Collection<String> files = types.get(nodeType);
95 if (files.size() == 1) {
96 continue; //only record the duplicated ones
98 errorMsg.append(nodeType).append(" has definitions in ");
99 for (String file : files) {
100 errorMsg.append(file).append(" ");
103 return errorMsg.toString();