org.codehaus.groovy.grails.web.pages

Class GroovyPagesTemplateEngine

java.lang.Object

groovy.text.TemplateEngine

org.codehaus.groovy.grails.support.ResourceAwareTemplateEngine

org.codehaus.groovy.grails.web.pages.GroovyPagesTemplateEngine

All Implemented Interfaces:

java.util.EventListener, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener<org.springframework.context.event.ContextRefreshedEvent>, org.springframework.web.context.ServletContextAware

public class GroovyPagesTemplateEngine
extends org.codehaus.groovy.grails.support.ResourceAwareTemplateEngine
implements org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationListener<org.springframework.context.event.ContextRefreshedEvent>, org.springframework.beans.factory.BeanClassLoaderAware

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);

Since:

0.1

Field Summary

Fields

Modifier and Type	Field and 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

Constructor Summary

Constructors

Constructor and Description
GroovyPagesTemplateEngine()
GroovyPagesTemplateEngine(javax.servlet.ServletContext servletContext) Deprecated. here for compatibility

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
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
protected GroovyPageMetaInfo	buildPageMetaInfo(org.springframework.core.io.Resource resource, java.lang.String pageName)
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() 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.io.InputStream inputStream) Create a Template for the given InputStream
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(org.springframework.scripting.ScriptSource scriptSource)
groovy.text.Template	createTemplate(java.lang.String uri) Creates a Template using the given URI.
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(java.net.URL url) Creates a Template for the given URL
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()
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	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 org.codehaus.groovy.grails.support.ResourceAwareTemplateEngine

createTemplate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIG_PROPERTY_DISABLE_CACHING_RESOURCES

public static final java.lang.String CONFIG_PROPERTY_DISABLE_CACHING_RESOURCES

See Also:

Constant Field Values

CONFIG_PROPERTY_GSP_ENABLE_RELOAD

public static final java.lang.String CONFIG_PROPERTY_GSP_ENABLE_RELOAD

See Also:

Constant Field Values

BEAN_ID

public static final java.lang.String BEAN_ID

See Also:

Constant Field Values

Constructor Detail

GroovyPagesTemplateEngine

public GroovyPagesTemplateEngine()

GroovyPagesTemplateEngine

@Deprecated
public GroovyPagesTemplateEngine(javax.servlet.ServletContext servletContext)

Deprecated. here for compatibility

Parameters:

servletContext - The servlet context

Method Detail

setGroovyPageLocator

public void setGroovyPageLocator(GroovyPageLocator groovyPageLocator)

getGroovyPageLocator

public GroovyPageLocator getGroovyPageLocator()

setResourceLoader

public void setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

setTagLibraryLookup

public void setTagLibraryLookup(TagLibraryLookup tagLibraryLookup)

setJspTagLibraryResolver

public void setJspTagLibraryResolver(TagLibraryResolver jspTagLibraryResolver)

setClassLoader

public void setClassLoader(java.lang.ClassLoader classLoader)

Sets the ClassLoader that the TemplateEngine should use to

Parameters:

classLoader - The ClassLoader to use when compilation of Groovy Pages occurs

calculateLineNumbersForPage

public 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

Parameters:

context - The ServletContext instance

url - The URL of the page

Returns:

An array where the index is the line number witin the compiled GSP and the value is the line number within the source

mapStackLineNumber

public int mapStackLineNumber(java.lang.String url,
                     int lineNumber)

Specified by:

mapStackLineNumber in class org.codehaus.groovy.grails.support.ResourceAwareTemplateEngine

createTemplate

public groovy.text.Template createTemplate(org.springframework.core.io.Resource resource)

Creates a Template for the given Spring Resource instance

Overrides:

createTemplate in class org.codehaus.groovy.grails.support.ResourceAwareTemplateEngine

Parameters:

resource - The Resource to create the Template for

Returns:

The Template instance

createTemplate

public groovy.text.Template createTemplate(org.springframework.core.io.Resource resource,
                                  boolean cacheable)

Creates a Template for the given Spring Resource instance

Specified by:

createTemplate in class org.codehaus.groovy.grails.support.ResourceAwareTemplateEngine

Parameters:

resource - The Resource to create the Template for

cacheable - The resource can be cached or not

Returns:

The Template instance

createTemplate

protected groovy.text.Template createTemplate(org.springframework.core.io.Resource resource,
                                  java.lang.String pageName,
                                  boolean cacheable)
                                       throws java.io.IOException

Throws:

java.io.IOException

establishPageName

protected java.lang.String establishPageName(org.springframework.core.io.Resource resource,
                                 boolean cacheable)

createTemplate

public groovy.text.Template createTemplate(java.lang.String uri)

Creates a Template using the given URI.

Overrides:

createTemplate in class org.codehaus.groovy.grails.support.ResourceAwareTemplateEngine

Parameters:

uri - The URI of the page to create the template for

Returns:

The Template instance

Throws:

org.codehaus.groovy.control.CompilationFailedException

createTemplateForUri

public groovy.text.Template createTemplateForUri(java.lang.String uri)

createTemplateForUri

public groovy.text.Template createTemplateForUri(java.lang.String[] uris)

Specified by:

createTemplateForUri in class org.codehaus.groovy.grails.support.ResourceAwareTemplateEngine

findScriptSource

public GroovyPageScriptSource findScriptSource(java.lang.String uri)

findScriptSource

public GroovyPageScriptSource findScriptSource(java.lang.String[] uris)

createTemplate

public groovy.text.Template createTemplate(org.springframework.scripting.ScriptSource scriptSource)

createTemplate

public groovy.text.Template createTemplate(java.lang.String txt,
                                  java.lang.String pageName)
                                    throws java.io.IOException

Creates a Template using the given text for the Template and the given name. The name of the template is required

Parameters:

txt - The URI of the page to create the template for

pageName - The name of the page being parsed

Returns:

The Template instance

Throws:

org.codehaus.groovy.control.CompilationFailedException

java.io.IOException - Thrown if an IO exception occurs creating the Template

createTemplate

public groovy.text.Template createTemplate()

Creates a Template for the currently executing Request

Returns:

The Template for the currently executing request

Throws:

java.io.IOException - Thrown when an exception occurs Reading the Template

java.lang.ClassNotFoundException - Thrown when the class of the template was not found

createTemplate

public groovy.text.Template createTemplate(java.io.File file)
                                    throws org.codehaus.groovy.control.CompilationFailedException,
                                           java.lang.ClassNotFoundException,
                                           java.io.IOException

Creates a Template for the given file

Overrides:

createTemplate in class org.codehaus.groovy.grails.support.ResourceAwareTemplateEngine

Parameters:

file - The File to use to construct the template with

Returns:

A Groovy Template instance

Throws:

org.codehaus.groovy.control.CompilationFailedException - When an error occured compiling the Template

java.lang.ClassNotFoundException - When a Class cannot be found within the given Template

java.io.IOException - When a I/O Exception occurs reading the Template

createTemplate

public groovy.text.Template createTemplate(java.net.URL url)
                                    throws org.codehaus.groovy.control.CompilationFailedException,
                                           java.lang.ClassNotFoundException,
                                           java.io.IOException

Creates a Template for the given URL

Overrides:

createTemplate in class org.codehaus.groovy.grails.support.ResourceAwareTemplateEngine

Parameters:

url - The URL to use to construct the template with

Returns:

A Groovy Template instance

Throws:

org.codehaus.groovy.control.CompilationFailedException - When an error occured compiling the Template

java.lang.ClassNotFoundException - When a Class cannot be found within the given Template

java.io.IOException - When a I/O Exception occurs reading the Template

createTemplate

public groovy.text.Template createTemplate(java.io.InputStream inputStream)

Create a Template for the given InputStream

Specified by:

createTemplate in class org.codehaus.groovy.grails.support.ResourceAwareTemplateEngine

Parameters:

inputStream - The InputStream to create the Template for

Returns:

The Template instance

buildPageMetaInfo

protected GroovyPageMetaInfo buildPageMetaInfo(org.springframework.core.io.Resource resource,
                                   java.lang.String pageName)
                                        throws java.io.IOException

Throws:

java.io.IOException

isReloadEnabled

public boolean isReloadEnabled()

Return whether reload is enabled for the GroovyPagesTemplateEngine

Returns:

true if it is

setReloadEnabled

public void setReloadEnabled(boolean b)

Sets whether reloading is enabled

Parameters:

b - True if it is enabled

getResourceForUri

public 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.

Parameters:

uri - The URI to check

Returns:

A Resource instance

buildPageMetaInfo

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

Parameters:

inputStream - The InputStream to construct the GroovyPageMetaInfo instance from

res - The Spring Resource to construct the MetaInfo from

pageName - The name of the page (can be null, in which case method responsible for calculating appropriate alternative)

Returns:

The GroovyPageMetaInfo instance

establishPageName

protected java.lang.String establishPageName(org.springframework.core.io.Resource res,
                                 java.lang.String pageName)

Establishes the name to use for the given resource

Parameters:

res - The Resource to calculate the name for

pageName - The name of the page, can be null, in which case method responsible for calculation

Returns:

The name as a String

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Sets the ResourceLoader from the ApplicationContext

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Parameters:

applicationContext - The ApplicationContext

Throws:

org.springframework.beans.BeansException - Thrown when an error occurs with the ApplicationContext

getCurrentRequestUri

protected java.lang.String getCurrentRequestUri(javax.servlet.http.HttpServletRequest request)

Return the page identifier.

Parameters:

request - The HttpServletRequest instance

Returns:

The page id

getUriWithinGrailsViews

protected java.lang.String getUriWithinGrailsViews(java.lang.String relativeUri)

Returns the path to the view of the relative URI within the Grails views directory

Parameters:

relativeUri - The relative URI

Returns:

The path of the URI within the Grails view directory

clearPageCache

public void clearPageCache()

Clears the page cache. Views will be re-compiled.

isCacheResources

public boolean isCacheResources()

setCacheResources

public void setCacheResources(boolean cacheResources)

getDomainClassMap

public java.util.Map<java.lang.String,java.lang.Class<?>> getDomainClassMap()

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

Specified by:

setServletContext in interface org.springframework.web.context.ServletContextAware

onApplicationEvent

public void onApplicationEvent(org.springframework.context.event.ContextRefreshedEvent event)

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<org.springframework.context.event.ContextRefreshedEvent>

setBeanClassLoader

public void setBeanClassLoader(java.lang.ClassLoader beanClassLoader)

Specified by:

setBeanClassLoader in interface org.springframework.beans.factory.BeanClassLoaderAware