Class GroovyMarkupConfigurer
- All Implemented Interfaces:
org.springframework.beans.factory.Aware
,org.springframework.beans.factory.InitializingBean
,org.springframework.context.ApplicationContextAware
,GroovyMarkupConfig
TemplateConfiguration
and
an implementation of Spring MVC's GroovyMarkupConfig
for creating
a MarkupTemplateEngine
for use in a web application. The most basic
way to configure this class is to set the "resourceLoaderPath". For example:
// Add the following to an @Configuration class @Bean public GroovyMarkupConfig groovyMarkupConfigurer() { GroovyMarkupConfigurer configurer = new GroovyMarkupConfigurer(); configurer.setResourceLoaderPath("classpath:/WEB-INF/groovymarkup/"); return configurer; }By default this bean will create a
MarkupTemplateEngine
with:
- a parent ClassLoader for loading Groovy templates with their references
- the default configuration in the base class
TemplateConfiguration
- a
TemplateResolver
for resolving template files
MarkupTemplateEngine
instance directly to this bean
in which case all other properties will not be effectively ignored.
This bean must be included in the application context of any application
using the Spring MVC GroovyMarkupView
for rendering. It exists purely
for the purpose of configuring Groovy's Markup templates. It is not meant to be
referenced by application components directly. It implements GroovyMarkupConfig
to be found by GroovyMarkupView without depending on a bean name. Each
DispatcherServlet can define its own GroovyMarkupConfigurer if desired.
Note that resource caching is enabled by default in MarkupTemplateEngine
.
Use the TemplateConfiguration.setCacheTemplates(boolean)
to configure that as necessary.
Spring's Groovy Markup template support requires Groovy 2.3.1 or higher.
- Since:
- 4.1
- Author:
- Brian Clozel, Rossen Stoyanchev
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
protected ClassLoader
Create a parent ClassLoader for Groovy to use as parent ClassLoader when loading and compiling templates.protected groovy.text.markup.MarkupTemplateEngine
protected org.springframework.context.ApplicationContext
groovy.text.markup.MarkupTemplateEngine
Return the GroovyMarkupTemplateEngine
for the current web application context.protected URL
resolveTemplate
(ClassLoader classLoader, String templatePath) Resolve a template from the given template path.void
setApplicationContext
(org.springframework.context.ApplicationContext applicationContext) void
This method should not be used, since the considered Locale for resolving templates is the Locale for the current HTTP request.void
setResourceLoaderPath
(String resourceLoaderPath) Set the Groovy Markup Template resource loader path(s) via a Spring resource location.void
setTemplateEngine
(groovy.text.markup.MarkupTemplateEngine templateEngine) Set a pre-configured MarkupTemplateEngine to use for the Groovy Markup Template web configuration.Methods inherited from class groovy.text.markup.TemplateConfiguration
getAutoIndentString, getBaseTemplateClass, getDeclarationEncoding, getLocale, getNewLineString, isAutoEscape, isAutoIndent, isAutoNewLine, isCacheTemplates, isExpandEmptyElements, isUseDoubleQuotes, setAutoEscape, setAutoIndent, setAutoIndentString, setAutoNewLine, setBaseTemplateClass, setCacheTemplates, setDeclarationEncoding, setExpandEmptyElements, setNewLineString, setUseDoubleQuotes
-
Constructor Details
-
GroovyMarkupConfigurer
public GroovyMarkupConfigurer()
-
-
Method Details
-
setResourceLoaderPath
Set the Groovy Markup Template 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'sResourceLoader
. Relative paths are allowed when running in an ApplicationContext. -
getResourceLoaderPath
-
setTemplateEngine
public void setTemplateEngine(groovy.text.markup.MarkupTemplateEngine templateEngine) Set a pre-configured MarkupTemplateEngine to use for the Groovy Markup Template web configuration.Note that this engine instance has to be manually configured, since all other bean properties of this configurer will be ignored.
-
getTemplateEngine
public groovy.text.markup.MarkupTemplateEngine getTemplateEngine()Description copied from interface:GroovyMarkupConfig
Return the GroovyMarkupTemplateEngine
for the current web application context. May be unique to one servlet, or shared in the root context.- Specified by:
getTemplateEngine
in interfaceGroovyMarkupConfig
- Returns:
- the Groovy MarkupTemplateEngine engine
-
setApplicationContext
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext) - Specified by:
setApplicationContext
in interfaceorg.springframework.context.ApplicationContextAware
-
getApplicationContext
protected org.springframework.context.ApplicationContext getApplicationContext() -
setLocale
This method should not be used, since the considered Locale for resolving templates is the Locale for the current HTTP request.- Overrides:
setLocale
in classgroovy.text.markup.TemplateConfiguration
-
afterPropertiesSet
- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
- Throws:
Exception
-
createTemplateEngine
- Throws:
IOException
-
createTemplateClassLoader
Create a parent ClassLoader for Groovy to use as parent ClassLoader when loading and compiling templates.- Throws:
IOException
-
resolveTemplate
Resolve a template from the given template path.The default implementation uses the Locale associated with the current request, as obtained through
LocaleContextHolder
, to find the template file. Effectively the locale configured at the engine level is ignored.- Throws:
IOException
- See Also:
-
LocaleContextHolder
setLocale(java.util.Locale)
-