Spring Framework 6.1.4 · org.springframework.http.converter.xml.MappingJackson2XmlHttpMessageConverter

Implementation of HttpMessageConverter that can read and write XML using Jackson 2.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 uses the default configuration provided by Jackson2ObjectMapperBuilder.

Field Summary

Modifier and Type	Field and Description
private static final List<MediaType>	problemDetailMediaTypes

Inherited from org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter:: defaultObjectMapper

Constructor Summary

Access	Constructor and Description
public	MappingJackson2XmlHttpMessageConverter() Construct a new `MappingJackson2XmlHttpMessageConverter` using default configuration provided by `Jackson2ObjectMapperBuilder`.
public	MappingJackson2XmlHttpMessageConverter(ObjectMapper objectMapper) Construct a new `MappingJackson2XmlHttpMessageConverter` with a custom `ObjectMapper` (must be a `XmlMapper` instance).

Method Summary

Modifier and Type	Method and Description
protected List<MediaType>	getMediaTypesForProblemDetail() Overrides org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter.getMediaTypesForProblemDetail. Return the supported media type(s) for `ProblemDetail`.
public void	setObjectMapper(ObjectMapper objectMapper) Overrides org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter.setObjectMapper. Configure the main `ObjectMapper` to use for Object conversion.

Field Detail

problemDetailMediaTypes	back to summary
private static final List<MediaType> problemDetailMediaTypes

Constructor Detail

MappingJackson2XmlHttpMessageConverter	back to summary
public MappingJackson2XmlHttpMessageConverter() Construct a new `MappingJackson2XmlHttpMessageConverter` using default configuration provided by `Jackson2ObjectMapperBuilder`.

MappingJackson2XmlHttpMessageConverter back to summary

MappingJackson2XmlHttpMessageConverter	back to summary
public MappingJackson2XmlHttpMessageConverter(ObjectMapper objectMapper) Construct a new `MappingJackson2XmlHttpMessageConverter` with a custom `ObjectMapper` (must be a `XmlMapper` instance). You can use `Jackson2ObjectMapperBuilder` to build it easily. See Also `Jackson2ObjectMapperBuilder#xml()`

public MappingJackson2XmlHttpMessageConverter(ObjectMapper objectMapper)

Construct a new MappingJackson2XmlHttpMessageConverter with a custom ObjectMapper (must be a XmlMapper instance). You can use Jackson2ObjectMapperBuilder to build it easily.

See Also: Jackson2ObjectMapperBuilder#xml()

Method Detail

getMediaTypesForProblemDetail back to summary

getMediaTypesForProblemDetail	back to summary
protected List<MediaType> getMediaTypesForProblemDetail() Overrides org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter.getMediaTypesForProblemDetail. Doc from org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter.getMediaTypesForProblemDetail. Return the supported media type(s) for `ProblemDetail`. By default, an empty list, unless overridden in subclasses. Annotations @Override

protected List<MediaType> getMediaTypesForProblemDetail()

Overrides org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter.getMediaTypesForProblemDetail.

Doc from org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter.getMediaTypesForProblemDetail.

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

Annotations

@Override

setObjectMapper back to summary

setObjectMapper	back to summary
public void setObjectMapper(ObjectMapper objectMapper) Overrides org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter.setObjectMapper. Doc from org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter.setObjectMapper. Configure the main `ObjectMapper` to use for Object conversion. If not set, a default `ObjectMapper` instance is created. Setting a custom-configured `ObjectMapper` is one way to take further control of the JSON serialization process. For example, an extended `com.fasterxml.jackson.databind.ser.SerializerFactory` can be configured that provides custom serializers for specific types. Another option for refining the serialization process is to use Jackson's provided annotations on the types to be serialized, in which case a custom-configured ObjectMapper is unnecessary. The `ObjectMapper` parameter must be a `XmlMapper` instance. Annotations @Override

public void setObjectMapper(ObjectMapper objectMapper)

Overrides org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter.setObjectMapper.

Doc from org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter.setObjectMapper.

Configure the main ObjectMapper to use for Object conversion. If not set, a default ObjectMapper instance is created.

Setting a custom-configured ObjectMapper is one way to take further control of the JSON serialization process. For example, an extended com.fasterxml.jackson.databind.ser.SerializerFactory can be configured that provides custom serializers for specific types. Another option for refining the serialization process is to use Jackson's provided annotations on the types to be serialized, in which case a custom-configured ObjectMapper is unnecessary. The ObjectMapper parameter must be a XmlMapper instance.