hu.icellmobilsoft.coffee.rest.validation.xml.utils.IXsdHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of coffee-rest Show documentation
There is a newer version: 2.9.0
/*-
 * #%L
 * Coffee
 * %%
 * Copyright (C) 2020 i-Cell Mobilsoft Zrt.
 * %%
 * 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.
 * #L%
 */
package hu.icellmobilsoft.coffee.rest.validation.xml.utils;

import javax.xml.validation.Schema;

import jakarta.xml.bind.JAXBContext;
import jakarta.xml.bind.JAXBException;

import org.w3c.dom.ls.LSResourceResolver;
import org.xml.sax.SAXException;

import hu.icellmobilsoft.coffee.se.api.exception.BaseException;

/**
 * XSD helper methods.
 *
 * @see XsdHelper
 * @author ferenc.lutischan
 * @since 1.0.0
 */
public interface IXsdHelper {
    /**
     * Returns {@link JAXBContext} for given class.
     *
     * @param forClass
     *            class of desired {@code JAXBContext}
     * @return {@code JAXBContext}
     * @throws JAXBException
     *             if JAXB exception occurs
     * @throws BaseException
     *             if XSD processing exception occurs
     */
    JAXBContext getJAXBContext(Class forClass) throws JAXBException, BaseException;

    /**
     * Returns {@link JAXBContext} for given class.
     *
     * @param forClasses
     *            classes of desired {@code JAXBContext}
     * @return {@code JAXBContext}
     * @throws JAXBException
     *             if JAXB exception occurs
     * @throws BaseException
     *             if XSD processing exception occurs
     */
    JAXBContext getJAXBContext(Class ...forClasses) throws JAXBException, BaseException;

    /**
     * Returns {@link Schema} for given XSD.
     *
     * @param xsd
     *            path to XSD
     * @param lsResourceResolver
     *            resolver
     * @return {@code Schema}
     * @throws BaseException
     *             if XSD processing exception occurs
     * @throws SAXException
     *             if SAX exception occurs
     */
    Schema getSchema(String xsd, LSResourceResolver lsResourceResolver) throws BaseException, SAXException;
}