Package com.puppycrawl.tools.checkstyle

Class XmlLoader.LoadExternalDtdFeatureProvider

java.lang.Object

com.puppycrawl.tools.checkstyle.XmlLoader.LoadExternalDtdFeatureProvider

Enclosing class:

XmlLoader

public static final class XmlLoader.LoadExternalDtdFeatureProvider
extends Object

Used for setting specific for secure java installations features to SAXParserFactory. Pulled out as a separate class in order to suppress Pitest mutations.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENABLE_EXTERNAL_DTD_LOAD	System property name to enable external DTD load.
static final String	EXTERNAL_GENERAL_ENTITIES	Feature that enables including external general entities in XML files.
static final String	EXTERNAL_PARAMETER_ENTITIES	Feature that enables including external parameter entities in XML files.
static final String	LOAD_EXTERNAL_DTD	Feature that enables loading external DTD when loading XML files.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	LoadExternalDtdFeatureProvider()	Stop instances being created.

Method Summary

Modifier and Type	Method	Description
static void	setFeaturesBySystemProperty(SAXParserFactory factory)	Configures SAXParserFactory with features required to use external DTD file loading, this is not activated by default to no allow usage of schema files that checkstyle do not know it is even security problem to allow files from outside.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ENABLE_EXTERNAL_DTD_LOAD

public static final String ENABLE_EXTERNAL_DTD_LOAD

System property name to enable external DTD load.

See Also:

• Constant Field Values

LOAD_EXTERNAL_DTD

public static final String LOAD_EXTERNAL_DTD

Feature that enables loading external DTD when loading XML files.

See Also:

• Constant Field Values

EXTERNAL_GENERAL_ENTITIES

public static final String EXTERNAL_GENERAL_ENTITIES

Feature that enables including external general entities in XML files.

See Also:

• Constant Field Values

EXTERNAL_PARAMETER_ENTITIES

public static final String EXTERNAL_PARAMETER_ENTITIES

Feature that enables including external parameter entities in XML files.

See Also:

• Constant Field Values

Constructor Details

LoadExternalDtdFeatureProvider

private LoadExternalDtdFeatureProvider()

Stop instances being created.

Method Details

setFeaturesBySystemProperty

public static void setFeaturesBySystemProperty(SAXParserFactory factory)
                                        throws SAXException,
ParserConfigurationException

Configures SAXParserFactory with features required to use external DTD file loading, this is not activated by default to no allow usage of schema files that checkstyle do not know it is even security problem to allow files from outside.

Parameters:

factory - factory to be configured with special features

Throws:

SAXException - if an error occurs

ParserConfigurationException - if an error occurs