Class scriptTemplateConfigurer

java.lang.Object

org.springframework.web.servlet.view.script.scriptTemplateConfigurer

All Implemented Interfaces:

scriptTemplateConfig

public class scriptTemplateConfigurer
extends Object
implements scriptTemplateConfig

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;
}

NOTE: It is possible to use non thread-safe script engines with templating libraries not designed for concurrency by setting the sharedEngine property to false.

since:

4.2

Author:

sebastien Deleuze

see Also:

• scriptTemplateView

Constructor summary

Constructors

Constructor	Description
scriptTemplateConfigurer()	Default constructor.
scriptTemplateConfigurer(string engineName)	Create a new scriptTemplateConfigurer using the given engine name.

Method summary

Modifier and Type	Method	Description
@Nullable Charset	getCharset()	Return the charset used to read script and template files.
@Nullable string	getContentType()	Return the content type to use for the response.
@Nullable scriptEngine	getEngine()	Return the scriptEngine to use by the views.
@Nullable string	getEngineName()	Return the engine name that will be used to instantiate the scriptEngine.
@Nullable supplier<scriptEngine>	getEnginesupplier()	Return the engine supplier that will be used to instantiate the scriptEngine.
@Nullable string	getRenderFunction()	Return the render function name (optional).
@Nullable string	getRenderObject()	Return the object where the render function belongs (optional).
@Nullable string	getResourceLoaderPath()	Return the resource loader path(s) via a spring resource location.
string @Nullable []	getscripts()	Return the scripts to be loaded by the script engine (library or user provided).
@Nullable Boolean	issharedEngine()	Return whether to use a shared engine for all threads or whether to create thread-local engine instances for each thread.
void	setCharset(@Nullable Charset&nbsp;charset)	set the charset used to read script and template files.
void	setContentType(@Nullable string&nbsp;contentType)	set the content type to use for the response.
void	setEngine(@Nullable scriptEngine&nbsp;engine)	set the scriptEngine to use by the view.
void	setEngineName(@Nullable string&nbsp;engineName)	set the engine name that will be used to instantiate the scriptEngine.
void	setEnginesupplier(@Nullable supplier<scriptEngine>&nbsp;enginesupplier)	set the scriptEngine supplier to use by the view, usually used with setsharedEngine(Boolean) set to false.
void	setRenderFunction(@Nullable string&nbsp;renderFunction)	set the render function name (optional).
void	setRenderObject(@Nullable string&nbsp;renderObject)	set the object where the render function belongs (optional).
void	setResourceLoaderPath(@Nullable string&nbsp;resourceLoaderPath)	set the resource loader path(s) via a spring resource location.
void	setscripts(string @Nullable ...&nbsp;scriptNames)	set the scripts to be loaded by the script engine (library or user provided).
void	setsharedEngine(@Nullable Boolean&nbsp;sharedEngine)	When set to false, use thread-local scriptEngine instances instead of one single shared instance.

Methods inherited from class Object

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

Constructor Details

scriptTemplateConfigurer

public scriptTemplateConfigurer()

Default constructor.

scriptTemplateConfigurer

public scriptTemplateConfigurer(string engineName)

Create a new scriptTemplateConfigurer using the given engine name.

Method Details

setEngine

public void setEngine(@Nullable scriptEngine engine)

set the scriptEngine to use by the view. If renderFunction is specified, the script engine must implement Invocable. You must define engine or engineName, not both.

When the sharedEngine flag is set to false, you should not specify the script engine with this setter, but with setEngineName(string) or setEnginesupplier(supplier) since it implies multiple lazy instantiations of the script engine.

see Also:

• setEngineName(string)
• setEnginesupplier(supplier)

getEngine

public @Nullable scriptEngine getEngine()

Description copied from interface: scriptTemplateConfig

Return the scriptEngine to use by the views.

specified by:

getEngine in interface scriptTemplateConfig

setEnginesupplier

public&nbsp;void&nbsp;setEnginesupplier(@Nullable supplier<scriptEngine>&nbsp;enginesupplier)

set the scriptEngine supplier to use by the view, usually used with setsharedEngine(Boolean) set to false. If renderFunction is specified, the script engine must implement Invocable. You must either define enginesupplier, engine or engineName.

since:

5.2

see Also:

• setEngine(scriptEngine)
• setEngineName(string)

getEnginesupplier

public&nbsp;@Nullable supplier<scriptEngine>&nbsp;getEnginesupplier()

Description copied from interface: scriptTemplateConfig

Return the engine supplier that will be used to instantiate the scriptEngine.

specified by:

getEnginesupplier in interface scriptTemplateConfig

setEngineName

public void setEngineName(@Nullable string engineName)

set the engine name that will be used to instantiate the scriptEngine. If renderFunction is specified, the script engine must implement Invocable. You must define engine or engineName, not both.

see Also:

• setEngine(scriptEngine)
• setEnginesupplier(supplier)

getEngineName

public @Nullable string getEngineName()

Description copied from interface: scriptTemplateConfig

Return the engine name that will be used to instantiate the scriptEngine.

specified by:

getEngineName in interface scriptTemplateConfig

setsharedEngine

public void setsharedEngine(@Nullable Boolean sharedEngine)

When set to false, use thread-local scriptEngine instances instead of one single shared instance. This flag should be set to false for those using non thread-safe script engines with templating libraries not designed for concurrency.

When this flag is set to false, the script engine must be specified using setEngineName(string) or setEnginesupplier(supplier). Using setEngine(scriptEngine) is not possible because multiple instances of the script engine need to be created lazily (one per thread).

see Also:

• THREADING scriptEngine parameter

issharedEngine

public @Nullable Boolean issharedEngine()

Description copied from interface: scriptTemplateConfig

Return whether to use a shared engine for all threads or whether to create thread-local engine instances for each thread.

specified by:

issharedEngine in interface scriptTemplateConfig

setscripts

public void setscripts(string @Nullable ... 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

getscripts

public string @Nullable [] getscripts()

Description copied from interface: scriptTemplateConfig

Return the scripts to be loaded by the script engine (library or user provided).

specified by:

getscripts in interface scriptTemplateConfig

setRenderObject

public void setRenderObject(@Nullable string renderObject)

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

getRenderObject

public @Nullable string getRenderObject()

Description copied from interface: scriptTemplateConfig

Return the object where the render function belongs (optional).

specified by:

getRenderObject in interface scriptTemplateConfig

setRenderFunction

public void setRenderFunction(@Nullable string renderFunction)

set the render function name (optional). If not specified, the script templates will be evaluated with scriptEngine.eval(string, Bindings).

This function will be called with the following parameters:

1. string template: the template content
2. Map model: the view model
3. RenderingContext context: the rendering context (since 5.0)

see Also:

• RenderingContext

getRenderFunction

public @Nullable string getRenderFunction()

Description copied from interface: scriptTemplateConfig

Return the render function name (optional). If not specified, the script templates will be evaluated with scriptEngine.eval(string, Bindings).

specified by:

getRenderFunction in interface scriptTemplateConfig

setContentType

public void setContentType(@Nullable string contentType)

set the content type to use for the response. (text/html by default).

since:

4.2.1

getContentType

public @Nullable string getContentType()

Return the content type to use for the response.

specified by:

getContentType in interface scriptTemplateConfig

since:

4.2.1

setCharset

public void setCharset(@Nullable Charset charset)

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

getCharset

public @Nullable Charset getCharset()

Description copied from interface: scriptTemplateConfig

Return the charset used to read script and template files.

specified by:

getCharset in interface scriptTemplateConfig

setResourceLoaderPath

public void setResourceLoaderPath(@Nullable 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 @Nullable string getResourceLoaderPath()

Description copied from interface: scriptTemplateConfig

Return the resource loader path(s) via a spring resource location.

specified by:

getResourceLoaderPath in interface scriptTemplateConfig