com.foursoft.harness.kbl.v24.validation.KblValidation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kbl-v24 Show documentation
The model for KBL version 2.4.
There is a newer version: 5.2.0
/*-
 * ========================LICENSE_START=================================
 * kbl-v24
 * %%
 * Copyright (C) 2020 - 2022 4Soft GmbH
 * %%
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 * =========================LICENSE_END==================================
 */
package com.foursoft.harness.kbl.v24.validation;

import com.foursoft.harness.kbl.v24.exception.KblException;
import com.foursoft.jaxb.navext.runtime.io.validation.LogErrors;
import com.foursoft.jaxb.navext.runtime.io.validation.LogValidator;
import com.foursoft.jaxb.navext.runtime.io.validation.XMLValidation;

import javax.xml.validation.Schema;
import java.nio.charset.StandardCharsets;
import java.util.Collection;
import java.util.Objects;
import java.util.function.Consumer;

/**
 * Validate KBL data.
 */

public class KblValidation {

    private static final Schema schema = SchemaFactory.getSchema();

    private KblValidation() {
        // hide constructor
    }

    /**
     * validates a xml string against the kbl schema
     *
     * @param xmlContent  the xml content
     * @param consumer    to display scheme violations.
     * @param detailedLog if true and error happens a detailed log is written, use always true in tests !
     */
    public static void validateXML(final String xmlContent, final Consumer consumer, final boolean detailedLog) {
        Objects.requireNonNull(xmlContent);
        final XMLValidation xmlValidation = new XMLValidation(schema);
        final Collection errorLocations = xmlValidation.validateXML(xmlContent,
                StandardCharsets.UTF_8);
        if (detailedLog && !errorLocations.isEmpty()) {
            // TODO use  https://github.com/4Soft-de/jaxb-enhanced-navigation/pull/7 scoped!
            final String annotateXMLContent = LogErrors.annotateXMLContent(xmlContent, errorLocations);
            if (!annotateXMLContent.isEmpty()) {
                consumer.accept(annotateXMLContent);
            }
        }
        if (!errorLocations.isEmpty()) {
            throw new KblException("Schema validation failed! Use detailedLog for more information");
        }
    }

}