mso-api-handlers/mso-api-handler-common/src/main/java/org/onap/so/apihandler/common/XMLValidator.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - SO
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Modifications Copyright (c) 2019 Samsung
   8  * ================================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.so.apihandler.common;
  24
  25
  26 import java.io.FileInputStream;
  27 import java.io.IOException;
  28 import javax.xml.XMLConstants;
  29 import javax.xml.transform.Source;
  30 import javax.xml.transform.stream.StreamSource;
  31 import javax.xml.validation.Schema;
  32 import javax.xml.validation.SchemaFactory;
  33 import javax.xml.validation.Validator;
  34 import org.apache.commons.io.IOUtils;
  35 import org.onap.so.logger.ErrorCode;
  36 import org.onap.so.logger.MessageEnum;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39 import org.xml.sax.SAXException;
  40
  41 public class XMLValidator {
  42
  43     private static String XSDS_PATH;
  44
  45     static {
  46         String prefixMsoPropertiesPath = System.getProperty("mso.config.path");
  47         if (prefixMsoPropertiesPath == null) {
  48             prefixMsoPropertiesPath = "";
  49         }
  50         XSDS_PATH = prefixMsoPropertiesPath + "xsds/";
  51     }
  52
  53     private String stringXsd;
  54     private String errorMsg = null;
  55     private SchemaFactory factory;
  56     private Schema schema;
  57
  58     private static Logger logger = LoggerFactory.getLogger(XMLValidator.class);
  59
  60
  61     public XMLValidator(String xsdFile) {
  62
  63         try (FileInputStream xsdStream = new FileInputStream(XSDS_PATH + xsdFile)) {
  64
  65             stringXsd = IOUtils.toString(xsdStream);
  66
  67             factory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
  68             factory.setResourceResolver(new PathResourceResolver(XSDS_PATH));
  69             factory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true);
  70
  71             String quotedXsd = stringXsd.replaceAll("&#34;", "\"");
  72             Source src = new StreamSource(new java.io.StringReader(quotedXsd));
  73             schema = factory.newSchema(src);
  74
  75         } catch (IOException | SAXException e) {
  76
  77             logger.debug("Cannot open file {}", XSDS_PATH + xsdFile, e);
  78             errorMsg = "ErrorDetails: xsd file " + xsdFile + "could not be opened - " + e.getMessage();
  79         }
  80     }
  81
  82     // Returns null when XML valid, otherwise returns error details.
  83     public String isXmlValid(String stringXml) {
  84         try {
  85             if (errorMsg != null && !errorMsg.isEmpty()) {
  86                 return errorMsg;
  87             }
  88             Source src2 = new StreamSource(new java.io.StringReader(stringXml));
  89             Validator validator = schema.newValidator();
  90             validator.validate(src2);
  91
  92         } catch (IOException | SAXException e) {
  93             logger.debug("Exception: ", e);
  94             return "ErrorDetails: " + e.getMessage();
  95
  96         } catch (Exception e) {
  97             logger.error("{} {} {}", MessageEnum.APIH_CANNOT_READ_SCHEMA.toString(), ErrorCode.SchemaError.getValue(),
  98                     "APIH cannot read schema file", e);
  99
 100             return "ErrorDetails: " + "Unable to read the schema file";
 101         }
 102
 103         return null;
 104     }
 105 }