Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
private Charset	charset
private static final Charset	DEFAULT_CHARSET
public static final String	DEFAULT_CONTENT_TYPE Hides org.springframework.web.servlet.view.AbstractView.DEFAULT_CONTENT_TYPE. The default content type for the view.
private static final String	DEFAULT_RESOURCE_LOADER_PATH
private ScriptEngine	engine
private String	engineName
private static final ThreadLocal<Map<Object, ScriptEngine>>	enginesHolder
private Supplier<ScriptEngine>	engineSupplier
private String	renderFunction
private String	renderObject
private String[]	resourceLoaderPaths
private volatile ScriptEngineManager	scriptEngineManager
private String[]	scripts
private Boolean	sharedEngine

Access	Constructor and Description
public	ScriptTemplateView() Constructor for use as a bean.
public	ScriptTemplateView(String url) Create a new ScriptTemplateView with the given URL.

Method Summary

Modifier and Type	Method and Description
protected ScriptTemplateConfig	autodetectViewConfig()
public boolean	checkResource(Locale the desired Locale that we're looking for locale) Overrides org.springframework.web.servlet.view.AbstractUrlBasedView.checkResource. Check whether the underlying resource that the configured URL points to actually exists.
protected ScriptEngine	createEngineFromName(String engineName)
private ScriptEngine	createEngineFromSupplier()
protected ScriptEngine	getEngine()
protected Resource	getResource(String location)
protected String	getTemplate(String path)
protected void	initApplicationContext(ApplicationContext the containing ApplicationContext context) Overrides org.springframework.web.context.support.WebApplicationObjectSupport.initApplicationContext. Calls `initServletContext(jakarta.servlet.ServletContext)` if the given ApplicationContext is a `WebApplicationContext`.
protected void	loadScripts(ScriptEngine engine)
protected void	prepareResponse(HttpServletRequest current HTTP request request, HttpServletResponse current HTTP response response) Overrides org.springframework.web.servlet.view.AbstractView.prepareResponse. Prepare the given response for rendering.
protected void	renderMergedOutputModel(Map<String, Object> combined output Map (never `null`), with dynamic values taking precedence over static attributes model, HttpServletRequest current HTTP request request, HttpServletResponse current HTTP response response) Implements abstract org.springframework.web.servlet.view.AbstractView.renderMergedOutputModel. Subclasses must implement this method to actually render the view.
public void	setCharset(Charset charset) See `ScriptTemplateConfigurer#setCharset(Charset)` documentation.
public void	setEngine(ScriptEngine engine) See `ScriptTemplateConfigurer#setEngine(ScriptEngine)` documentation.
public void	setEngineName(String engineName) See `ScriptTemplateConfigurer#setEngineName(String)` documentation.
public void	setEngineSupplier(Supplier<ScriptEngine> engineSupplier) See `ScriptTemplateConfigurer#setEngineSupplier(Supplier)` documentation.
public void	setRenderFunction(String functionName) See `ScriptTemplateConfigurer#setRenderFunction(String)` documentation.
public void	setRenderObject(String renderObject) See `ScriptTemplateConfigurer#setRenderObject(String)` documentation.
public void	setResourceLoaderPath(String resourceLoaderPath) See `ScriptTemplateConfigurer#setResourceLoaderPath(String)` documentation.
public void	setScripts(String... scripts) See `ScriptTemplateConfigurer#setScripts(String...)` documentation.
public void	setSharedEngine(Boolean sharedEngine) See `ScriptTemplateConfigurer#setSharedEngine(Boolean)` documentation.

Inherited from org.springframework.web.servlet.view.AbstractUrlBasedView:: afterPropertiesSet getUrl isUrlRequired setUrl toString

Field Detail

charset	back to summary
private Charset charset Annotations @Nullable

DEFAULT_CHARSET	back to summary
private static final Charset DEFAULT_CHARSET

DEFAULT_CONTENT_TYPE	back to summary
public static final String DEFAULT_CONTENT_TYPE Hides org.springframework.web.servlet.view.AbstractView.DEFAULT_CONTENT_TYPE. The default content type for the view.

DEFAULT_CONTENT_TYPE

back to summary

public static final String DEFAULT_CONTENT_TYPE

Hides org.springframework.web.servlet.view.AbstractView.DEFAULT_CONTENT_TYPE.

The default content type for the view.

DEFAULT_RESOURCE_LOADER_PATH	back to summary
private static final String DEFAULT_RESOURCE_LOADER_PATH

engine	back to summary
private ScriptEngine engine Annotations @Nullable

engineName	back to summary
private String engineName Annotations @Nullable

enginesHolder	back to summary
private static final ThreadLocal<Map<Object, ScriptEngine>> enginesHolder

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

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

scriptEngineManager	back to summary
private volatile ScriptEngineManager scriptEngineManager Annotations @Nullable

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

sharedEngine	back to summary
private Boolean sharedEngine Annotations @Nullable

ScriptTemplateView	back to summary
public ScriptTemplateView() Constructor for use as a bean. See Also `setUrl`

ScriptTemplateView	back to summary
public ScriptTemplateView(String url) Create a new ScriptTemplateView with the given URL. Since 4.2.1

Method Detail

autodetectViewConfig	back to summary
protected ScriptTemplateConfig autodetectViewConfig() throws BeansException

checkResource back to summary

checkResource	back to summary
public boolean checkResource(Locale locale) throws Exception Overrides org.springframework.web.servlet.view.AbstractUrlBasedView.checkResource. Doc from org.springframework.web.servlet.view.AbstractUrlBasedView.checkResource. Check whether the underlying resource that the configured URL points to actually exists. Parameters locale:Locale the desired Locale that we're looking for Returns:boolean `true` if the resource exists (or is assumed to exist); `false` if we know that it does not exist Annotations @Override Exceptions Exception: if the resource exists but is invalid (e.g. could not be parsed)

public boolean checkResource(Locale locale) throws Exception

Overrides org.springframework.web.servlet.view.AbstractUrlBasedView.checkResource.

Doc from org.springframework.web.servlet.view.AbstractUrlBasedView.checkResource.

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

Parameters

locale:Locale: the desired Locale that we're looking for

Returns:boolean

true if the resource exists (or is assumed to exist); false if we know that it does not exist

Annotations

@Override

Exceptions

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

createEngineFromName	back to summary
protected ScriptEngine createEngineFromName(String engineName)

createEngineFromSupplier	back to summary
private ScriptEngine createEngineFromSupplier()

getEngine	back to summary
protected ScriptEngine getEngine()

getResource	back to summary
protected Resource getResource(String location) Annotations @Nullable

getTemplate	back to summary
protected String getTemplate(String path) throws IOException

initApplicationContext back to summary

initApplicationContext	back to summary
protected void initApplicationContext(ApplicationContext context) Overrides org.springframework.web.context.support.WebApplicationObjectSupport.initApplicationContext. Doc from org.springframework.web.context.support.WebApplicationObjectSupport.initApplicationContext. Calls `initServletContext(jakarta.servlet.ServletContext)` if the given ApplicationContext is a `WebApplicationContext`. Parameters context:ApplicationContext Doc from org.springframework.context.support.ApplicationObjectSupport.initApplicationContext. the containing ApplicationContext Annotations @Override

protected void initApplicationContext(ApplicationContext context)

Overrides org.springframework.web.context.support.WebApplicationObjectSupport.initApplicationContext.

Doc from org.springframework.web.context.support.WebApplicationObjectSupport.initApplicationContext.

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

Parameters

context:ApplicationContext

Doc from org.springframework.context.support.ApplicationObjectSupport.initApplicationContext.

the containing ApplicationContext

Annotations

@Override

loadScripts	back to summary
protected void loadScripts(ScriptEngine engine)

prepareResponse	back to summary
protected void prepareResponse(HttpServletRequest request, HttpServletResponse response) Overrides org.springframework.web.servlet.view.AbstractView.prepareResponse. Doc from org.springframework.web.servlet.view.AbstractView.prepareResponse. Prepare the given response for rendering. The default implementation applies a workaround for an IE bug when sending download content via HTTPS. Parameters request:HttpServletRequest current HTTP request response:HttpServletResponse current HTTP response Annotations @Override

prepareResponse

back to summary

protected void prepareResponse(HttpServletRequest request, HttpServletResponse response)

Overrides org.springframework.web.servlet.view.AbstractView.prepareResponse.

Doc from org.springframework.web.servlet.view.AbstractView.prepareResponse.

Prepare the given response for rendering.

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

Parameters

request:HttpServletRequest: current HTTP request
response:HttpServletResponse: current HTTP response

Annotations

@Override

renderMergedOutputModel back to summary

renderMergedOutputModel	back to summary
protected void renderMergedOutputModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) throws Exception Implements abstract org.springframework.web.servlet.view.AbstractView.renderMergedOutputModel. Doc from org.springframework.web.servlet.view.AbstractView.renderMergedOutputModel. 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. Parameters model:Map<String, Object> combined output Map (never `null`), with dynamic values taking precedence over static attributes request:HttpServletRequest current HTTP request response:HttpServletResponse current HTTP response Annotations @Override Exceptions Exception: if rendering failed

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

Implements abstract org.springframework.web.servlet.view.AbstractView.renderMergedOutputModel.

Doc from org.springframework.web.servlet.view.AbstractView.renderMergedOutputModel.

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.

Parameters

model:Map<String, Object>: combined output Map (never null), with dynamic values taking precedence over static attributes
request:HttpServletRequest: current HTTP request
response:HttpServletResponse: current HTTP response

Annotations

@Override

Exceptions

Exception:: if rendering failed

setCharset	back to summary
public void setCharset(Charset charset) See `ScriptTemplateConfigurer#setCharset(Charset)` documentation.

setEngine	back to summary
public void setEngine(ScriptEngine engine) See `ScriptTemplateConfigurer#setEngine(ScriptEngine)` documentation.

setEngineName	back to summary
public void setEngineName(String engineName) See `ScriptTemplateConfigurer#setEngineName(String)` documentation.

setEngineSupplier back to summary

setEngineSupplier	back to summary
public void setEngineSupplier(Supplier<ScriptEngine> engineSupplier) See `ScriptTemplateConfigurer#setEngineSupplier(Supplier)` documentation. Since 5.2

public void setEngineSupplier(Supplier<ScriptEngine> engineSupplier)

See ScriptTemplateConfigurer#setEngineSupplier(Supplier) documentation.

Since: 5.2

setRenderFunction	back to summary
public void setRenderFunction(String functionName) See `ScriptTemplateConfigurer#setRenderFunction(String)` documentation.

setRenderObject	back to summary
public void setRenderObject(String renderObject) See `ScriptTemplateConfigurer#setRenderObject(String)` documentation.

setResourceLoaderPath	back to summary
public void setResourceLoaderPath(String resourceLoaderPath) See `ScriptTemplateConfigurer#setResourceLoaderPath(String)` documentation.

setScripts	back to summary
public void setScripts(String... scripts) See `ScriptTemplateConfigurer#setScripts(String...)` documentation.

setSharedEngine	back to summary
public void setSharedEngine(Boolean sharedEngine) See `ScriptTemplateConfigurer#setSharedEngine(Boolean)` documentation.

org.springframework.web.servlet.view.script back to summary

private Class ScriptTemplateView.EngineKey

Class Inheritance

extends Object

java.lang.Object
org.springframework.web.servlet.view.script.ScriptTemplateView.EngineKey

Key class for the enginesHolder ThreadLocal. Only used if scripts have been specified; otherwise, the engineName String will be used as cache key directly.

Field Summary

Modifier and Type	Field and Description
private final String	engineName
private final String[]	scripts

Constructor Summary

Access	Constructor and Description
public	EngineKey(String engineName, String[] scripts)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.

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

Field Detail

engineName	back to summary
private final String engineName

scripts	back to summary
private final String[] scripts

Constructor Detail

EngineKey	back to summary
public EngineKey(String engineName, String[] scripts)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters other:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

other:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

public Class ScriptTemplateView

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ScriptTemplateView.EngineKey

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail