aboutsummaryrefslogtreecommitdiffstats
path: root/mso-api-handlers/mso-api-handler-common/src/main/java/org/onap/so/apihandler/common/XMLValidator.java
blob: 2b08d1130f6f7ae17fcda2d3e2aa8220f9b8c04b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
/*-
 * ============LICENSE_START=======================================================
 * ONAP - SO
 * ================================================================================
 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Modifications Copyright (c) 2019 Samsung
 * ================================================================================
 * 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.onap.so.apihandler.common;


import java.io.FileInputStream;
import java.io.IOException;
import javax.xml.XMLConstants;
import javax.xml.transform.Source;
import javax.xml.transform.stream.StreamSource;
import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;
import javax.xml.validation.Validator;
import org.apache.commons.io.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.xml.sax.SAXException;

public class XMLValidator {

    private static String XSDS_PATH;

    static {
        String prefixMsoPropertiesPath = System.getProperty("mso.config.path");
        if (prefixMsoPropertiesPath == null) {
            prefixMsoPropertiesPath = "";
        }
        XSDS_PATH = prefixMsoPropertiesPath + "xsds/";
    }

    private String stringXsd;
    private String errorMsg = null;
    private SchemaFactory factory;
    private Schema schema;

    private static Logger logger = LoggerFactory.getLogger(XMLValidator.class);


    public XMLValidator(String xsdFile) {

        try (FileInputStream xsdStream = new FileInputStream(XSDS_PATH + xsdFile)) {

            stringXsd = IOUtils.toString(xsdStream);

            factory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
            factory.setResourceResolver(new PathResourceResolver(XSDS_PATH));
            factory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true);

            String quotedXsd = stringXsd.replaceAll(""", "\"");
            Source src = new StreamSource(new java.io.StringReader(quotedXsd));
            schema = factory.newSchema(src);

        } catch (IOException | SAXException e) {

            logger.debug("Cannot open file {}", XSDS_PATH + xsdFile, e);
            errorMsg = "ErrorDetails: xsd file " + xsdFile + "could not be opened - " + e.getMessage();
        }
    }

    // Returns null when XML valid, otherwise returns error details.
    public String isXmlValid(String stringXml) {
        try {
            if (errorMsg != null && !errorMsg.isEmpty()) {
                return errorMsg;
            }
            Source src2 = new StreamSource(new java.io.StringReader(stringXml));
            Validator validator = schema.newValidator();
            validator.validate(src2);

        } catch (IOException | SAXException e) {
            logger.debug("Exception: ", e);
            return "ErrorDetails: " + e.getMessage();

        } catch (Exception e) {
            logger.error("APIH cannot read schema file", e);

            return "ErrorDetails: " + "Unable to read the schema file";
        }

        return null;
    }
}