public class GroovyPagesTemplateEngine extends ResourceAwareTemplateEngine
Based on (but not extending) the existing TemplateEngine implementations
within Groovy. It allows GSP pages to be re-used in different context using code like the below:
Template t = new GroovyPagesTemplateEngine()
.createTemplate(context,request,response);
t.make()
.writeTo(out);
Modifiers | Name | Description |
---|---|---|
static java.lang.String |
BEAN_ID |
|
static java.lang.String |
CONFIG_PROPERTY_DISABLE_CACHING_RESOURCES |
|
static java.lang.String |
CONFIG_PROPERTY_GSP_ENABLE_RELOAD |
Fields inherited from class | Fields |
---|---|
class ResourceAwareTemplateEngine |
BEAN_ID |
Type Params | Return Type | Name and description |
---|---|---|
|
java.lang.Object |
GroovyPagesTemplateEngine() |
|
java.lang.Object |
GroovyPagesTemplateEngine(javax.servlet.ServletContext servletContext) @param servletContext The servlet context |
|
void |
afterPropertiesSet() |
|
protected GroovyPageMetaInfo |
buildPageMetaInfo(org.springframework.core.io.Resource resource, java.lang.String pageName) |
|
protected GroovyPageMetaInfo |
buildPageMetaInfo(java.io.InputStream inputStream, org.springframework.core.io.Resource res, java.lang.String pageName) Constructs a GroovyPageMetaInfo instance which holds the script class, modified date and so on |
|
int[] |
calculateLineNumbersForPage(javax.servlet.ServletContext context, java.lang.String url) Retrieves a line number matrix for the specified page that can be used to retrieve the actual line number within the GSP page if the line number within the compiled GSP is known |
|
void |
clearPageCache() Clears the page cache. |
|
groovy.text.Template |
createTemplate(org.springframework.core.io.Resource resource) Creates a Template for the given Spring Resource instance |
|
groovy.text.Template |
createTemplate(org.springframework.core.io.Resource resource, boolean cacheable) Creates a Template for the given Spring Resource instance |
|
protected groovy.text.Template |
createTemplate(org.springframework.core.io.Resource resource, java.lang.String pageName, boolean cacheable) |
|
groovy.text.Template |
createTemplate(java.lang.String uri) Creates a Template using the given URI. |
|
groovy.text.Template |
createTemplate(org.springframework.scripting.ScriptSource scriptSource) |
|
groovy.text.Template |
createTemplate(java.lang.String txt, java.lang.String pageName) Creates a Template using the given text for the Template and the given name. |
|
groovy.text.Template |
createTemplate() Creates a Template for the currently executing Request |
|
groovy.text.Template |
createTemplate(java.io.File file) Creates a Template for the given file |
|
groovy.text.Template |
createTemplate(java.net.URL url) Creates a Template for the given URL |
|
groovy.text.Template |
createTemplate(java.io.InputStream inputStream) Create a Template for the given InputStream |
|
groovy.text.Template |
createTemplateForUri(java.lang.String uri) |
|
groovy.text.Template |
createTemplateForUri(java.lang.String[] uris) |
|
protected java.lang.String |
establishPageName(org.springframework.core.io.Resource resource, boolean cacheable) |
|
protected java.lang.String |
establishPageName(org.springframework.core.io.Resource res, java.lang.String pageName) Establishes the name to use for the given resource |
|
GroovyPageScriptSource |
findScriptSource(java.lang.String uri) |
|
GroovyPageScriptSource |
findScriptSource(java.lang.String[] uris) |
|
protected java.lang.String |
getCurrentRequestUri(javax.servlet.http.HttpServletRequest request) Return the page identifier. |
|
java.util.Map<java.lang.String, java.lang.Class<?>> |
getDomainClassMap() |
|
GroovyPageLocator |
getGroovyPageLocator() |
|
java.util.List<GroovyPageSourceDecorator> |
getGroovyPageSourceDecorators() |
|
java.lang.String |
getGspEncoding() |
|
org.springframework.core.io.Resource |
getResourceForUri(java.lang.String uri) Attempts to retrieve a reference to a GSP as a Spring Resource instance for the given URI. |
|
protected java.lang.String |
getUriWithinGrailsViews(java.lang.String relativeUri) Returns the path to the view of the relative URI within the Grails views directory |
|
boolean |
isCacheResources() |
|
boolean |
isReloadEnabled() Return whether reload is enabled for the GroovyPagesTemplateEngine |
|
int |
mapStackLineNumber(java.lang.String url, int lineNumber) |
|
void |
onApplicationEvent(org.springframework.context.event.ContextRefreshedEvent event) |
|
void |
setApplicationContext(org.springframework.context.ApplicationContext applicationContext) Sets the ResourceLoader from the ApplicationContext |
|
void |
setBeanClassLoader(java.lang.ClassLoader beanClassLoader) |
|
void |
setCacheResources(boolean cacheResources) |
|
void |
setClassLoader(java.lang.ClassLoader classLoader) Sets the ClassLoader that the TemplateEngine should use to |
|
void |
setGroovyPageLocator(GroovyPageLocator groovyPageLocator) |
|
void |
setGroovyPageSourceDecorators(java.util.List<GroovyPageSourceDecorator> groovyPageSourceDecorators) |
|
void |
setJspTagLibraryResolver(TagLibraryResolver jspTagLibraryResolver) |
|
void |
setReloadEnabled(boolean b) Sets whether reloading is enabled |
|
void |
setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader) |
|
void |
setServletContext(javax.servlet.ServletContext servletContext) |
|
void |
setTagLibraryLookup(TagLibraryLookup tagLibraryLookup) |
Methods inherited from class | Name |
---|---|
class ResourceAwareTemplateEngine |
createTemplate, createTemplate, createTemplate, createTemplate, createTemplate, createTemplate, createTemplate, createTemplateForUri, mapStackLineNumber |
class groovy.text.TemplateEngine |
groovy.text.TemplateEngine#createTemplate(java.net.URL), groovy.text.TemplateEngine#createTemplate(java.io.File), groovy.text.TemplateEngine#createTemplate(java.lang.String), groovy.text.TemplateEngine#createTemplate(java.io.Reader), groovy.text.TemplateEngine#wait(long, int), groovy.text.TemplateEngine#wait(long), groovy.text.TemplateEngine#wait(), groovy.text.TemplateEngine#equals(java.lang.Object), groovy.text.TemplateEngine#toString(), groovy.text.TemplateEngine#hashCode(), groovy.text.TemplateEngine#getClass(), groovy.text.TemplateEngine#notify(), groovy.text.TemplateEngine#notifyAll() |
servletContext
- The servlet contextConstructs a GroovyPageMetaInfo instance which holds the script class, modified date and so on
inputStream
- The InputStream to construct the GroovyPageMetaInfo instance fromres
- The Spring Resource to construct the MetaInfo frompageName
- The name of the page (can be null, in which case method responsible for calculating appropriate alternative)Retrieves a line number matrix for the specified page that can be used to retrieve the actual line number within the GSP page if the line number within the compiled GSP is known
context
- The ServletContext instanceurl
- The URL of the pageClears the page cache. Views will be re-compiled.
Creates a Template for the given Spring Resource instance
resource
- The Resource to create the Template forCreates a Template for the given Spring Resource instance
resource
- The Resource to create the Template forcacheable
- The resource can be cached or notCreates a Template using the given URI.
uri
- The URI of the page to create the template forCreates a Template using the given text for the Template and the given name. The name of the template is required
txt
- The URI of the page to create the template forpageName
- The name of the page being parsedCreates a Template for the currently executing Request
Creates a Template for the given file
file
- The File to use to construct the template withCreates a Template for the given URL
url
- The URL to use to construct the template withCreate a Template for the given InputStream
inputStream
- The InputStream to create the Template forEstablishes the name to use for the given resource
res
- The Resource to calculate the name forpageName
- The name of the page, can be null, in which case method responsible for calculationReturn the page identifier.
request
- The HttpServletRequest instanceAttempts to retrieve a reference to a GSP as a Spring Resource instance for the given URI.
uri
- The URI to checkReturns the path to the view of the relative URI within the Grails views directory
relativeUri
- The relative URIReturn whether reload is enabled for the GroovyPagesTemplateEngine
Sets the ResourceLoader from the ApplicationContext
applicationContext
- The ApplicationContextSets the ClassLoader that the TemplateEngine should use to
classLoader
- The ClassLoader to use when compilation of Groovy Pages occursSets whether reloading is enabled
b
- True if it is enabled