Class JacksonXmlView

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.view.AbstractView

org.springframework.web.servlet.view.AbstractJacksonView

org.springframework.web.servlet.view.xml.JacksonXmlView

All Implemented Interfaces:

Aware, BeanNameAware, ApplicationContextAware, ServletContextAware, View

public class JacksonXmlView
extends AbstractJacksonView

Spring MVC View that renders XML content by serializing the model for the current request using Jackson 3's XmlMapper.

The Object to be serialized is supplied as a parameter in the model. The first serializable entry is used. Users can specify a specific entry in the model via the sourceKey property.

The following special model 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

See Also:

• JacksonJsonView

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CONTENT_TYPE	Default content type: "application/xml".

Fields inherited from class AbstractJacksonView

FILTER_PROVIDER_HINT, JSON_VIEW_HINT, updateContentLength

Fields inherited from class ApplicationObjectSupport

logger

Fields inherited from interface View

PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE

Constructor Summary

Constructors

Constructor	Description
JacksonXmlView()	Construct a new instance with an XmlMapper customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader) and setting the content type to application/xml.
JacksonXmlView(tools.jackson.dataformat.xml.XmlMapper mapper)	Construct a new instance using the provided XmlMapper and setting the content type to application/xml.
JacksonXmlView(tools.jackson.dataformat.xml.XmlMapper.Builder builder)	Construct a new instance using the provided XmlMapper.Builder customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader) and setting the content type to application/xml.

Method Summary

Modifier and Type	Method	Description
protected Object	filterModel(Map<String,Object> model, jakarta.servlet.http.HttpServletRequest request)	Filter out undesired attributes from the given model.
void	setModelKey(String modelKey)	Set the attribute in the model that should be rendered by this view.

Methods inherited from class AbstractJacksonView

getEncoding, prepareResponse, renderMergedOutputModel, setDisableCaching, setEncoding, setUpdateContentLength, writeContent, writePrefix, writeSuffix

Methods inherited from class AbstractView

addStaticAttribute, createMergedOutputModel, createRequestContext, createTemporaryOutputStream, exposeModelAsRequestAttributes, formatViewName, generatesDownloadContent, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getRequestToExpose, getStaticAttributes, isExposePathVariables, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposePathVariables, setRequestContextAttribute, setResponseContentType, toString, writeToResponse

Methods inherited from class WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, obtainApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class Object

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

Field Details

DEFAULT_CONTENT_TYPE

public static final String DEFAULT_CONTENT_TYPE

Default content type: "application/xml".

Overridable through AbstractView.setContentType(String).

See Also:

• Constant Field Values

Constructor Details

JacksonXmlView

public JacksonXmlView()

Construct a new instance with an XmlMapper customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader) and setting the content type to application/xml.

JacksonXmlView

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

Construct a new instance using the provided XmlMapper.Builder customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader) and setting the content type to application/xml.

See Also:

• XmlMapper.builder()

JacksonXmlView

public JacksonXmlView(tools.jackson.dataformat.xml.XmlMapper mapper)

Construct a new instance using the provided XmlMapper and setting the content type to application/xml.

See Also:

• XmlMapper.builder()

Method Details

setModelKey

public void setModelKey(String modelKey)

Description copied from class: AbstractJacksonView

Set the attribute in the model that should be rendered by this view.

When set, all other model attributes will be ignored.

Specified by:

setModelKey in class AbstractJacksonView

filterModel

protected Object filterModel(Map<String,Object> model,
 jakarta.servlet.http.HttpServletRequest request)

Description copied from class: AbstractJacksonView

Filter out undesired attributes from the given model.

The return value can be either another Map or a single value object.

Specified by:

filterModel in class AbstractJacksonView

Parameters:

model - the model, as passed on to AbstractJacksonView.renderMergedOutputModel(Map, HttpServletRequest, HttpServletResponse)

request - current HTTP request

Returns:

the value to be rendered