org.broadleafcommerce.core.web.processor

Class BroadleafCacheProcessor

java.lang.Object

org.thymeleaf.processor.AbstractProcessor

org.thymeleaf.processor.attr.AbstractAttrProcessor

org.broadleafcommerce.core.web.processor.BroadleafCacheProcessor

All Implemented Interfaces:

Comparable<org.thymeleaf.processor.IProcessor>, org.thymeleaf.processor.IProcessor

public class BroadleafCacheProcessor
extends org.thymeleaf.processor.attr.AbstractAttrProcessor

Allows for a customizable cache mechanism that can be used to avoid expensive thymeleaf processing for html fragments that are static. For high volume sites, even a 30 second cache of pages can have significant overall performance impacts. The parameters allowed for this processor include a "cacheTimeout" and "cacheKey". This component will rely on an implementation of TemplateCacheKeyResolverService to build the actual cacheKey used by the underlying caching implementation. The parameter named "cacheKey" will be used in the construction of the actual cacheKey which may rely on variables like the customer, site, theme, etc. to build the actual cacheKey. The "cacheTimeout" variable defines the maximum length of time that the fragment will be allowed to be cached. This is important for fragments for which a good cacheKey would be difficult to generate. The cacheKey resolution is pluggable using an instance of TemplateCacheKeyResolverService which will be invoked by this. The default implementation is SimpleCacheKeyResolver. Implementors can create more functional cacheKey mechanisms. For example, Broadleaf Enterprise provides an additional implementation named EnterpriseCacheKeyResolver with support for additional caching features.

Author:

bpolster

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_NAME
protected net.sf.ehcache.Cache	cache
protected TemplateCacheKeyResolverService	cacheKeyResolver
protected SystemPropertiesService	systemPropertiesService

Constructor Summary

Constructors

Constructor and Description
BroadleafCacheProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkCacheForElement(org.thymeleaf.Arguments arguments, org.thymeleaf.dom.Element element) If this template was found in cache, adds the response to the element and returns true.
protected boolean	checkExpired(org.thymeleaf.dom.Element element, net.sf.ehcache.Element cacheElement) Returns true if the item has been
void	fixElement(org.thymeleaf.dom.Element element, org.thymeleaf.Arguments arguments)
net.sf.ehcache.Cache	getCache()
protected String	getFragmentSignatureUnprefixedAttributeName(org.thymeleaf.Arguments arguments, org.thymeleaf.dom.Element element, String attributeName, String attributeValue)
int	getPrecedence()
boolean	isCachingEnabled()
org.thymeleaf.processor.ProcessorResult	processAttribute(org.thymeleaf.Arguments arguments, org.thymeleaf.dom.Element element, String attributeName)
void	setCache(net.sf.ehcache.Cache cache)
protected boolean	shouldCache(org.thymeleaf.Arguments args, org.thymeleaf.dom.Element element, String attributeName)

Methods inherited from class org.thymeleaf.processor.attr.AbstractAttrProcessor

doProcess, getMatcher

Methods inherited from class org.thymeleaf.processor.AbstractProcessor

compareTo, getMessage, getMessageForProcessor, getMessageForTemplate, process

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_NAME

public static final String ATTR_NAME

See Also:

Constant Field Values

cache

protected net.sf.ehcache.Cache cache

systemPropertiesService

protected SystemPropertiesService systemPropertiesService

cacheKeyResolver

protected TemplateCacheKeyResolverService cacheKeyResolver

Constructor Detail

BroadleafCacheProcessor

public BroadleafCacheProcessor()

Method Detail

fixElement

public void fixElement(org.thymeleaf.dom.Element element,
              org.thymeleaf.Arguments arguments)

shouldCache

protected boolean shouldCache(org.thymeleaf.Arguments args,
                  org.thymeleaf.dom.Element element,
                  String attributeName)

processAttribute

public org.thymeleaf.processor.ProcessorResult processAttribute(org.thymeleaf.Arguments arguments,
                                                       org.thymeleaf.dom.Element element,
                                                       String attributeName)

Specified by:

processAttribute in class org.thymeleaf.processor.attr.AbstractAttrProcessor

checkCacheForElement

protected boolean checkCacheForElement(org.thymeleaf.Arguments arguments,
                           org.thymeleaf.dom.Element element)

If this template was found in cache, adds the response to the element and returns true. If not found in cache, adds the cacheKey to the element so that the Writer can cache after the first process.

Parameters:

arguments -

element -

Returns:

checkExpired

protected boolean checkExpired(org.thymeleaf.dom.Element element,
                   net.sf.ehcache.Element cacheElement)

Returns true if the item has been

Parameters:

element -

cacheElement -

Returns:

getFragmentSignatureUnprefixedAttributeName

protected String getFragmentSignatureUnprefixedAttributeName(org.thymeleaf.Arguments arguments,
                                                 org.thymeleaf.dom.Element element,
                                                 String attributeName,
                                                 String attributeValue)

getPrecedence

public int getPrecedence()

Specified by:

getPrecedence in class org.thymeleaf.processor.AbstractProcessor

getCache

public net.sf.ehcache.Cache getCache()

setCache

public void setCache(net.sf.ehcache.Cache cache)

isCachingEnabled

public boolean isCachingEnabled()