Class JacksonXmlHttpMessageConverter

java.lang.Object

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

org.springframework.http.converter.AbstractSmartHttpMessageConverter<Object>

org.springframework.http.converter.AbstractJacksonHttpMessageConverter<tools.jackson.dataformat.xml.XmlMapper>

org.springframework.http.converter.xml.JacksonXmlHttpMessageConverter

All Implemented Interfaces:

HttpMessageConverter<Object>, SmartHttpMessageConverter<Object>

public class JacksonXmlHttpMessageConverter
extends AbstractJacksonHttpMessageConverter<tools.jackson.dataformat.xml.XmlMapper>

Implementation of HttpMessageConverter that can read and write XML using Jackson 3.x extension component for reading and writing XML encoded data.

By default, this converter supports application/xml, text/xml, and application/*+xml with UTF-8 character set. This can be overridden by setting the supportedMediaTypes property.

The default constructor loads JacksonModules found by MapperBuilder.findModules(ClassLoader).

The following hint entries are supported:

• A JSON view with a com.fasterxml.jackson.annotation.JsonView key and the class name of the JSON view as value.
• A filter provider with a tools.jackson.databind.ser.FilterProvider key and the filter provider class name as value.

Since:

7.0

Author:

Sebastien Deleuze

Field Summary

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

defaultMapper

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

logger

Constructor Summary

Constructors

Constructor	Description
JacksonXmlHttpMessageConverter()	Construct a new instance with an XmlMapper created from defensiveXmlFactory() and customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader) and ProblemDetailJacksonXmlMixin.
JacksonXmlHttpMessageConverter(tools.jackson.dataformat.xml.XmlMapper xmlMapper)	Construct a new instance with the provided XmlMapper.
JacksonXmlHttpMessageConverter(tools.jackson.dataformat.xml.XmlMapper.Builder builder)	Construct a new instance with the provided builder customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader) and ProblemDetailJacksonXmlMixin.

Method Summary

Modifier and Type	Method	Description
static tools.jackson.dataformat.xml.XmlFactory	defensiveXmlFactory()	Return an XmlFactory created from StaxUtils.createDefensiveInputFactory() with Spring's defensive setup, i.e.
protected List<MediaType>	getMediaTypesForProblemDetail()	Return the supported media type(s) for ProblemDetail.

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

canRead, canWrite, customizeReader, customizeWriter, getCharset, getJavaType, getJsonEncoding, getMapper, getMappersForType, getSupportedMediaTypes, read, readInternal, registerMappersForType, setSupportedMediaTypes, supportsRepeatableWrites, writeInternal, writePrefix, writeSuffix

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

canWrite, supports, write, writeInternal

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.http.converter.HttpMessageConverter

getSupportedMediaTypes

Methods inherited from interface org.springframework.http.converter.SmartHttpMessageConverter

canRead, read, write

Constructor Details

JacksonXmlHttpMessageConverter

public JacksonXmlHttpMessageConverter()

Construct a new instance with an XmlMapper created from defensiveXmlFactory() and customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader) and ProblemDetailJacksonXmlMixin.

JacksonXmlHttpMessageConverter

public JacksonXmlHttpMessageConverter(tools.jackson.dataformat.xml.XmlMapper.Builder builder)

Construct a new instance with the provided builder customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader) and ProblemDetailJacksonXmlMixin.

JacksonXmlHttpMessageConverter

public JacksonXmlHttpMessageConverter(tools.jackson.dataformat.xml.XmlMapper xmlMapper)

Construct a new instance with the provided XmlMapper.

See Also:

• XmlMapper.builder()
• MapperBuilder.findModules(ClassLoader)

Method Details

defensiveXmlFactory

public static tools.jackson.dataformat.xml.XmlFactory defensiveXmlFactory()

Return an XmlFactory created from StaxUtils.createDefensiveInputFactory() with Spring's defensive setup, i.e. no support for the resolution of DTDs and external entities.

getMediaTypesForProblemDetail

protected List<MediaType> getMediaTypesForProblemDetail()

Description copied from class: AbstractJacksonHttpMessageConverter

Return the supported media type(s) for ProblemDetail. By default, an empty list, unless overridden in subclasses.

Overrides:

getMediaTypesForProblemDetail in class AbstractJacksonHttpMessageConverter<tools.jackson.dataformat.xml.XmlMapper>