org.springframework.web.servlet.view.script

Class ScriptTemplateConfigurer

java.lang.Object

org.springframework.web.servlet.view.script.ScriptTemplateConfigurer

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, ScriptTemplateConfig

public class ScriptTemplateConfigurer
extends Object
implements ScriptTemplateConfig, org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean

An implementation of Spring MVC's ScriptTemplateConfig for creating a ScriptEngine for use in a web application.

 // Add the following to an @Configuration class

 @Bean
 public ScriptTemplateConfigurer mustacheConfigurer() {

    ScriptTemplateConfigurer configurer = new ScriptTemplateConfigurer();
    configurer.setEngineName("nashorn");
    configurer.setScripts("mustache.js");
    configurer.setRenderObject("Mustache");
    configurer.setRenderFunction("render");
    return configurer;
 }
 

Since:

4.2

Author:

Sebastien Deleuze

See Also:

ScriptTemplateView

Constructor Summary

Constructors

Constructor and Description
ScriptTemplateConfigurer()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected ClassLoader	createClassLoader()
protected ScriptEngine	createScriptEngine()
protected org.springframework.context.ApplicationContext	getApplicationContext()
Charset	getCharset()
ScriptEngine	getEngine()
String	getRenderFunction()
String	getRenderObject()
org.springframework.core.io.ResourceLoader	getResourceLoader()
String	getResourceLoaderPath()
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setCharset(Charset charset) Set the charset used to read script and template files.
void	setEngine(ScriptEngine engine) Set the ScriptEngine to use by the view.
void	setEngineName(String engineName) Set the engine name that will be used to instantiate the ScriptEngine.
void	setRenderFunction(String renderFunction) Set the render function name (mandatory).
void	setRenderObject(String renderObject) Set the object where belongs the render function (optional).
void	setResourceLoaderPath(String resourceLoaderPath) Set the resource loader path(s) via a Spring resource location.
void	setScripts(String... scriptNames) Set the scripts to be loaded by the script engine (library or user provided).

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptTemplateConfigurer

public ScriptTemplateConfigurer()

Method Detail

setEngine

public void setEngine(ScriptEngine engine)

Set the ScriptEngine to use by the view. The script engine must implement Invocable. You must define engine or engineName, not both.

getEngine

public ScriptEngine getEngine()

Specified by:

getEngine in interface ScriptTemplateConfig

setEngineName

public void setEngineName(String engineName)

Set the engine name that will be used to instantiate the ScriptEngine. The script engine must implement Invocable. You must define engine or engineName, not both.

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

getApplicationContext

protected org.springframework.context.ApplicationContext getApplicationContext()

setScripts

public void setScripts(String... scriptNames)

Set the scripts to be loaded by the script engine (library or user provided). Since resourceLoaderPath default value is "classpath:", you can load easily any script available on the classpath. For example, in order to use a Javascript library available as a WebJars dependency and a custom "render.js" file, you should call configurer.setScripts("/META-INF/resources/webjars/library/version/library.js", "com/myproject/script/render.js");.

See Also:

setResourceLoaderPath(String), WebJars

getRenderObject

public String getRenderObject()

Specified by:

getRenderObject in interface ScriptTemplateConfig

setRenderObject

public void setRenderObject(String renderObject)

Set the object where belongs the render function (optional). For example, in order to call Mustache.render(), renderObject should be set to "Mustache" and renderFunction to "render".

getRenderFunction

public String getRenderFunction()

Specified by:

getRenderFunction in interface ScriptTemplateConfig

setRenderFunction

public void setRenderFunction(String renderFunction)

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

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

setCharset

public void setCharset(Charset charset)

Set the charset used to read script and template files. (UTF-8 by default).

getCharset

public Charset getCharset()

Specified by:

getCharset in interface ScriptTemplateConfig

setResourceLoaderPath

public void setResourceLoaderPath(String resourceLoaderPath)

Set the resource loader path(s) via a Spring resource location. Accepts multiple locations as a comma-separated list of paths. Standard URLs like "file:" and "classpath:" and pseudo URLs are supported as understood by Spring's ResourceLoader. Relative paths are allowed when running in an ApplicationContext. Default is "classpath:".

getResourceLoaderPath

public String getResourceLoaderPath()

getResourceLoader

public org.springframework.core.io.ResourceLoader getResourceLoader()

Specified by:

getResourceLoader in interface ScriptTemplateConfig

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

createClassLoader

protected ClassLoader createClassLoader()
                                 throws IOException

Throws:

IOException

createScriptEngine

protected ScriptEngine createScriptEngine()
                                   throws IOException

Throws:

IOException