org.springframework.web.servlet.view.script

Class ScriptTemplateView

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.script.ScriptTemplateView

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, View

public class ScriptTemplateView
extends AbstractUrlBasedView

An AbstractUrlBasedView designed to run any template library based on a JSR-223 script engine.

Nashorn Javascript engine requires Java 8+.

Since:

4.2

Author:

Sebastien Deleuze

See Also:

ScriptTemplateConfigurer, ScriptTemplateViewResolver

Field Summary

Fields inherited from class org.springframework.web.servlet.view.AbstractView

DEFAULT_CONTENT_TYPE

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Fields inherited from interface org.springframework.web.servlet.View

PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE

Constructor Summary

Constructors

Constructor and Description
ScriptTemplateView()

Method Summary

Modifier and Type	Method and Description
protected ScriptTemplateConfig	autodetectViewConfig()
protected String	getTemplate(String path)
protected void	initApplicationContext(org.springframework.context.ApplicationContext context)
protected void	renderMergedOutputModel(Map<String,Object> model, HttpServletRequest request, HttpServletResponse response) Subclasses must implement this method to actually render the view.
void	setEngine(ScriptEngine engine) Set the ScriptEngine to use in this view.
void	setRenderFunction(String functionName) Set the render function name.
void	setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)

Methods inherited from class org.springframework.web.servlet.view.AbstractUrlBasedView

afterPropertiesSet, checkResource, getUrl, isUrlRequired, setUrl, toString

Methods inherited from class org.springframework.web.servlet.view.AbstractView

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

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptTemplateView

public ScriptTemplateView()

Method Detail

setEngine

public void setEngine(ScriptEngine engine)

Set the ScriptEngine to use in this view.

If not set, the engine is auto-detected by looking up up a single ScriptTemplateConfig bean in the web application context and using it to obtain the configured ScriptEngine instance.

See Also:

ScriptTemplateConfig

setRenderFunction

public void setRenderFunction(String functionName)

Set the render function name. This function will be called with the following parameters:

1. template: the view template content (String)
2. model: the view model (Map)

If not set, the function name is auto-detected by looking up up a single ScriptTemplateConfig bean in the web application context and using it to obtain the configured functionName property.

See Also:

ScriptTemplateConfig

setResourceLoader

public void setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)

initApplicationContext

protected void initApplicationContext(org.springframework.context.ApplicationContext context)

Overrides:

initApplicationContext in class org.springframework.web.context.support.WebApplicationObjectSupport

autodetectViewConfig

protected ScriptTemplateConfig autodetectViewConfig()
                                             throws org.springframework.beans.BeansException

Throws:

org.springframework.beans.BeansException

renderMergedOutputModel

protected void renderMergedOutputModel(Map<String,Object> model,
                                       HttpServletRequest request,
                                       HttpServletResponse response)
                                throws Exception

Description copied from class: AbstractView

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.

Specified by:

renderMergedOutputModel in class AbstractView

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 - if rendering failed

getTemplate

protected String getTemplate(String path)
                      throws IOException

Throws:

IOException