org.springframework.http.converter.xml

Class SourceHttpMessageConverter<T extends javax.xml.transform.Source>

java.lang.Object

org.springframework.http.converter.AbstractHttpMessageConverter<T>

org.springframework.http.converter.xml.SourceHttpMessageConverter<T>

All Implemented Interfaces:

HttpMessageConverter<T>

public class SourceHttpMessageConverter<T extends javax.xml.transform.Source>
extends AbstractHttpMessageConverter<T>

Implementation of HttpMessageConverter that can read and write Source objects.

Since:

3.0

Author:

Arjen Poutsma, Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	SourceHttpMessageConverter.CountingOutputStream

Field Summary

Fields

Modifier and Type	Field and Description
private static org.xml.sax.EntityResolver	NO_OP_ENTITY_RESOLVER
private static javax.xml.stream.XMLResolver	NO_OP_XML_RESOLVER
private boolean	processExternalEntities
private boolean	supportDtd
private static java.util.Set<java.lang.Class<?>>	SUPPORTED_CLASSES
private javax.xml.transform.TransformerFactory	transformerFactory

Fields inherited from class org.springframework.http.converter.AbstractHttpMessageConverter

logger

Constructor Summary

Constructors

Constructor and Description
SourceHttpMessageConverter() Sets the supportedMediaTypes to text/xml and application/xml, and application/*-xml.

Method Summary

Modifier and Type	Method and Description
protected java.lang.Long	getContentLength(T t, MediaType contentType) Returns the content length for the given type.
boolean	isProcessExternalEntities() Returns the configured value for whether XML external entities are allowed.
boolean	isSupportDtd() Whether DTD parsing is supported.
private javax.xml.transform.dom.DOMSource	readDOMSource(java.io.InputStream body)
protected T	readInternal(java.lang.Class<? extends T> clazz, HttpInputMessage inputMessage) Abstract template method that reads the actual object.
private javax.xml.transform.sax.SAXSource	readSAXSource(java.io.InputStream body)
private javax.xml.transform.Source	readStAXSource(java.io.InputStream body)
private javax.xml.transform.stream.StreamSource	readStreamSource(java.io.InputStream body)
void	setProcessExternalEntities(boolean processExternalEntities) Indicates whether external XML entities are processed when converting to a Source.
void	setSupportDtd(boolean supportDtd) Indicates whether DTD parsing should be supported.
boolean	supports(java.lang.Class<?> clazz) Indicates whether the given class is supported by this converter.
private void	transform(javax.xml.transform.Source source, javax.xml.transform.Result result)
protected void	writeInternal(T t, HttpOutputMessage outputMessage) Abstract template method that writes the actual body.

Methods inherited from class org.springframework.http.converter.AbstractHttpMessageConverter

addDefaultHeaders, canRead, canRead, canWrite, canWrite, getDefaultContentType, getSupportedMediaTypes, read, setSupportedMediaTypes, write

Methods inherited from class java.lang.Object

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

Field Detail

SUPPORTED_CLASSES

private static final java.util.Set<java.lang.Class<?>> SUPPORTED_CLASSES

transformerFactory

private final javax.xml.transform.TransformerFactory transformerFactory

supportDtd

private boolean supportDtd

processExternalEntities

private boolean processExternalEntities

NO_OP_ENTITY_RESOLVER

private static final org.xml.sax.EntityResolver NO_OP_ENTITY_RESOLVER

NO_OP_XML_RESOLVER

private static final javax.xml.stream.XMLResolver NO_OP_XML_RESOLVER

Constructor Detail

SourceHttpMessageConverter

public SourceHttpMessageConverter()

Sets the supportedMediaTypes to text/xml and application/xml, and application/*-xml.

Method Detail

setSupportDtd

public void setSupportDtd(boolean supportDtd)

Indicates whether DTD parsing should be supported.

Default is false meaning that DTD is disabled.

isSupportDtd

public boolean isSupportDtd()

Whether DTD parsing is supported.

setProcessExternalEntities

public void setProcessExternalEntities(boolean processExternalEntities)

Indicates whether external XML entities are processed when converting to a Source.

Default is false, meaning that external entities are not resolved.

Note: setting this option to true also automatically sets setSupportDtd(boolean) to true.

isProcessExternalEntities

public boolean isProcessExternalEntities()

Returns the configured value for whether XML external entities are allowed.

supports

public boolean supports(java.lang.Class<?> clazz)

Description copied from class: AbstractHttpMessageConverter

Indicates whether the given class is supported by this converter.

Specified by:

supports in class AbstractHttpMessageConverter<T extends javax.xml.transform.Source>

Parameters:

clazz - the class to test for support

Returns:

true if supported; false otherwise

readInternal

protected T readInternal(java.lang.Class<? extends T> clazz,
                         HttpInputMessage inputMessage)
                  throws java.io.IOException,
                         HttpMessageNotReadableException

Description copied from class: AbstractHttpMessageConverter

Abstract template method that reads the actual object. Invoked from AbstractHttpMessageConverter.read(java.lang.Class<? extends T>, org.springframework.http.HttpInputMessage).

Specified by:

readInternal in class AbstractHttpMessageConverter<T extends javax.xml.transform.Source>

Parameters:

clazz - the type of object to return

inputMessage - the HTTP input message to read from

Returns:

the converted object

Throws:

java.io.IOException - in case of I/O errors

HttpMessageNotReadableException - in case of conversion errors

readDOMSource

private javax.xml.transform.dom.DOMSource readDOMSource(java.io.InputStream body)
                                                 throws java.io.IOException

Throws:

java.io.IOException

readSAXSource

private javax.xml.transform.sax.SAXSource readSAXSource(java.io.InputStream body)
                                                 throws java.io.IOException

Throws:

java.io.IOException

readStAXSource

private javax.xml.transform.Source readStAXSource(java.io.InputStream body)

readStreamSource

private javax.xml.transform.stream.StreamSource readStreamSource(java.io.InputStream body)
                                                          throws java.io.IOException

Throws:

java.io.IOException

getContentLength

protected java.lang.Long getContentLength(T t,
                                          MediaType contentType)

Description copied from class: AbstractHttpMessageConverter

Returns the content length for the given type.

By default, this returns null, meaning that the content length is unknown. Can be overridden in subclasses.

Overrides:

getContentLength in class AbstractHttpMessageConverter<T extends javax.xml.transform.Source>

Parameters:

t - the type to return the content length for

Returns:

the content length, or null if not known

writeInternal

protected void writeInternal(T t,
                             HttpOutputMessage outputMessage)
                      throws java.io.IOException,
                             HttpMessageNotWritableException

Description copied from class: AbstractHttpMessageConverter

Abstract template method that writes the actual body. Invoked from AbstractHttpMessageConverter.write(T, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage).

Specified by:

writeInternal in class AbstractHttpMessageConverter<T extends javax.xml.transform.Source>

Parameters:

t - the object to write to the output message

outputMessage - the HTTP output message to write to

Throws:

java.io.IOException - in case of I/O errors

HttpMessageNotWritableException - in case of conversion errors

transform

private void transform(javax.xml.transform.Source source,
                       javax.xml.transform.Result result)
                throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException