public class ScriptTemplateView extends AbstractUrlBasedView
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.
The 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.
ScriptTemplateConfigurer
,
ScriptTemplateViewResolver
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_CONTENT_TYPE
The default content type for the view.
|
logger
PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE
Constructor and Description |
---|
ScriptTemplateView()
Constructor for use as a bean.
|
ScriptTemplateView(java.lang.String url)
Create a new ScriptTemplateView with the given URL.
|
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(java.lang.String engineName) |
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
WebApplicationObjectSupport.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 |
setEngine(javax.script.ScriptEngine engine)
See
ScriptTemplateConfigurer.setEngine(ScriptEngine) documentation. |
void |
setEngineName(java.lang.String engineName)
See
ScriptTemplateConfigurer.setEngineName(String) documentation. |
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. |
afterPropertiesSet, getUrl, isUrlRequired, setUrl, toString
addStaticAttribute, createMergedOutputModel, createRequestContext, createTemporaryOutputStream, exposeModelAsRequestAttributes, formatViewName, generatesDownloadContent, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getRequestToExpose, getStaticAttributes, isExposePathVariables, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposePathVariables, setRequestContextAttribute, setResponseContentType, writeToResponse
getServletContext, getTempDir, getWebApplicationContext, initServletContext, isContextRequired, setServletContext
getApplicationContext, getMessageSourceAccessor, initApplicationContext, obtainApplicationContext, requiredContextClass, setApplicationContext
public static final java.lang.String DEFAULT_CONTENT_TYPE
public ScriptTemplateView()
public ScriptTemplateView(java.lang.String url)
public void setEngine(javax.script.ScriptEngine engine)
ScriptTemplateConfigurer.setEngine(ScriptEngine)
documentation.public void setEngineName(java.lang.String engineName)
ScriptTemplateConfigurer.setEngineName(String)
documentation.public void setSharedEngine(java.lang.Boolean sharedEngine)
ScriptTemplateConfigurer.setSharedEngine(Boolean)
documentation.public void setScripts(java.lang.String... scripts)
ScriptTemplateConfigurer.setScripts(String...)
documentation.public void setRenderObject(java.lang.String renderObject)
ScriptTemplateConfigurer.setRenderObject(String)
documentation.public void setRenderFunction(java.lang.String functionName)
ScriptTemplateConfigurer.setRenderFunction(String)
documentation.public void setCharset(java.nio.charset.Charset charset)
ScriptTemplateConfigurer.setCharset(Charset)
documentation.public void setResourceLoaderPath(java.lang.String resourceLoaderPath)
ScriptTemplateConfigurer.setResourceLoaderPath(String)
documentation.protected void initApplicationContext(ApplicationContext context)
WebApplicationObjectSupport
WebApplicationObjectSupport.initServletContext(javax.servlet.ServletContext)
if the
given ApplicationContext is a WebApplicationContext
.initApplicationContext
in class WebApplicationObjectSupport
context
- the containing ApplicationContextApplicationObjectSupport.setApplicationContext(org.springframework.context.ApplicationContext)
protected javax.script.ScriptEngine getEngine()
protected javax.script.ScriptEngine createEngineFromName(java.lang.String engineName)
protected void loadScripts(javax.script.ScriptEngine engine)
protected ScriptTemplateConfig autodetectViewConfig() throws BeansException
BeansException
public boolean checkResource(java.util.Locale locale) throws java.lang.Exception
AbstractUrlBasedView
checkResource
in class AbstractUrlBasedView
locale
- the desired Locale that we're looking fortrue
if the resource exists (or is assumed to exist);
false
if we know that it does not existjava.lang.Exception
- if the resource exists but is invalid (e.g. could not be parsed)protected void prepareResponse(HttpServletRequest request, HttpServletResponse response)
AbstractView
The default implementation applies a workaround for an IE bug when sending download content via HTTPS.
prepareResponse
in class AbstractView
request
- current HTTP requestresponse
- current HTTP responseprotected void renderMergedOutputModel(java.util.Map<java.lang.String,java.lang.Object> model, HttpServletRequest request, HttpServletResponse response) throws java.lang.Exception
AbstractView
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.
renderMergedOutputModel
in class AbstractView
model
- combined output Map (never null
),
with dynamic values taking precedence over static attributesrequest
- current HTTP requestresponse
- current HTTP responsejava.lang.Exception
- if rendering failedprotected java.lang.String getTemplate(java.lang.String path) throws java.io.IOException
java.io.IOException