org.jahia.services.render.filter.cache

Class CacheFilter

java.lang.Object

org.jahia.services.render.filter.ConditionalExecution

org.jahia.services.render.filter.AbstractFilter

org.jahia.services.render.filter.cache.CacheFilter

All Implemented Interfaces:

Comparable<RenderFilter>, RenderFilter, RenderServiceAware

public class CacheFilter
extends AbstractFilter

Cache render filter, in charge of providing the html for a given fragment (from the cache or by generating it) Then cache the result if necessary Created by jkevan on 12/04/2017.

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
protected ModuleCacheProvider	cacheProvider
protected boolean	cascadeFragmentErrors
protected int	dependenciesLimit
protected int	errorCacheExpiration

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

service

Constructor Summary

Constructors

Constructor and Description
CacheFilter()

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) Add key to the list of dependencies
protected String	appendDebugInformation(Map<String,Object> moduleMap, String renderContent)
protected void	doCache(String previousOut, RenderContext renderContext, Resource resource, Long expiration, net.sf.ehcache.Cache cache, String finalKey, boolean bypassDependencies)
String	execute(String previousOut, RenderContext renderContext, Resource resource, RenderChain chain)
void	finalize(RenderContext renderContext, Resource resource, RenderChain chain)
String	getContentForError(RenderContext renderContext, Resource resource, RenderChain chain, Exception e)
protected boolean	isCacheable(RenderContext renderContext, String key, Resource resource, Properties fragmentProperties) Is the current fragment cacheable or not.
String	prepare(RenderContext renderContext, Resource resource, RenderChain chain)
protected String	returnFromCache(RenderContext renderContext, String key, String finalKey, net.sf.ehcache.Element element, Map<String,Object> moduleMap) This method is called if the entry is found in the cache.
void	setCacheProvider(ModuleCacheProvider cacheProvider)
void	setCascadeFragmentErrors(boolean cascadeFragmentErrors)
void	setDependenciesLimit(int dependenciesLimit)
void	setErrorCacheExpiration(int errorCacheExpiration)
void	setGeneratorQueue(ModuleGeneratorQueue generatorQueue)
protected boolean	useDependencies() 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

cacheProvider

protected ModuleCacheProvider cacheProvider

cascadeFragmentErrors

protected boolean cascadeFragmentErrors

errorCacheExpiration

protected int errorCacheExpiration

dependenciesLimit

protected int dependenciesLimit

Constructor Detail

CacheFilter

public CacheFilter()

Method Detail

prepare

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

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:

Content to stop the chain, or null to continue

Throws:

Exception

execute

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

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:

Filtered content

Throws:

Exception

finalize

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

Specified by:

finalize in interface RenderFilter

Overrides:

finalize in class AbstractFilter

getContentForError

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

Specified by:

getContentForError in interface RenderFilter

Overrides:

getContentForError in class AbstractFilter

doCache

protected void doCache(String previousOut,
                       RenderContext renderContext,
                       Resource resource,
                       Long expiration,
                       net.sf.ehcache.Cache cache,
                       String finalKey,
                       boolean bypassDependencies)

useDependencies

protected boolean useDependencies()

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

addDependencies

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

Add key to the list of dependencies

isCacheable

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

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

Parameters:

renderContext - render context

resource - current resource

key - calculated cache key

Returns:

true if fragments is cacheable, false if not

Throws:

javax.jcr.RepositoryException

returnFromCache

protected String returnFromCache(RenderContext renderContext,
                                 String key,
                                 String finalKey,
                                 net.sf.ehcache.Element element,
                                 Map<String,Object> moduleMap)

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

key - The key with placeholders

finalKey - The final key with placeholders replaced

element - The cached element

moduleMap - The current module map

appendDebugInformation

protected String appendDebugInformation(Map<String,Object> moduleMap,
                                        String renderContent)

setCacheProvider

public void setCacheProvider(ModuleCacheProvider cacheProvider)

setCascadeFragmentErrors

public void setCascadeFragmentErrors(boolean cascadeFragmentErrors)

setErrorCacheExpiration

public void setErrorCacheExpiration(int errorCacheExpiration)

setDependenciesLimit

public void setDependenciesLimit(int dependenciesLimit)

setGeneratorQueue

public void setGeneratorQueue(ModuleGeneratorQueue generatorQueue)