org.openrdf.rio.helpers.XMLParserSettings Maven / Gradle / Ivy

Go to download
/* 
 * Licensed to Aduna under one or more contributor license agreements.  
 * See the NOTICE.txt file distributed with this work for additional 
 * information regarding copyright ownership. 
 *
 * Aduna licenses this file to you under the terms of the Aduna BSD 
 * License (the "License"); you may not use this file except in compliance 
 * with the License. See the LICENSE.txt file distributed with this work 
 * for the full License.
 *
 * 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.openrdf.rio.helpers;

import javax.xml.XMLConstants;

import org.xml.sax.XMLReader;

import org.openrdf.rio.RioConfig;
import org.openrdf.rio.RioSetting;

/**
 * ParserSettings for the XML parser features.
 * 
 * @author Michael Grove
 * @author Peter Ansell
 * @see XMLConstants
 * @see Apache XML
 *      Project - Features
 * @since 2.7.0
 */
public final class XMLParserSettings {

	/**
	 * Parser setting for the secure processing feature of XML parsers to avoid
	 * DOS attacks
	 * 
	 * Defaults to true
	 * 
	 * @see 
	 *      XMLConstants.FEATURE_SECURE_PROCESSING
	 * @since 2.7.0
	 */
	public static final RioSetting SECURE_PROCESSING = new RioSettingImpl(
			XMLConstants.FEATURE_SECURE_PROCESSING, "Secure processing feature of XMLConstants", true);

	/**
	 * Parser setting specifying whether external DTDs should be loaded.
	 * 

	 * Defaults to true.
	 * 
	 * @see Apache XML
	 *      Project - Features
	 * @since 2.7.0
	 */
	public static final RioSetting LOAD_EXTERNAL_DTD = new RioSettingImpl(
			"http://apache.org/xml/features/nonvalidating/load-external-dtd", "Load External DTD", true);

	/**
	 * Parser setting to customise the XMLReader that is used by an XML based Rio
	 * parser.
	 * 

	 * IMPORTANT: The XMLReader must not be shared across different readers, so
	 * this setting must be reset for each parse operation.
	 * 

	 * Defaults to null, This settings is only useful if
	 * {@link RioConfig#isSet(RioSetting)} returns true.
	 * 
	 * @since 2.7.0
	 */
	public static final RioSetting CUSTOM_XML_READER = new RioSettingImpl(
			"org.openrdf.rio.xmlreader", "Custom XML Reader", null);

	/**
	 * Parser setting to determine whether to ignore non-fatal errors that come
	 * from SAX parsers.
	 * 

	 * Defaults to true
	 * 
	 * @since 2.7.0
	 */
	public static final RioSetting FAIL_ON_SAX_NON_FATAL_ERRORS = new RioSettingImpl(
			"org.openrdf.rio.failonsaxnonfatalerrors", "Fail on SAX non-fatal errors", true);

	/**
	 * Parser setting to determine whether to ignore non-standard attributes that
	 * are found in an XML document.
	 * 

	 * Defaults to true
	 * 
	 * @since 2.7.0
	 */
	public static final RioSetting FAIL_ON_NON_STANDARD_ATTRIBUTES = new RioSettingImpl(
			"org.openrdf.rio.failonnonstandardattributes", "Fail on non-standard attributes", true);

	/**
	 * Parser setting to determine whether to ignore XML documents containing
	 * invalid NCNAMEs.
	 * 

	 * Defaults to true
	 * 
	 * @since 2.7.0
	 */
	public static final RioSetting FAIL_ON_INVALID_NCNAME = new RioSettingImpl(
			"org.openrdf.rio.failoninvalidncname", "Fail on invalid NCName", true);

	/**
	 * Parser setting to determine whether to throw an error for duplicate uses
	 * of rdf:ID in a single document.
	 * 

	 * Defaults to true
	 * 
	 * @since 2.7.0
	 */
	public static final RioSetting FAIL_ON_DUPLICATE_RDF_ID = new RioSettingImpl(
			"org.openrdf.rio.failonduplicaterdfid", "Fail on duplicate RDF ID", true);

	/**
	 * Parser setting to determine whether to ignore XML documents containing
	 * invalid QNAMEs.
	 * 

	 * Defaults to true
	 * 
	 * @since 2.7.0
	 */
	public static final RioSetting FAIL_ON_INVALID_QNAME = new RioSettingImpl(
			"org.openrdf.rio.failoninvalidqname", "Fail on invalid QName", true);

	/**
	 * Parser setting to determine whether to throw an error for XML documents
	 * containing mismatched tags
	 * 

	 * Defaults to true
	 * 
	 * @since 2.7.1
	 */
	public static final RioSetting FAIL_ON_MISMATCHED_TAGS = new RioSettingImpl(
			"org.openrdf.rio.failonmismatchedtags", "Fail on mismatched tags", true);

	/**
	 * Flag indicating whether the parser parses stand-alone RDF documents. In
	 * stand-alone documents, the rdf:RDF element is optional if it contains just
	 * one element.
	 * 
	 * Defaults to true
	 * 
	 * @since 2.7.8
	 */
	public static final RioSetting PARSE_STANDALONE_DOCUMENTS = new RioSettingImpl(
			"org.openrdf.rio.parsestandalonedocuments", "Parse standalone documents", true);

	/**
	 * Private constructor
	 */
	private XMLParserSettings() {
	}

}