Spring Framework 6.1.4 · org.springframework.web.servlet.view.script.ScriptTemplateConfigurer

Modifier and Type	Field and Description
private Charset	charset
private String	contentType
private ScriptEngine	engine
private String	engineName
private Supplier<ScriptEngine>	engineSupplier
private String	renderFunction
private String	renderObject
private String	resourceLoaderPath
private String[]	scripts
private Boolean	sharedEngine

Access	Constructor and Description
public	ScriptTemplateConfigurer() Default constructor.
public	ScriptTemplateConfigurer(String engineName) Create a new ScriptTemplateConfigurer using the given engine name.

Method Summary

Modifier and Type	Method and Description
public Charset	getCharset() Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getCharset. Return the charset used to read script and template files.
public String	getContentType() Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getContentType. Return the content type to use for the response.
public ScriptEngine	getEngine() Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getEngine. Return the `ScriptEngine` to use by the views.
public String	getEngineName() Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getEngineName. Return the engine name that will be used to instantiate the `ScriptEngine`.
public Supplier<ScriptEngine>	getEngineSupplier() Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getEngineSupplier. Return the engine supplier that will be used to instantiate the `ScriptEngine`.
public String	getRenderFunction() Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getRenderFunction. Return the render function name (optional).
public String	getRenderObject() Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getRenderObject. Return the object where the render function belongs (optional).
public String	getResourceLoaderPath() Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getResourceLoaderPath. Return the resource loader path(s) via a Spring resource location.
public String[]	getScripts() Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getScripts. Return the scripts to be loaded by the script engine (library or user provided).
public Boolean	isSharedEngine() Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.isSharedEngine. Return whether to use a shared engine for all threads or whether to create thread-local engine instances for each thread.
public void	setCharset(Charset charset) Set the charset used to read script and template files.
public void	setContentType(String contentType) Set the content type to use for the response.
public void	setEngine(ScriptEngine engine) Set the `ScriptEngine` to use by the view.
public void	setEngineName(String engineName) Set the engine name that will be used to instantiate the `ScriptEngine`.
public void	setEngineSupplier(Supplier<ScriptEngine> engineSupplier) Set the `ScriptEngine` supplier to use by the view, usually used with `setSharedEngine(Boolean)` set to `false`.
public void	setRenderFunction(String renderFunction) Set the render function name (optional).
public void	setRenderObject(String renderObject) Set the object where the render function belongs (optional).
public void	setResourceLoaderPath(String resourceLoaderPath) Set the resource loader path(s) via a Spring resource location.
public void	setScripts(String... scriptNames) Set the scripts to be loaded by the script engine (library or user provided).
public void	setSharedEngine(Boolean sharedEngine) When set to `false`, use thread-local `ScriptEngine` instances instead of one single shared instance.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

charset	back to summary
private Charset charset Annotations @Nullable

contentType	back to summary
private String contentType Annotations @Nullable

engine	back to summary
private ScriptEngine engine Annotations @Nullable

engineName	back to summary
private String engineName Annotations @Nullable

engineSupplier	back to summary
private Supplier<ScriptEngine> engineSupplier Annotations @Nullable

renderFunction	back to summary
private String renderFunction Annotations @Nullable

renderObject	back to summary
private String renderObject Annotations @Nullable

resourceLoaderPath	back to summary
private String resourceLoaderPath Annotations @Nullable

scripts	back to summary
private String[] scripts Annotations @Nullable

sharedEngine	back to summary
private Boolean sharedEngine Annotations @Nullable

ScriptTemplateConfigurer	back to summary
public ScriptTemplateConfigurer() Default constructor.

ScriptTemplateConfigurer	back to summary
public ScriptTemplateConfigurer(String engineName) Create a new ScriptTemplateConfigurer using the given engine name.

Method Detail

getCharset	back to summary
public Charset getCharset() Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getCharset. Doc from org.springframework.web.servlet.view.script.ScriptTemplateConfig.getCharset. Return the charset used to read script and template files. Annotations @Override @Nullable

getCharset

back to summary

public Charset getCharset()

Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getCharset.

Doc from org.springframework.web.servlet.view.script.ScriptTemplateConfig.getCharset.

Return the charset used to read script and template files.

Annotations

@Override
@Nullable

getContentType	back to summary
public String getContentType() Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getContentType. Return the content type to use for the response. Annotations @Override @Nullable Since 4.2.1

getContentType

back to summary

public String getContentType()

Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getContentType.

Return the content type to use for the response.

Annotations

@Override
@Nullable

Since

4.2.1

getEngine back to summary

getEngine	back to summary
public ScriptEngine getEngine() Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getEngine. Doc from org.springframework.web.servlet.view.script.ScriptTemplateConfig.getEngine. Return the `ScriptEngine` to use by the views. Annotations @Override @Nullable

public ScriptEngine getEngine()

Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getEngine.

Doc from org.springframework.web.servlet.view.script.ScriptTemplateConfig.getEngine.

Return the ScriptEngine to use by the views.

Annotations

@Override
@Nullable

getEngineName back to summary

getEngineName	back to summary
public String getEngineName() Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getEngineName. Doc from org.springframework.web.servlet.view.script.ScriptTemplateConfig.getEngineName. Return the engine name that will be used to instantiate the `ScriptEngine`. Annotations @Override @Nullable

public String getEngineName()

Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getEngineName.

Doc from org.springframework.web.servlet.view.script.ScriptTemplateConfig.getEngineName.

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

Annotations

@Override
@Nullable

getEngineSupplier back to summary

getEngineSupplier	back to summary
public Supplier<ScriptEngine> getEngineSupplier() Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getEngineSupplier. Doc from org.springframework.web.servlet.view.script.ScriptTemplateConfig.getEngineSupplier. Return the engine supplier that will be used to instantiate the `ScriptEngine`. Annotations @Override @Nullable

public Supplier<ScriptEngine> getEngineSupplier()

Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getEngineSupplier.

Doc from org.springframework.web.servlet.view.script.ScriptTemplateConfig.getEngineSupplier.

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

Annotations

@Override
@Nullable

getRenderFunction back to summary

getRenderFunction	back to summary
public String getRenderFunction() Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getRenderFunction. Doc from org.springframework.web.servlet.view.script.ScriptTemplateConfig.getRenderFunction. Return the render function name (optional). If not specified, the script templates will be evaluated with `ScriptEngine#eval(String, Bindings)`. Annotations @Override @Nullable

public String getRenderFunction()

Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getRenderFunction.

Doc from org.springframework.web.servlet.view.script.ScriptTemplateConfig.getRenderFunction.

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

Annotations

@Override
@Nullable

getRenderObject	back to summary
public String getRenderObject() Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getRenderObject. Doc from org.springframework.web.servlet.view.script.ScriptTemplateConfig.getRenderObject. Return the object where the render function belongs (optional). Annotations @Override @Nullable

getRenderObject

back to summary

public String getRenderObject()

Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getRenderObject.

Doc from org.springframework.web.servlet.view.script.ScriptTemplateConfig.getRenderObject.

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

Annotations

@Override
@Nullable

getResourceLoaderPath	back to summary
public String getResourceLoaderPath() Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getResourceLoaderPath. Doc from org.springframework.web.servlet.view.script.ScriptTemplateConfig.getResourceLoaderPath. Return the resource loader path(s) via a Spring resource location. Annotations @Override @Nullable

getResourceLoaderPath

back to summary

public String getResourceLoaderPath()

Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getResourceLoaderPath.

Doc from org.springframework.web.servlet.view.script.ScriptTemplateConfig.getResourceLoaderPath.

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

Annotations

@Override
@Nullable

getScripts	back to summary
public String[] getScripts() Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getScripts. Doc from org.springframework.web.servlet.view.script.ScriptTemplateConfig.getScripts. Return the scripts to be loaded by the script engine (library or user provided). Annotations @Override @Nullable

getScripts

back to summary

public String[] getScripts()

Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.getScripts.

Doc from org.springframework.web.servlet.view.script.ScriptTemplateConfig.getScripts.

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

Annotations

@Override
@Nullable

isSharedEngine	back to summary
public Boolean isSharedEngine() Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.isSharedEngine. Doc from org.springframework.web.servlet.view.script.ScriptTemplateConfig.isSharedEngine. Return whether to use a shared engine for all threads or whether to create thread-local engine instances for each thread. Annotations @Override @Nullable

isSharedEngine

back to summary

public Boolean isSharedEngine()

Implements org.springframework.web.servlet.view.script.ScriptTemplateConfig.isSharedEngine.

Doc from org.springframework.web.servlet.view.script.ScriptTemplateConfig.isSharedEngine.

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

Annotations

@Override
@Nullable

setCharset	back to summary
public void setCharset(Charset charset) Set the charset used to read script and template files. (`UTF-8` by default).

setContentType back to summary

setContentType	back to summary
public void setContentType(String contentType) Set the content type to use for the response. (`text/html` by default). Since 4.2.1

public void setContentType(String contentType)

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

Since: 4.2.1

setEngine back to summary

setEngine	back to summary
public void setEngine(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)`

public void setEngine(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)

setEngineName back to summary

setEngineName	back to summary
public void setEngineName(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)`

public void setEngineName(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)

setEngineSupplier back to summary

setEngineSupplier	back to summary
public void setEngineSupplier(Supplier<ScriptEngine> 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)`

public void setEngineSupplier(Supplier<ScriptEngine> 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)

setRenderFunction back to summary

setRenderFunction	back to summary
public void setRenderFunction(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: `String template`: the template content `Map model`: the view model `RenderingContext context`: the rendering context (since 5.0) See Also `RenderingContext`

public void setRenderFunction(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:

String template: the template content
Map model: the view model
RenderingContext context: the rendering context (since 5.0)

See Also: RenderingContext

setRenderObject	back to summary
public void setRenderObject(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"`.

setResourceLoaderPath back to summary

setResourceLoaderPath	back to summary
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 `org.springframework.core.io.ResourceLoader`. Relative paths are allowed when running in an ApplicationContext. Default is "classpath:".

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 org.springframework.core.io.ResourceLoader. Relative paths are allowed when running in an ApplicationContext.

Default is "classpath:".

setScripts back to summary

setScripts	back to summary
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`, WebJars

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, WebJars

setSharedEngine back to summary

setSharedEngine	back to summary
public void setSharedEngine(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, like Handlebars or React running on Nashorn for example. 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

public void setSharedEngine(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, like Handlebars or React running on Nashorn for example.

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

public Class ScriptTemplateConfigurer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail