public class

MarshallingView

extends AbstractView

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.xml.MarshallingView

Class Overview

Spring-MVC View that allows for response context to be rendered as the result of marshalling by a Marshaller.

The Object to be marshalled is supplied as a parameter in the model and then detected during response rendering. Users can either specify a specific entry in the model via the sourceKey property or have Spring locate the Source object.

Summary

Constants
String	DEFAULT_CONTENT_TYPE	Default content type.

[Expand]

Inherited Constants

From class org.springframework.web.servlet.view.AbstractView

[Expand]

Inherited Fields

From class org.springframework.context.support.ApplicationObjectSupport

From interface org.springframework.web.servlet.View

Public Constructors
	MarshallingView() Constructs a new `MarshallingView` with no `Marshaller` set.
	MarshallingView(Marshaller marshaller) Constructs a new `MarshallingView` with the given `Marshaller` set.

Public Methods
void	setMarshaller(Marshaller marshaller) Sets the `Marshaller` to be used by this view.
void	setModelKey(String modelKey) Set the name of the model key that represents the object to be marshalled.

Protected Methods
void	initApplicationContext() Subclasses can override this for custom initialization behavior.
Object	locateToBeMarshalled(Map model) Locates the object to be marshalled.
void	renderMergedOutputModel(Map model, HttpServletRequest request, HttpServletResponse response) Subclasses must implement this method to actually render the view.

[Expand]

Inherited Methods

From class org.springframework.web.servlet.view.AbstractView

void	addStaticAttribute(String name, Object value) Add static data to this view, exposed in each view.
RequestContext	createRequestContext(HttpServletRequest request, HttpServletResponse response, Map<String, Object> model) Create a RequestContext to expose under the specified attribute name.
ByteArrayOutputStream	createTemporaryOutputStream() Create a temporary OutputStream for this view.
void	exposeModelAsRequestAttributes(Map<String, Object> model, HttpServletRequest request) Expose the model objects in the given map as request attributes.
boolean	generatesDownloadContent() Return whether this view generates download content (typically binary content like PDF or Excel files).
Map<String, Object>	getAttributesMap() Allow Map access to the static attributes of this view, with the option to add or override specific entries.
String	getBeanName() Return the view's name.
String	getContentType() Return the content type for this view.
String	getRequestContextAttribute() Return the name of the RequestContext attribute, if any.
Map	getStaticAttributes() Return the static attributes for this view.
void	prepareResponse(HttpServletRequest request, HttpServletResponse response) Prepare the given response for rendering.
void	render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response) Prepares the view given the specified model, merging it with static attributes and a RequestContext attribute, if necessary.
abstract void	renderMergedOutputModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) Subclasses must implement this method to actually render the view.
void	setAttributes(Properties attributes) Set static attributes for this view from a `java.util.Properties` object.
void	setAttributesCSV(String propString) Set static attributes as a CSV string.
void	setAttributesMap(Map<String, ?> attributes) Set static attributes for this view from a Map.
void	setBeanName(String beanName) Set the view's name.
void	setContentType(String contentType) Set the content type for this view.
void	setRequestContextAttribute(String requestContextAttribute) Set the name of the RequestContext attribute for this view.
String	toString()
void	writeToResponse(HttpServletResponse response, ByteArrayOutputStream baos) Write the given temporary OutputStream to the HTTP response.

From class org.springframework.web.context.support.WebApplicationObjectSupport

From class org.springframework.context.support.ApplicationObjectSupport

From class java.lang.Object

From interface org.springframework.beans.factory.BeanNameAware

From interface org.springframework.context.ApplicationContextAware

From interface org.springframework.web.context.ServletContextAware

From interface org.springframework.web.servlet.View

Constants

public static final String DEFAULT_CONTENT_TYPE

Default content type. Overridable as bean property.

Constant Value: "application/xml"

Public Constructors

public MarshallingView ()

Constructs a new MarshallingView with no Marshaller set. The marshaller must be set after construction by invoking setMarshaller(Marshaller).

public MarshallingView (Marshaller marshaller)

Constructs a new MarshallingView with the given Marshaller set.

Public Methods

public void setMarshaller (Marshaller marshaller)

Sets the Marshaller to be used by this view.

public void setModelKey (String modelKey)

Set the name of the model key that represents the object to be marshalled. If not specified, the model map will be searched for a supported value type.

Protected Methods

protected void initApplicationContext ()

Subclasses can override this for custom initialization behavior.

The default implementation is empty. Called by initApplicationContext(org.springframework.context.ApplicationContext).

Throws

BeansException

protected Object locateToBeMarshalled (Map model)

Locates the object to be marshalled. The default implementation first attempts to look under the configured model key, if any, before attempting to locate an object of supported type.

Parameters

model	the model Map

Returns

the Object to be marshalled (or null if none found)

Throws

ServletException	if the model object specified by the `model key` is not supported by the marshaller

protected void renderMergedOutputModel (Map model, HttpServletRequest request, HttpServletResponse response)

Subclasses must implement this method to actually render the view.

The first step will be preparing the request: In the JSP case, this would mean setting model objects as request attributes. The second step will be the actual rendering of the view, for example including the JSP via a RequestDispatcher.

Parameters

model	combined output Map (never `null`), with dynamic values taking precedence over static attributes
request	current HTTP request
response	current HTTP response

Throws

Exception

Classes

MarshallingView

Class Overview

Summary

Constants

public static final String DEFAULT_CONTENT_TYPE

Public Constructors

public MarshallingView ()

public MarshallingView (Marshaller marshaller)

Public Methods

public void setMarshaller (Marshaller marshaller)

public void setModelKey (String modelKey)

See Also

Protected Methods

protected void initApplicationContext ()

Throws

protected Object locateToBeMarshalled (Map model)

Parameters

Returns

Throws

See Also

protected void renderMergedOutputModel (Map model, HttpServletRequest request, HttpServletResponse response)

Parameters

Throws