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:

Aware, BeanNameAware, InitializingBean, ApplicationContextAware, ServletContextAware, View

public class ScriptTemplateView
extends AbstractUrlBasedView

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

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

Nashorn Javascript engine requires Java 8+, and may require setting the sharedEngine property to false in order to run properly. See ScriptTemplateConfigurer.setSharedEngine(Boolean) for more details.

Since:

4.2

Author:

Sebastien Deleuze, Juergen Hoeller

See Also:

ScriptTemplateConfigurer, ScriptTemplateViewResolver

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ScriptTemplateView.EngineKey Key class for the enginesHolder ThreadLocal.

Field Summary

Fields

Modifier and Type	Field and Description
private java.nio.charset.Charset	charset
private static java.nio.charset.Charset	DEFAULT_CHARSET
static java.lang.String	DEFAULT_CONTENT_TYPE
private static java.lang.String	DEFAULT_RESOURCE_LOADER_PATH
private javax.script.ScriptEngine	engine
private java.lang.String	engineName
private static java.lang.ThreadLocal<java.util.Map<java.lang.Object,javax.script.ScriptEngine>>	enginesHolder
private java.util.Locale	locale
private java.lang.String	renderFunction
private java.lang.String	renderObject
private ResourceLoader	resourceLoader
private java.lang.String[]	resourceLoaderPaths
private javax.script.ScriptEngineManager	scriptEngineManager
private java.lang.String[]	scripts
private java.lang.Boolean	sharedEngine

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() Constructor for use as a bean.
ScriptTemplateView(java.lang.String url) Create a new ScriptTemplateView with the given URL.

Method Summary

Modifier and Type	Method and Description
protected ScriptTemplateConfig	autodetectViewConfig()
boolean	checkResource(java.util.Locale locale) Check whether the underlying resource that the configured URL points to actually exists.
protected javax.script.ScriptEngine	createEngineFromName()
protected javax.script.ScriptEngine	getEngine()
protected Resource	getResource(java.lang.String location)
protected java.lang.String	getTemplate(java.lang.String path)
protected void	initApplicationContext(ApplicationContext context) Calls #initServletContext(javax.servlet.ServletContext) if the given ApplicationContext is a WebApplicationContext.
protected void	loadScripts(javax.script.ScriptEngine engine)
protected void	prepareResponse(HttpServletRequest request, HttpServletResponse response) Prepare the given response for rendering.
protected void	renderMergedOutputModel(java.util.Map<java.lang.String,java.lang.Object> model, HttpServletRequest request, HttpServletResponse response) Subclasses must implement this method to actually render the view.
void	setCharset(java.nio.charset.Charset charset) See ScriptTemplateConfigurer.setCharset(Charset) documentation.
void	setContentType(java.lang.String contentType) See ScriptTemplateConfigurer.setContentType(String)} documentation.
void	setEngine(javax.script.ScriptEngine engine) See ScriptTemplateConfigurer.setEngine(ScriptEngine) documentation.
void	setEngineName(java.lang.String engineName) See ScriptTemplateConfigurer.setEngineName(String) documentation.
void	setLocale(java.util.Locale locale) Set the Locale to pass to the render function.
void	setRenderFunction(java.lang.String functionName) See ScriptTemplateConfigurer.setRenderFunction(String) documentation.
void	setRenderObject(java.lang.String renderObject) See ScriptTemplateConfigurer.setRenderObject(String) documentation.
void	setResourceLoaderPath(java.lang.String resourceLoaderPath) See ScriptTemplateConfigurer.setResourceLoaderPath(String) documentation.
void	setScripts(java.lang.String... scripts) See ScriptTemplateConfigurer.setScripts(String...) documentation.
void	setSharedEngine(java.lang.Boolean sharedEngine) See ScriptTemplateConfigurer.setSharedEngine(Boolean) documentation.

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

afterPropertiesSet, 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, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, 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

Field Detail

DEFAULT_CONTENT_TYPE

public static final java.lang.String DEFAULT_CONTENT_TYPE

See Also:

Constant Field Values

DEFAULT_CHARSET

private static final java.nio.charset.Charset DEFAULT_CHARSET

DEFAULT_RESOURCE_LOADER_PATH

private static final java.lang.String DEFAULT_RESOURCE_LOADER_PATH

See Also:

Constant Field Values

enginesHolder

private static final java.lang.ThreadLocal<java.util.Map<java.lang.Object,javax.script.ScriptEngine>> enginesHolder

engine

private javax.script.ScriptEngine engine

engineName

private java.lang.String engineName

locale

private java.util.Locale locale

sharedEngine

private java.lang.Boolean sharedEngine

scripts

private java.lang.String[] scripts

renderObject

private java.lang.String renderObject

renderFunction

private java.lang.String renderFunction

charset

private java.nio.charset.Charset charset

resourceLoaderPaths

private java.lang.String[] resourceLoaderPaths

resourceLoader

private ResourceLoader resourceLoader

scriptEngineManager

private volatile javax.script.ScriptEngineManager scriptEngineManager

Constructor Detail

ScriptTemplateView

public ScriptTemplateView()

Constructor for use as a bean.

See Also:

AbstractUrlBasedView.setUrl(java.lang.String)

ScriptTemplateView

public ScriptTemplateView(java.lang.String url)

Create a new ScriptTemplateView with the given URL.

Since:

4.2.1

Method Detail

setEngine

public void setEngine(javax.script.ScriptEngine engine)

See ScriptTemplateConfigurer.setEngine(ScriptEngine) documentation.

setLocale

public void setLocale(java.util.Locale locale)

Set the Locale to pass to the render function.

Since:

5.0

setEngineName

public void setEngineName(java.lang.String engineName)

See ScriptTemplateConfigurer.setEngineName(String) documentation.

setSharedEngine

public void setSharedEngine(java.lang.Boolean sharedEngine)

See ScriptTemplateConfigurer.setSharedEngine(Boolean) documentation.

setScripts

public void setScripts(java.lang.String... scripts)

See ScriptTemplateConfigurer.setScripts(String...) documentation.

setRenderObject

public void setRenderObject(java.lang.String renderObject)

See ScriptTemplateConfigurer.setRenderObject(String) documentation.

setRenderFunction

public void setRenderFunction(java.lang.String functionName)

See ScriptTemplateConfigurer.setRenderFunction(String) documentation.

setContentType

public void setContentType(java.lang.String contentType)

See ScriptTemplateConfigurer.setContentType(String)} documentation.

Overrides:

setContentType in class AbstractView

Since:

4.2.1

setCharset

public void setCharset(java.nio.charset.Charset charset)

See ScriptTemplateConfigurer.setCharset(Charset) documentation.

setResourceLoaderPath

public void setResourceLoaderPath(java.lang.String resourceLoaderPath)

See ScriptTemplateConfigurer.setResourceLoaderPath(String) documentation.

initApplicationContext

protected void initApplicationContext(ApplicationContext context)

Description copied from class: WebApplicationObjectSupport

Calls #initServletContext(javax.servlet.ServletContext) if the given ApplicationContext is a WebApplicationContext.

Overrides:

initApplicationContext in class WebApplicationObjectSupport

Parameters:

context - the containing ApplicationContext

See Also:

ApplicationObjectSupport.setApplicationContext(org.springframework.context.ApplicationContext)

getEngine

protected javax.script.ScriptEngine getEngine()

createEngineFromName

protected javax.script.ScriptEngine createEngineFromName()

loadScripts

protected void loadScripts(javax.script.ScriptEngine engine)

getResource

protected Resource getResource(java.lang.String location)

autodetectViewConfig

protected ScriptTemplateConfig autodetectViewConfig()
                                             throws BeansException

Throws:

BeansException

checkResource

public boolean checkResource(java.util.Locale locale)
                      throws java.lang.Exception

Description copied from class: AbstractUrlBasedView

Check whether the underlying resource that the configured URL points to actually exists.

Overrides:

checkResource in class AbstractUrlBasedView

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:

java.lang.Exception - if the resource exists but is invalid (e.g. could not be parsed)

prepareResponse

protected void prepareResponse(HttpServletRequest request,
                               HttpServletResponse response)

Description copied from class: AbstractView

Prepare the given response for rendering.

The default implementation applies a workaround for an IE bug when sending download content via HTTPS.

Overrides:

prepareResponse in class AbstractView

Parameters:

request - current HTTP request

response - current HTTP response

renderMergedOutputModel

protected void renderMergedOutputModel(java.util.Map<java.lang.String,java.lang.Object> model,
                                       HttpServletRequest request,
                                       HttpServletResponse response)
                                throws java.lang.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:

java.lang.Exception - if rendering failed

getTemplate

protected java.lang.String getTemplate(java.lang.String path)
                                throws java.io.IOException

Throws:

java.io.IOException