org.jahia.services.render.filter.cache

Class AggregateCacheFilter

java.lang.Object

org.jahia.services.render.filter.ConditionalExecution

org.jahia.services.render.filter.AbstractFilter

org.jahia.services.render.filter.cache.AggregateCacheFilter

All Implemented Interfaces:

Comparable<RenderFilter>, EventListener, RenderFilter, RenderServiceAware, org.springframework.context.ApplicationListener<JahiaTemplateManagerService.TemplatePackageRedeployedEvent>

Deprecated.

@Deprecated
public class AggregateCacheFilter
extends AbstractFilter
implements org.springframework.context.ApplicationListener<JahiaTemplateManagerService.TemplatePackageRedeployedEvent>

Module content caching filter.

Since:

JAHIA 6.5 Created : 8 janv. 2010

Author:

rincevent

Nested Class Summary

Nested classes/interfaces inherited from class org.jahia.services.render.filter.AbstractFilter

AbstractFilter.AjaxRequestCondition, AbstractFilter.AnyOfCondition, AbstractFilter.ConfigurationCondition, AbstractFilter.EditModeCondition, AbstractFilter.ExecutionCondition, AbstractFilter.MainResourceCondition, AbstractFilter.ModeCondition, AbstractFilter.ModuleCondition, AbstractFilter.NodeTypeCondition, AbstractFilter.NotCondition, AbstractFilter.PatternCondition, AbstractFilter.RequestAttributeCondition, AbstractFilter.RequestCondition, AbstractFilter.RequestHeaderCondition, AbstractFilter.RequestParameterCondition, AbstractFilter.SiteTemplateSetCondition, AbstractFilter.TemplateCondition, AbstractFilter.TemplateTypeCondition, AbstractFilter.WebflowRequestCondition

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL Deprecated.
static Set<String>	ALL_SET Deprecated.
static String	CACHE_EXPIRATION Deprecated.
static String	CACHE_PER_USER Deprecated.
protected ModuleCacheProvider	cacheProvider Deprecated.
protected boolean	cascadeFragmentErrors Deprecated.
protected static Pattern	CLEANUP_REGEXP Deprecated.
protected int	dependenciesLimit Deprecated.
static String	EMPTY_USERKEY Deprecated.
protected int	errorCacheExpiration Deprecated.
static TextUtils.ReplacementGenerator	GENERATOR Deprecated.
protected ModuleGeneratorQueue	generatorQueue Deprecated.
static String	HAS_PROCESSING_SEMAPHORE_PARAM Deprecated.
protected static long	lastThreadDumpTime Deprecated.
protected static org.slf4j.Logger	logger Deprecated.
protected static Map<String,Boolean>	notCacheableFragment Deprecated.
static String	PER_USER Deprecated.
protected static ThreadLocal<Set<CountDownLatch>>	processingLatches Deprecated.
protected Byte[]	threadDumpCheckLock Deprecated.
protected static ThreadLocal<LinkedList<String>>	userKeys Deprecated.

Fields inherited from class org.jahia.services.render.filter.AbstractFilter

service

Constructor Summary

Constructors

Constructor and Description
AggregateCacheFilter() Deprecated.

Method Summary

Modifier and Type	Method and Description
protected void	addDependencies(RenderContext renderContext, String finalKey, net.sf.ehcache.Cache cache, String value, Set<String> newDependencies) Deprecated. Add key to the list of dependencies
protected String	aggregateContent(net.sf.ehcache.Cache cache, String cachedContent, RenderContext renderContext, String areaIdentifier, Stack<String> cacheKeyStack, Set<String> allPaths) Deprecated. Aggregate the content that are inside the cached fragment to get a full HTML content with all sub modules embedded.
protected String	appendDebugInformation(RenderContext renderContext, String key, String renderContent, net.sf.ehcache.Element cachedElement) Deprecated.
protected CountDownLatch	avoidParallelProcessingOfSameModule(String key, RenderContext renderContext, Resource resource, Properties properties) Deprecated.
protected CacheEntry<String>	createCacheEntry(String previousOut, RenderContext renderContext, Resource resource, String key) Deprecated. Create the cache entry based on the rendered content.
protected void	doCache(String previousOut, RenderContext renderContext, Resource resource, Properties properties, net.sf.ehcache.Cache cache, String key, String finalKey) Deprecated. Create the fragment and store it into the cache.
protected void	doCache(String previousOut, RenderContext renderContext, Resource resource, Properties properties, net.sf.ehcache.Cache cache, String key, String finalKey, boolean bypassDependencies) Deprecated.
String	execute(String previousOut, RenderContext renderContext, Resource resource, RenderChain chain) Deprecated. If the entry was not found in the cache, the execute method is called once all normal render processing has been done.
void	finalize(RenderContext renderContext, Resource resource, RenderChain chain) Deprecated.
static void	flushNotCacheableFragment() Deprecated. As of release 7.2, replaced by ModuleCacheProvider.flushNonCacheableFragments()
protected String	generateContent(RenderContext renderContext, String cacheKey, String areaIdentifier, Set<String> allPaths) Deprecated. Generates content for a sub fragment.
protected Properties	getAttributesForKey(RenderContext renderContext, Resource resource) Deprecated. Get all cache attributes that need to be applied on this fragment and that will impact key generation.
String	getContentForError(RenderContext renderContext, Resource resource, RenderChain chain, Exception e) Deprecated.
protected boolean	isCacheable(RenderContext renderContext, Resource resource, String key, Properties properties) Deprecated. Is the current fragment cacheable or not.
protected void	manageThreadDump() Deprecated.
void	onApplicationEvent(JahiaTemplateManagerService.TemplatePackageRedeployedEvent event) Deprecated.
String	prepare(RenderContext renderContext, Resource resource, RenderChain chain) Deprecated. The prepare method is the first entry point in the cache.
static String	removeCacheTags(String content) Deprecated. Remove the surrounding cache:include tags - only used for the main resource, as the content won't be included into another fragment but returned to the user
static String	removeEsiTags(String content) Deprecated.
void	removeNotCacheableFragment(String key) Deprecated. As of release 7.2, replaced by ModuleCacheProvider.removeNonCacheableFragmentsByEncodedPath(String)
protected String	replacePlaceholdersInCacheKey(RenderContext renderContext, String key) Deprecated. Replace all placeholders in the cache key to get a final key.
protected String	returnFromCache(RenderContext renderContext, Resource resource, String key, String finalKey, net.sf.ehcache.Element element, net.sf.ehcache.Cache cache) Deprecated. This method is called if the entry is found in the cache.
void	setCacheProvider(ModuleCacheProvider cacheProvider) Deprecated.
void	setCascadeFragmentErrors(boolean cascadeFragmentErrors) Deprecated.
void	setDependenciesLimit(int dependenciesLimit) Deprecated.
void	setErrorCacheExpiration(int errorCacheExpiration) Deprecated.
void	setGeneratorQueue(ModuleGeneratorQueue generatorQueue) Deprecated.
void	setSkipLatchForConfigurations(Set<String> skipLatchForConfigurations) Deprecated.
void	setSkipLatchForNodeTypes(Set<String> skipLatchForNodeTypes) Deprecated.
void	setSkipLatchForPaths(Set<String> skipLatchForPaths) Deprecated.
protected String	surroundWithCacheTag(String key, String output) Deprecated. Add <!-- cache include --> tags around the content, with the cache key as an attribute.
protected void	surroundWithCacheTag(String key, StringBuilder output) Deprecated.
protected boolean	useDependencies() Deprecated. Sets whether dependencies should be stored per cache object for this filter, which is useful for dependent flushes.

Methods inherited from class org.jahia.services.render.filter.AbstractFilter

areConditionsMatched, compareTo, equals, getDescription, getPriority, hashCode, isDisabled, setDescription, setDisabled, setPriority, setRenderService, toString

Methods inherited from class org.jahia.services.render.filter.ConditionalExecution

addCondition, addCondition, getConditionsSummary, setApplyOnConfigurations, setApplyOnEditMode, setApplyOnMainResource, setApplyOnModes, setApplyOnModules, setApplyOnNodeTypes, setApplyOnSiteTemplateSets, setApplyOnTemplates, setApplyOnTemplateTypes, setConditions, setSkipOnAjaxRequest, setSkipOnConfiguration, setSkipOnConfigurations, setSkipOnEditMode, setSkipOnMainResource, setSkipOnModes, setSkipOnModules, setSkipOnNodeTypes, setSkipOnTemplates, setSkipOnTemplateTypes, setSkipOnWebflowRequest

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

logger

protected static final transient org.slf4j.Logger logger

Deprecated.

CACHE_PER_USER

public static final String CACHE_PER_USER

Deprecated.

See Also:

Constant Field Values

PER_USER

public static final String PER_USER

Deprecated.

See Also:

Constant Field Values

CACHE_EXPIRATION

public static final String CACHE_EXPIRATION

Deprecated.

See Also:

Constant Field Values

HAS_PROCESSING_SEMAPHORE_PARAM

public static final String HAS_PROCESSING_SEMAPHORE_PARAM

Deprecated.

See Also:

Constant Field Values

EMPTY_USERKEY

public static final String EMPTY_USERKEY

Deprecated.

See Also:

Constant Field Values

ALL

public static final String ALL

Deprecated.

See Also:

Constant Field Values

ALL_SET

public static final Set<String> ALL_SET

Deprecated.

GENERATOR

public static final TextUtils.ReplacementGenerator GENERATOR

Deprecated.

cacheProvider

protected ModuleCacheProvider cacheProvider

Deprecated.

generatorQueue

protected ModuleGeneratorQueue generatorQueue

Deprecated.

CLEANUP_REGEXP

protected static final Pattern CLEANUP_REGEXP

Deprecated.

notCacheableFragment

protected static final Map<String,Boolean> notCacheableFragment

Deprecated.

processingLatches

protected static ThreadLocal<Set<CountDownLatch>> processingLatches

Deprecated.

userKeys

protected static ThreadLocal<LinkedList<String>> userKeys

Deprecated.

lastThreadDumpTime

protected static long lastThreadDumpTime

Deprecated.

threadDumpCheckLock

protected Byte[] threadDumpCheckLock

Deprecated.

dependenciesLimit

protected int dependenciesLimit

Deprecated.

cascadeFragmentErrors

protected boolean cascadeFragmentErrors

Deprecated.

errorCacheExpiration

protected int errorCacheExpiration

Deprecated.

Constructor Detail

AggregateCacheFilter

public AggregateCacheFilter()

Deprecated.

Method Detail

setDependenciesLimit

public void setDependenciesLimit(int dependenciesLimit)

Deprecated.

setCacheProvider

public void setCacheProvider(ModuleCacheProvider cacheProvider)

Deprecated.

setGeneratorQueue

public void setGeneratorQueue(ModuleGeneratorQueue generatorQueue)

Deprecated.

setCascadeFragmentErrors

public void setCascadeFragmentErrors(boolean cascadeFragmentErrors)

Deprecated.

setErrorCacheExpiration

public void setErrorCacheExpiration(int errorCacheExpiration)

Deprecated.

setSkipLatchForConfigurations

public void setSkipLatchForConfigurations(Set<String> skipLatchForConfigurations)

Deprecated.

setSkipLatchForPaths

public void setSkipLatchForPaths(Set<String> skipLatchForPaths)

Deprecated.

setSkipLatchForNodeTypes

public void setSkipLatchForNodeTypes(Set<String> skipLatchForNodeTypes)

Deprecated.

prepare

public String prepare(RenderContext renderContext,
                      Resource resource,
                      RenderChain chain)
               throws Exception

Deprecated.

The prepare method is the first entry point in the cache. Its purpose is to check if a content is inside the cache, and returns cached content for the fragment matching the requested resource if it is found. If other fragment (module tags) are embedded inside this fragment, it will get them from the cache or by calling the render service and aggregate them.

Specified by:

prepare in interface RenderFilter

Overrides:

prepare in class AbstractFilter

Parameters:

renderContext - The render context

resource - The resource to render

chain - The render chain

Returns:

The content (with sub content aggregated) if found in the cache, null otherwise.

Throws:

Exception

isCacheable

protected boolean isCacheable(RenderContext renderContext,
                              Resource resource,
                              String key,
                              Properties properties)
                       throws javax.jcr.RepositoryException

Deprecated.

Is the current fragment cacheable or not. Based on the notCacheableFragment list and the ec or v parameter.

Parameters:

renderContext - render context

resource - current resource

key - calculated cache key

properties - cache properties

Returns:

true if fragments is cacheable, false if not

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

useDependencies

protected boolean useDependencies()

Deprecated.

Sets whether dependencies should be stored per cache object for this filter, which is useful for dependent flushes.

Returns:

true if filter uses dependencies, false if not

returnFromCache

protected String returnFromCache(RenderContext renderContext,
                                 Resource resource,
                                 String key,
                                 String finalKey,
                                 net.sf.ehcache.Element element,
                                 net.sf.ehcache.Cache cache)
                          throws RenderException

Deprecated.

This method is called if the entry is found in the cache. It will get the fragment entry, and regenerates the full content by aggregating all included fragments.

Parameters:

renderContext - The render context

resource - The resource being rendered

key - The key with placeholders

finalKey - The final key with placeholders replaced

element - The cached element

cache - The cache

Returns:

Throws:

RenderException

execute

public String execute(String previousOut,
                      RenderContext renderContext,
                      Resource resource,
                      RenderChain chain)
               throws Exception

Deprecated.

If the entry was not found in the cache, the execute method is called once all normal render processing has been done. The fragment key is computed again, taking all dependencies into account. The content is cleared from all sub-content to get only the fragment content, which is finally stored in the cache.

Specified by:

execute in interface RenderFilter

Overrides:

execute in class AbstractFilter

Parameters:

previousOut - Result from the previous filter

renderContext - The render context

resource - The resource to render

chain - The render chain

Returns:

Throws:

Exception

doCache

protected void doCache(String previousOut,
                       RenderContext renderContext,
                       Resource resource,
                       Properties properties,
                       net.sf.ehcache.Cache cache,
                       String key,
                       String finalKey)
                throws javax.jcr.RepositoryException,
                       ParseException

Deprecated.

Create the fragment and store it into the cache.

Parameters:

previousOut -

renderContext -

resource -

properties -

cache -

key -

finalKey -

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

ParseException

doCache

protected void doCache(String previousOut,
                       RenderContext renderContext,
                       Resource resource,
                       Properties properties,
                       net.sf.ehcache.Cache cache,
                       String key,
                       String finalKey,
                       boolean bypassDependencies)
                throws javax.jcr.RepositoryException,
                       ParseException

Deprecated.

Throws:

javax.jcr.RepositoryException

ParseException

getAttributesForKey

protected Properties getAttributesForKey(RenderContext renderContext,
                                         Resource resource)
                                  throws javax.jcr.RepositoryException

Deprecated.

Get all cache attributes that need to be applied on this fragment and that will impact key generation. The cache properties may come from the script properties file, or from the jmix:cache mixin (for cache.perUser only).

If the component is a list, the properties can also come from its hidden.load script properties.

cache.perUser : is the cache entry specific for each user. Is set by j:perUser node property or cache.perUser property in script properties

cache.mainResource : is the cache entry dependant on the main resource. Is set by cache.mainResource property in script properties, or automatically set if the component is bound.

cache.requestParameters : list of request parameter that will impact the rendering of the resource. Is set by cache.requestParameters property in script properties. ec,v,cacheinfo and moduleinfo are automatically added.

cache.expiration : the expiration time of the cache entry. Can be set by the "expiration" request attribute, j:expiration node property or the cache.expiration property in script properties.

Parameters:

renderContext -

resource -

Returns:

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

createCacheEntry

protected CacheEntry<String> createCacheEntry(String previousOut,
                                              RenderContext renderContext,
                                              Resource resource,
                                              String key)

Deprecated.

Create the cache entry based on the rendered content. All sub-content (which should be surrounded by <!-- cache:include --> tags) are removed and replaced by <jahia_esi:include> tags, keeping only the cache key (without placeholder replacements).

Parameters:

previousOut - The full rendered content, coming from the render chain

renderContext - The render context

resource - The resource that is being rendered

key - The key of the fragment

Returns:

An entry that can be stored in the cache

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

addDependencies

protected void addDependencies(RenderContext renderContext,
                               String finalKey,
                               net.sf.ehcache.Cache cache,
                               String value,
                               Set<String> newDependencies)

Deprecated.

Add key to the list of dependencies

Parameters:

renderContext -

finalKey -

cache -

value -

newDependencies -

replacePlaceholdersInCacheKey

protected String replacePlaceholdersInCacheKey(RenderContext renderContext,
                                               String key)

Deprecated.

Replace all placeholders in the cache key to get a final key.

Parameters:

renderContext - RenderContext

key - Key with placeholders

Returns:

The final key with placeholders replaced

aggregateContent

protected String aggregateContent(net.sf.ehcache.Cache cache,
                                  String cachedContent,
                                  RenderContext renderContext,
                                  String areaIdentifier,
                                  Stack<String> cacheKeyStack,
                                  Set<String> allPaths)
                           throws RenderException

Deprecated.

Aggregate the content that are inside the cached fragment to get a full HTML content with all sub modules embedded.

Parameters:

cache - The cache

cachedContent - The fragment, as it is stored in the cache

renderContext - The render context

areaIdentifier -

cacheKeyStack -

allPaths -

Returns:

Throws:

RenderException

generateContent

protected String generateContent(RenderContext renderContext,
                                 String cacheKey,
                                 String areaIdentifier,
                                 Set<String> allPaths)
                          throws RenderException

Deprecated.

Generates content for a sub fragment.

Parameters:

renderContext - The render context

cacheKey - The cache key of the fragment to generate

areaIdentifier -

allPaths -

Throws:

RenderException

surroundWithCacheTag

protected String surroundWithCacheTag(String key,
                                      String output)

Deprecated.

Add <!-- cache include --> tags around the content, with the cache key as an attribute.

Parameters:

key - The key of the fragment

output - The content

Returns:

The content surrounded by the tag

surroundWithCacheTag

protected void surroundWithCacheTag(String key,
                                    StringBuilder output)

Deprecated.

appendDebugInformation

protected String appendDebugInformation(RenderContext renderContext,
                                        String key,
                                        String renderContent,
                                        net.sf.ehcache.Element cachedElement)

Deprecated.

removeEsiTags

public static String removeEsiTags(String content)

Deprecated.

removeCacheTags

public static String removeCacheTags(String content)

Deprecated.

Remove the surrounding cache:include tags - only used for the main resource, as the content won't be included into another fragment but returned to the user

Parameters:

content -

Returns:

getContentForError

public String getContentForError(RenderContext renderContext,
                                 Resource resource,
                                 RenderChain chain,
                                 Exception e)

Deprecated.

Specified by:

getContentForError in interface RenderFilter

Overrides:

getContentForError in class AbstractFilter

finalize

public void finalize(RenderContext renderContext,
                     Resource resource,
                     RenderChain chain)

Deprecated.

Specified by:

finalize in interface RenderFilter

Overrides:

finalize in class AbstractFilter

avoidParallelProcessingOfSameModule

protected CountDownLatch avoidParallelProcessingOfSameModule(String key,
                                                             RenderContext renderContext,
                                                             Resource resource,
                                                             Properties properties)
                                                      throws javax.jcr.RepositoryException

Deprecated.

Throws:

javax.jcr.RepositoryException

manageThreadDump

protected void manageThreadDump()

Deprecated.

onApplicationEvent

public void onApplicationEvent(JahiaTemplateManagerService.TemplatePackageRedeployedEvent event)

Deprecated.

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<JahiaTemplateManagerService.TemplatePackageRedeployedEvent>

removeNotCacheableFragment

public void removeNotCacheableFragment(String key)

Deprecated. As of release 7.2, replaced by ModuleCacheProvider.removeNonCacheableFragmentsByEncodedPath(String)

Parameters:

key -

flushNotCacheableFragment

public static void flushNotCacheableFragment()

Deprecated. As of release 7.2, replaced by ModuleCacheProvider.flushNonCacheableFragments()