org.jahia.services.render.filter.cache

Class TemplateNodesCacheKeyPartGenerator

java.lang.Object

org.jahia.services.render.filter.cache.TemplateNodesCacheKeyPartGenerator

All Implemented Interfaces:

CacheKeyPartGenerator, RenderContextTuner

public class TemplateNodesCacheKeyPartGenerator
extends Object
implements CacheKeyPartGenerator, RenderContextTuner

Constructor Summary

Constructors

Constructor and Description
TemplateNodesCacheKeyPartGenerator()

Method Summary

Modifier and Type	Method and Description
String	getKey()
String	getValue(Resource resource, RenderContext renderContext, Properties properties) Get value of this given key part.
Object	prepareContextForContentGeneration(String value, Resource resource, RenderContext renderContext) This will be called before a new RenderChain is started to generate a sub-fragment.
String	replacePlaceholders(RenderContext renderContext, String keyPart) Replace placeholders in the keyPart to construct the final key used to store the fragment in the cache.
void	restoreContextAfterContentGeneration(String value, Resource resource, RenderContext renderContext, Object original) This will be called after a RenderChain finished to generate a sub-fragment.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateNodesCacheKeyPartGenerator

public TemplateNodesCacheKeyPartGenerator()

Method Detail

getKey

public String getKey()

Specified by:

getKey in interface CacheKeyPartGenerator

Returns:

The key to identify the part generator

getValue

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

Description copied from interface: CacheKeyPartGenerator

Get value of this given key part.

Specified by:

getValue in interface CacheKeyPartGenerator

Parameters:

resource - the current rendered resource

renderContext - the current renderContext

properties - the current fragment properties

Returns:

the value for this part of the key

replacePlaceholders

public String replacePlaceholders(RenderContext renderContext,
                                  String keyPart)

Description copied from interface: CacheKeyPartGenerator

Replace placeholders in the keyPart to construct the final key used to store the fragment in the cache. This function will be called every time to construct the final key and try get fragment from cache, that's why this operation need to be as light as possible.

Specified by:

replacePlaceholders in interface CacheKeyPartGenerator

Parameters:

renderContext - the current render context

keyPart - the key part, a value returned by the getValue(...) function

Returns:

the final key where plecaholders replaced with actual values

prepareContextForContentGeneration

public Object prepareContextForContentGeneration(String value,
                                                 Resource resource,
                                                 RenderContext renderContext)

Description copied from interface: RenderContextTuner

This will be called before a new RenderChain is started to generate a sub-fragment. This allows to modify the context, or store data in request that need be reused for the sub-fragment generation. This is the case for module parameters, node type restrictions coming from the parent area, etc.

Specified by:

prepareContextForContentGeneration in interface RenderContextTuner

Parameters:

value - the value parsed from the key by this key part generator

resource - the current resource rendered

renderContext - the current renderContext

Returns:

An object that represents the original state of the key part in the render context

restoreContextAfterContentGeneration

public void restoreContextAfterContentGeneration(String value,
                                                 Resource resource,
                                                 RenderContext renderContext,
                                                 Object original)

Description copied from interface: RenderContextTuner

This will be called after a RenderChain finished to generate a sub-fragment. This allows to restore the context, request or anything that have been modified in the "prepareContextForContentGeneration".

Specified by:

restoreContextAfterContentGeneration in interface RenderContextTuner

Parameters:

value - the value parsed from the key by this key part generator

resource - the current resource rendered

renderContext - the current renderContext

original - the original object previously retrieved via prepareContextForContentGeneration() invocation