org.springframework.http.converter.xml

Class AbstractXmlHttpMessageConverter<T>

java.lang.Object

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

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

All Implemented Interfaces:

HttpMessageConverter<T>

Direct Known Subclasses:

AbstractJaxb2HttpMessageConverter, MarshallingHttpMessageConverter

public abstract class AbstractXmlHttpMessageConverter<T>
extends AbstractHttpMessageConverter<T>

Abstract base class for HttpMessageConverters that convert from/to XML.

By default, subclasses of this converter support text/xml, application/xml, and application/*-xml. This can be overridden by setting the supportedMediaTypes property.

Since:

3.0

Author:

Arjen Poutsma

Field Summary

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

logger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractXmlHttpMessageConverter() Protected constructor that sets the supportedMediaTypes to text/xml and application/xml, and application/*-xml.

Method Summary

Modifier and Type	Method and Description
protected abstract T	readFromSource(java.lang.Class<? extends T> clazz, HttpHeaders headers, javax.xml.transform.Source source) Abstract template method called from AbstractHttpMessageConverter.read(Class, HttpInputMessage).
T	readInternal(java.lang.Class<? extends T> clazz, HttpInputMessage inputMessage) Abstract template method that reads the actual object.
protected void	transform(javax.xml.transform.Source source, javax.xml.transform.Result result) Transforms the given Source to the Result.
protected void	writeInternal(T t, HttpOutputMessage outputMessage) Abstract template method that writes the actual body.
protected abstract void	writeToResult(T t, HttpHeaders headers, javax.xml.transform.Result result) Abstract template method called from writeInternal(Object, HttpOutputMessage).

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

addDefaultHeaders, canRead, canRead, canWrite, canWrite, getContentLength, getDefaultCharset, getDefaultContentType, getSupportedMediaTypes, read, setDefaultCharset, setSupportedMediaTypes, supports, write

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractXmlHttpMessageConverter

protected AbstractXmlHttpMessageConverter()

Protected constructor that sets the supportedMediaTypes to text/xml and application/xml, and application/*-xml.

Method Detail

readInternal

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

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>

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

writeInternal

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

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>

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

transform

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

Transforms the given Source to the Result.

Parameters:

source - the source to transform from

result - the result to transform to

Throws:

javax.xml.transform.TransformerException - in case of transformation errors

readFromSource

protected abstract T readFromSource(java.lang.Class<? extends T> clazz,
                                    HttpHeaders headers,
                                    javax.xml.transform.Source source)
                             throws java.io.IOException

Abstract template method called from AbstractHttpMessageConverter.read(Class, HttpInputMessage).

Parameters:

clazz - the type of object to return

headers - the HTTP input headers

source - the HTTP input body

Returns:

the converted object

Throws:

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

HttpMessageConversionException - in case of conversion errors

writeToResult

protected abstract void writeToResult(T t,
                                      HttpHeaders headers,
                                      javax.xml.transform.Result result)
                               throws java.io.IOException

Abstract template method called from writeInternal(Object, HttpOutputMessage).

Parameters:

t - the object to write to the output message

headers - the HTTP output headers

result - the HTTP output body

Throws:

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

HttpMessageConversionException - in case of conversion errors