org.jahia.services.render.filter.cache

Class DefaultCacheKeyGenerator

java.lang.Object

org.jahia.services.render.filter.cache.DefaultCacheKeyGenerator

All Implemented Interfaces:

CacheKeyGenerator

public class DefaultCacheKeyGenerator
extends Object
implements CacheKeyGenerator

Default implementation of the module output cache key generator.

Author:

rincevent, Sergiy Shyrkov

Constructor Summary

Constructors

Constructor and Description
DefaultCacheKeyGenerator()

Method Summary

Modifier and Type	Method and Description
String	generate(Resource resource, RenderContext renderContext, Properties properties) Generates the output cache key based on the provided data.
Properties	getAttributesForKey(RenderContext renderContext, Resource resource) Get all cache attributes that need to be applied on this fragment and that will impact key generation.
CacheKeyPartGenerator	getPartGenerator(String field) Return the cache key part generator corresponding to the given field
Map<String,String>	parse(String key) Parses the specified key into separate fields.
Map<String,Object>	prepareContextForContentGeneration(Map<String,String> keyParts, Resource resource, RenderContext renderContext) Before generating a sub-fragment during aggregation, this function will be called to modify the render context.
void	registerPartGenerator(CacheKeyPartGenerator partGenerator) Register a part generator, if part generator already exist with that key it will be replaced
String	replaceField(String key, String fieldName, String newValue) Deprecated.
String	replacePlaceholdersInCacheKey(RenderContext renderContext, String key) Transform the fragment key into the final key used for caching the fragment
void	restoreContextAfterContentGeneration(Map<String,String> keyParts, Resource resource, RenderContext renderContext, Map<String,Object> original) After generating a sub-fragment during aggregation, this function will be called to restore the render context.
void	setPartGenerators(List<CacheKeyPartGenerator> partGenerators)
void	unregisterPartGenerator(CacheKeyPartGenerator partGenerator) Unregister a part generator

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCacheKeyGenerator

public DefaultCacheKeyGenerator()

Method Detail

registerPartGenerator

public void registerPartGenerator(CacheKeyPartGenerator partGenerator)

Register a part generator, if part generator already exist with that key it will be replaced

Parameters:

partGenerator - the part generator to be registered

unregisterPartGenerator

public void unregisterPartGenerator(CacheKeyPartGenerator partGenerator)

Unregister a part generator

Parameters:

partGenerator - the part generator to be unregistered

generate

public String generate(Resource resource,
                       RenderContext renderContext,
                       Properties properties)

Description copied from interface: CacheKeyGenerator

Generates the output cache key based on the provided data.

Specified by:

generate in interface CacheKeyGenerator

Parameters:

resource - the current resource being rendered

renderContext - the current rendering context

properties - Fragment properties

Returns:

the output cache key based on the provided data

parse

public Map<String,String> parse(String key)

Description copied from interface: CacheKeyGenerator

Parses the specified key into separate fields. The map returned will specifically be passed as the first argument to the prepareContextForContentGeneration and restoreContextAfterContentGeneration methods, so implementations of these three methods should be coordinated taking this fact into account.

Specified by:

parse in interface CacheKeyGenerator

Parameters:

key - the cache key to be decomposed

Returns:

a map with key field values

replaceField

@Deprecated
public String replaceField(String key,
                                       String fieldName,
                                       String newValue)

Deprecated.

Specified by:

replaceField in interface CacheKeyGenerator

getPartGenerator

public CacheKeyPartGenerator getPartGenerator(String field)

Description copied from interface: CacheKeyGenerator

Return the cache key part generator corresponding to the given field

Specified by:

getPartGenerator in interface CacheKeyGenerator

Parameters:

field - the given field

Returns:

the CacheKeyPartGenerator if found, null if not

replacePlaceholdersInCacheKey

public String replacePlaceholdersInCacheKey(RenderContext renderContext,
                                            String key)

Description copied from interface: CacheKeyGenerator

Transform the fragment key into the final key used for caching the fragment

Specified by:

replacePlaceholdersInCacheKey in interface CacheKeyGenerator

Parameters:

renderContext - the current render context

key - the key to be transformed

Returns:

the transformed key

prepareContextForContentGeneration

public Map<String,Object> prepareContextForContentGeneration(Map<String,String> keyParts,
                                                             Resource resource,
                                                             RenderContext renderContext)

Description copied from interface: CacheKeyGenerator

Before generating a sub-fragment during aggregation, this function will be called to modify the render context. This function returns a map that represents the state of the render context as it was at the moment of the method invocation. The map retrieved is to be passed as an argument to the restoreContextAfterContentGeneration method when generation of the sub-fragment completes.

Specified by:

prepareContextForContentGeneration in interface CacheKeyGenerator

Parameters:

keyParts - The fragment key parsed, typically a map returned by the parse method

resource - The current rendered resource

renderContext - The current renderContext

Returns:

A map that represents the original state of the render context

restoreContextAfterContentGeneration

public void restoreContextAfterContentGeneration(Map<String,String> keyParts,
                                                 Resource resource,
                                                 RenderContext renderContext,
                                                 Map<String,Object> original)

Description copied from interface: CacheKeyGenerator

After generating a sub-fragment during aggregation, this function will be called to restore the render context.

Specified by:

restoreContextAfterContentGeneration in interface CacheKeyGenerator

Parameters:

keyParts - The fragment key parsed, typically a map returned by the parse method

resource - The current rendered resource

renderContext - The current renderContext

original - The map previously retrieved via prepareContextForContentGeneration() invocation

getAttributesForKey

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

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.

Specified by:

getAttributesForKey in interface CacheKeyGenerator

Throws:

javax.jcr.RepositoryException

setPartGenerators

public void setPartGenerators(List<CacheKeyPartGenerator> partGenerators)