public class

FreeMarkerView

extends AbstractTemplateView

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.AbstractUrlBasedView
				↳	org.springframework.web.servlet.view.AbstractTemplateView
					↳	org.springframework.web.servlet.view.freemarker.FreeMarkerView

Class Overview

View using the FreeMarker template engine.

Exposes the following JavaBean properties:

url: the location of the FreeMarker template to be wrapped, relative to the FreeMarker template context (directory).
encoding (optional, default is determined by FreeMarker configuration): the encoding of the FreeMarker template file

Depends on a single FreeMarkerConfig object such as FreeMarkerConfigurer being accessible in the current web application context, with any bean name. Alternatively, you can set the FreeMarker Configuration object as bean property. See setConfiguration(Configuration) for more details on the impacts of this approach.

Note: Spring's FreeMarker support requires FreeMarker 2.3 or higher.

Summary

[Expand]

Inherited Constants

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

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
	FreeMarkerView()

Public Methods
boolean	checkResource(Locale locale) Check that the FreeMarker template used for this view exists and is valid.
void	setConfiguration(Configuration configuration) Set the FreeMarker Configuration to be used by this view.
void	setEncoding(String encoding) Set the encoding of the FreeMarker template file.

Protected Methods
FreeMarkerConfig	autodetectConfiguration() Autodetect a `FreeMarkerConfig` object via the ApplicationContext.
SimpleHash	buildTemplateModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) Build a FreeMarker template model for the given model Map.
void	doRender(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) Render the FreeMarker view to the given response, using the given model map which contains the complete template model to use.
void	exposeHelpers(Map<String, Object> model, HttpServletRequest request) Expose helpers unique to each rendering operation.
Configuration	getConfiguration() Return the FreeMarker configuration used by this view.
String	getEncoding() Return the encoding for the FreeMarker template.
ObjectWrapper	getObjectWrapper() Return the configured FreeMarker ObjectWrapper, or the ObjectWrapper#DEFAULT_WRAPPER default wrapper if none specified.
Template	getTemplate(Locale locale) Retrieve the FreeMarker template for the given locale, to be rendering by this view.
Template	getTemplate(String name, Locale locale) Retrieve the FreeMarker template specified by the given name, using the encoding specified by the "encoding" bean property.
void	initServletContext(ServletContext servletContext) Invoked on startup.
void	processTemplate(Template template, SimpleHash model, HttpServletResponse response) Process the FreeMarker template to the servlet response.
void	renderMergedTemplateModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) Process the model map by merging it with the FreeMarker template.

[Expand]

Inherited Methods

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

void	applyContentType(HttpServletResponse response) Apply this view's content type as specified in the "contentType" bean property to the given response.
final void	renderMergedOutputModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) Subclasses must implement this method to actually render the view.
abstract void	renderMergedTemplateModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) Subclasses must implement this method to actually render the view.
void	setAllowRequestOverride(boolean allowRequestOverride) Set whether HttpServletRequest attributes are allowed to override (hide) controller generated model attributes of the same name.
void	setAllowSessionOverride(boolean allowSessionOverride) Set whether HttpSession attributes are allowed to override (hide) controller generated model attributes of the same name.
void	setExposeRequestAttributes(boolean exposeRequestAttributes) Set whether all request attributes should be added to the model prior to merging with the template.
void	setExposeSessionAttributes(boolean exposeSessionAttributes) Set whether all HttpSession attributes should be added to the model prior to merging with the template.
void	setExposeSpringMacroHelpers(boolean exposeSpringMacroHelpers) Set whether to expose a RequestContext for use by Spring's macro library, under the name "springMacroRequestContext".

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

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.beans.factory.InitializingBean

From interface org.springframework.context.ApplicationContextAware

From interface org.springframework.web.context.ServletContextAware

From interface org.springframework.web.servlet.View

Public Constructors

public FreeMarkerView ()

Public Methods

public boolean checkResource (Locale locale)

Check that the FreeMarker template used for this view exists and is valid.

Can be overridden to customize the behavior, for example in case of multiple templates to be rendered into a single view.

Parameters

locale	the desired Locale that we're looking for

Returns

true if the resource exists (or is assumed to exist); false if we know that it does not exist

Throws

Exception

public void setConfiguration (Configuration configuration)

Set the FreeMarker Configuration to be used by this view.

If this is not set, the default lookup will occur: a single FreeMarkerConfig is expected in the current web application context, with any bean name. Note: using this method will cause a new instance of TaglibFactory to created for every single FreeMarkerView instance. This can be quite expensive in terms of memory and initial CPU usage. In production it is recommended that you use a FreeMarkerConfig which exposes a single shared TaglibFactory.

public void setEncoding (String encoding)

Set the encoding of the FreeMarker template file. Default is determined by the FreeMarker Configuration: "ISO-8859-1" if not specified otherwise.

Specify the encoding in the FreeMarker Configuration rather than per template if all your templates share a common encoding.

Protected Methods

protected FreeMarkerConfig autodetectConfiguration ()

Autodetect a FreeMarkerConfig object via the ApplicationContext.

Returns

the Configuration instance to use for FreeMarkerViews

Throws

BeansException	if no Configuration instance could be found

protected SimpleHash buildTemplateModel (Map<String, Object> model, HttpServletRequest request, HttpServletResponse response)

Build a FreeMarker template model for the given model Map.

The default implementation builds a AllHttpScopesHashModel.

Parameters

model	the model to use for rendering
request	current HTTP request
response	current servlet response

Returns

the FreeMarker template model, as a SimpleHash or subclass thereof

protected void doRender (Map<String, Object> model, HttpServletRequest request, HttpServletResponse response)

Render the FreeMarker view to the given response, using the given model map which contains the complete template model to use.

The default implementation renders the template specified by the "url" bean property, retrieved via getTemplate. It delegates to the processTemplate method to merge the template instance with the given template model.

Adds the standard Freemarker hash models to the model: request parameters, request, session and application (ServletContext), as well as the JSP tag library hash model.

Can be overridden to customize the behavior, for example to render multiple templates into a single view.

Parameters

model	the model to use for rendering
request	current HTTP request
response	current servlet response

Throws

IOException	if the template file could not be retrieved
Exception	if rendering failed

protected void exposeHelpers (Map<String, Object> model, HttpServletRequest request)

Expose helpers unique to each rendering operation. This is necessary so that different rendering operations can't overwrite each other's formats etc.

Called by renderMergedTemplateModel. The default implementation is empty. This method can be overridden to add custom helpers to the model.

Parameters

model	The model that will be passed to the template at merge time
request	current HTTP request

Throws

Exception	if there's a fatal error while we're adding information to the context

protected Configuration getConfiguration ()

Return the FreeMarker configuration used by this view.

protected String getEncoding ()

Return the encoding for the FreeMarker template.

protected ObjectWrapper getObjectWrapper ()

Return the configured FreeMarker ObjectWrapper, or the ObjectWrapper#DEFAULT_WRAPPER default wrapper if none specified.

protected Template getTemplate (Locale locale)

Retrieve the FreeMarker template for the given locale, to be rendering by this view.

By default, the template specified by the "url" bean property will be retrieved.

Parameters

locale	the current locale

Returns

the FreeMarker template to render

Throws

IOException	if the template file could not be retrieved

protected Template getTemplate (String name, Locale locale)

Retrieve the FreeMarker template specified by the given name, using the encoding specified by the "encoding" bean property.

Can be called by subclasses to retrieve a specific template, for example to render multiple templates into a single view.

Parameters

name	the file name of the desired template
locale	the current locale

Returns

the FreeMarker template

Throws

IOException	if the template file could not be retrieved

protected void initServletContext (ServletContext servletContext)

Invoked on startup. Looks for a single FreeMarkerConfig bean to find the relevant Configuration for this factory.

Checks that the template for the default Locale can be found: FreeMarker will check non-Locale-specific templates if a locale-specific one is not found.

Parameters

servletContext	the ServletContext that this application object runs in (never `null`)

Throws

BeansException

protected void processTemplate (Template template, SimpleHash model, HttpServletResponse response)

Process the FreeMarker template to the servlet response.

Can be overridden to customize the behavior.

Parameters

template	the template to process
model	the model for the template
response	servlet response (use this to get the OutputStream or Writer)

Throws

IOException	if the template file could not be retrieved
	if thrown by FreeMarker
TemplateException

protected void renderMergedTemplateModel (Map<String, Object> model, HttpServletRequest request, HttpServletResponse response)

Process the model map by merging it with the FreeMarker template. Output is directed to the servlet response.

This method can be overridden if custom behavior is needed.

Parameters

model	combined output Map, with request attributes and session attributes merged into it if required
request	current HTTP request
response	current HTTP response

Throws

Exception

Interfaces

Classes

FreeMarkerView

Class Overview

See Also

Summary

Public Constructors

public FreeMarkerView ()

Public Methods

public boolean checkResource (Locale locale)

Parameters

Returns

Throws

public void setConfiguration (Configuration configuration)

public void setEncoding (String encoding)

Protected Methods

protected FreeMarkerConfig autodetectConfiguration ()

Returns

Throws

See Also

protected SimpleHash buildTemplateModel (Map<String, Object> model, HttpServletRequest request, HttpServletResponse response)

Parameters

Returns

protected void doRender (Map<String, Object> model, HttpServletRequest request, HttpServletResponse response)

Parameters

Throws

See Also

protected void exposeHelpers (Map<String, Object> model, HttpServletRequest request)

Parameters

Throws

See Also

protected Configuration getConfiguration ()

protected String getEncoding ()

protected ObjectWrapper getObjectWrapper ()

See Also

protected Template getTemplate (Locale locale)

Parameters

Returns

Throws

See Also

protected Template getTemplate (String name, Locale locale)

Parameters

Returns

Throws

protected void initServletContext (ServletContext servletContext)

Parameters

Throws

See Also

protected void processTemplate (Template template, SimpleHash model, HttpServletResponse response)

Parameters

Throws

See Also

protected void renderMergedTemplateModel (Map<String, Object> model, HttpServletRequest request, HttpServletResponse response)

Parameters

Throws