JDOMParser.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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
 *
 *     https://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.
 */

package org.apache.commons.jxpath.xml;

import java.io.InputStream;

import javax.xml.parsers.SAXParserFactory;

import org.apache.commons.jxpath.JXPathException;
import org.apache.commons.xml.secure.SecureSAXParserFactory;
import org.jdom.JDOMException;
import org.jdom.input.SAXBuilder;
import org.xml.sax.XMLReader;

/**
 * An implementation of the XMLParser interface that produces a JDOM Document.
 */
public class JDOMParser extends XMLParser2 {

    /**
     * Constructs a new instance.
     */
    public JDOMParser() {
        // empty
    }

    @Override
    public Object parseXML(final InputStream stream) {
        if (!isNamespaceAware()) {
            throw new JXPathException("JDOM parser configuration error. JDOM does not support the namespaceAware=false setting.");
        }
        try {
            // JDOM builds its reader through JAXP internally; hand it one from the secure factory instead.
            final SAXBuilder builder = new SAXBuilder() {
                @Override
                protected XMLReader createParser() throws JDOMException {
                    try {
                        final SAXParserFactory factory = SecureSAXParserFactory.newNSInstance();
                        factory.setValidating(isValidating());
                        return factory.newSAXParser().getXMLReader();
                    } catch (final Exception ex) {
                        throw new JDOMException("Unable to create a new XML reader", ex);
                    }
                }
            };
            builder.setExpandEntities(isExpandEntityReferences());
            builder.setIgnoringElementContentWhitespace(isIgnoringElementContentWhitespace());
            builder.setValidation(isValidating());
            return builder.build(stream);
        } catch (final Exception ex) {
            throw new JXPathException("JDOM parser error", ex);
        }
    }
}