com.foursoft.harness.kbl.v24.KblReader 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;

import com.foursoft.jaxb.navext.runtime.io.read.XMLReader;
import com.foursoft.jaxb.navext.runtime.model.Identifiable;

import javax.xml.bind.ValidationEvent;
import java.util.function.Consumer;

/**
 * a default implementation for a KBL reader. Validation events are logged to slf4j.
 * 
 * In the past, this reader had a thread local singleton functionality in order to reuse
 * the reader for repeated reads. This caused memory leaks in environments with thread
 * pools (e.g. servlet container) as the JVM default {@link javax.xml.bind.Unmarshaller}
 * implementation does not clean up internal states properly after unmarshalling is finished.
 * Therefore the functionality has been dropped.
 *
 * 
 * The performance overhead of creating a new reader for each read is about 10% - 15% for
 * repeated reads. The overhead is independent from the size of unmarshalled file. If this is an
 * issue, you can manage your own singleton reader (it is not thread-safe, but can be reused).
 *
 */
public final class KblReader extends XMLReader {


    /**
     * Creates a new KBL reader.
     */
    public KblReader() {
        super(KBLContainer.class, Identifiable.class, Identifiable::getXmlId);
    }

    /**
     * Creates a new KBL reader.
     *
     * @param validationEventConsumer a consumer for validation events
     */
    public KblReader(final Consumer validationEventConsumer) {
        super(KBLContainer.class, Identifiable.class, Identifiable::getXmlId, validationEventConsumer);
    }

}