org.mycore.common.xml.MCRDOMUtils Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mycore-base Show documentation
There is a newer version: 2024.05
/*
 * This file is part of ***  M y C o R e  ***
 * See http://www.mycore.de/ for details.
 *
 * MyCoRe is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MyCoRe is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with MyCoRe.  If not, see .
 */

package org.mycore.common.xml;

import java.util.concurrent.ConcurrentLinkedQueue;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;

import org.mycore.common.MCRException;
import org.mycore.common.events.MCRShutdownHandler;
import org.mycore.common.events.MCRShutdownHandler.Closeable;

/**
 * Helper class to get {@link DocumentBuilder} instances from a common pool
 * @author Thomas Scheffler (yagee)
 */
public class MCRDOMUtils implements Closeable {

    DocumentBuilderFactory docBuilderFactory;

    ConcurrentLinkedQueue builderQueue;

    private MCRDOMUtils() {
        builderQueue = new ConcurrentLinkedQueue<>();
        docBuilderFactory = DocumentBuilderFactory.newDefaultInstance();
        docBuilderFactory.setNamespaceAware(true);
        MCRShutdownHandler.getInstance().addCloseable(this);
    }

    public static DocumentBuilder getDocumentBuilder() throws ParserConfigurationException {
        DocumentBuilder documentBuilder = LazyHolder.INSTANCE.builderQueue.poll();
        return documentBuilder != null ? resetDocumentBuilder(documentBuilder) : createDocumentBuilder();
    }

    public static DocumentBuilder getDocumentBuilderUnchecked() {
        try {
            return getDocumentBuilder();
        } catch (ParserConfigurationException e) {
            throw new MCRException(e);
        }
    }

    public static void releaseDocumentBuilder(DocumentBuilder documentBuilder) {
        LazyHolder.INSTANCE.builderQueue.add(documentBuilder);
    }

    /**
     * @param documentBuilder
     * @return
     */
    private static DocumentBuilder resetDocumentBuilder(DocumentBuilder documentBuilder) {
        documentBuilder.reset();
        documentBuilder.setEntityResolver(MCREntityResolver.instance());
        return documentBuilder;
    }

    private static DocumentBuilder createDocumentBuilder() throws ParserConfigurationException {
        DocumentBuilder documentBuilder = LazyHolder.INSTANCE.docBuilderFactory.newDocumentBuilder();
        return resetDocumentBuilder(documentBuilder);
    }

    @Override
    public void close() {
        while (!builderQueue.isEmpty()) {
            DocumentBuilder documentBuilder = builderQueue.poll();
            documentBuilder.reset();
            documentBuilder.setEntityResolver(null);
        }
    }

    @Override
    public int getPriority() {
        return 0;
    }

    @Override
    public void prepareClose() {
    }

    private static class LazyHolder {
        private static final MCRDOMUtils INSTANCE = new MCRDOMUtils();
    }

}