Class XmlSupport

java.lang.Object

org.jboss.resteasy.util.XmlSupport

public class XmlSupport
extends Object

A utility for creating secure XML serialization and deserialization resources.

Author:

James R. Perkins

Method Summary

Modifier and Type	Method	Description
static void	configureParserFactory(SAXParserFactory factory, ResteasyConfiguration config)	Configures the factory for secure processing.
static TransformerFactory	newTransformerFactory()	Creates a new TransformerFactory and configures it for secure processing.
static TransformerFactory	newTransformerFactory(ResteasyConfiguration config)	Creates a new TransformerFactory and configures it for secure processing.
static XMLReader	newXmlReader()	Creates a new XMLReader from the default SAXParserFactory.
static XMLReader	newXmlReader(ResteasyConfiguration config)	Creates a new XMLReader from the default SAXParserFactory.

Methods inherited from class Object

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

Method Details

configureParserFactory

public static void configureParserFactory(SAXParserFactory factory,
 ResteasyConfiguration config)
                                   throws SAXNotSupportedException,
SAXNotRecognizedException,
ParserConfigurationException

Configures the factory for secure processing. If the configuration is not null, the following properties are looked up to determine which features are enabled/disabled:

• ResteasyContextParameters.RESTEASY_EXPAND_ENTITY_REFERENCES: Determines whether to enable or disable http://xml.org/sax/features/external-general-entities and http://xml.org/sax/features/external-parameter-entities. Defaults to false.
• ResteasyContextParameters.RESTEASY_SECURE_PROCESSING_FEATURE: Determines whether to enable or disable XMLConstants.FEATURE_SECURE_PROCESSING. Defaults to true.
• ResteasyContextParameters.RESTEASY_DISABLE_DTDS: Determines whether to enable or disable http://apache.org/xml/features/disallow-doctype-decl. Defaults to true.

If any of these properties are not supported by the SAXParserFactory implementation, a SAXNotSupportedException will be thrown.

Parameters:

factory - the factory to be configured

config - the configuration to be used to override the default values

Throws:

SAXNotSupportedException - if the property is not supported by the underlying implementation

SAXNotRecognizedException - if the property is not recognized by the underlying implementation

ParserConfigurationException - if there is an error configuring the parser

See Also:

• SAXParserFactory

newXmlReader

public static XMLReader newXmlReader()
                              throws ParserConfigurationException,
SAXException

Creates a new XMLReader from the default SAXParserFactory. The SAXParserFactory is configured via the configureParserFactory(SAXParserFactory, ResteasyConfiguration).

The configuration is looked up in the current context.

Returns:

a new XMLReader

Throws:

ParserConfigurationException - if the configuration for the SAXParserFactory fails

SAXException - if there is a general failure creating the reader

See Also:

• configureParserFactory(SAXParserFactory, ResteasyConfiguration)

newXmlReader

public static XMLReader newXmlReader(ResteasyConfiguration config)
                              throws ParserConfigurationException,
SAXException

Creates a new XMLReader from the default SAXParserFactory. The SAXParserFactory is configured via the configureParserFactory(SAXParserFactory, ResteasyConfiguration).

Parameters:

config - the optional configuration to use

Returns:

a new XMLReader

Throws:

ParserConfigurationException - if the configuration for the SAXParserFactory fails

SAXException - if there is a general failure creating the reader

See Also:

• configureParserFactory(SAXParserFactory, ResteasyConfiguration)

newTransformerFactory

public static TransformerFactory newTransformerFactory()
                                                throws TransformerConfigurationException

Creates a new TransformerFactory and configures it for secure processing.

The configuration is looked up in the current context.

Returns:

a newly configured transformer factory

Throws:

TransformerConfigurationException - if an error occurs configuring the transformer factory

newTransformerFactory

public static TransformerFactory newTransformerFactory(ResteasyConfiguration config)
                                                throws TransformerConfigurationException

Creates a new TransformerFactory and configures it for secure processing.

The ResteasyContextParameters.RESTEASY_SECURE_PROCESSING_FEATURE: Determines whether to enable or disable XMLConstants.FEATURE_SECURE_PROCESSING. Defaults to true.

This also attempts to set two attributes which are not configurable:

• XMLConstants.ACCESS_EXTERNAL_DTD
• XMLConstants.ACCESS_EXTERNAL_STYLESHEET

Both attributes are set to empty string values if they are supported by the underlying implementation. If they are not supported, a warning will be logged once indicating the attribute is not supported.

Parameters:

config - the optional configuration to check for the ResteasyContextParameters.RESTEASY_SECURE_PROCESSING_FEATURE

Returns:

a newly configured transformer factory

Throws:

TransformerConfigurationException - if an error occurs configuring the transformer factory