org.jahia.services.render.filter.cache

Class QueryStringCacheKeyPartGenerator

java.lang.Object

org.jahia.services.render.filter.cache.QueryStringCacheKeyPartGenerator

All Implemented Interfaces:

CacheKeyPartGenerator

public class QueryStringCacheKeyPartGenerator
extends Object
implements CacheKeyPartGenerator

Field Summary

Fields

Modifier and Type	Field and Description
protected static Pattern	QUERYSTRING_REGEXP

Constructor Summary

Constructors

Constructor and Description
QueryStringCacheKeyPartGenerator()

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.
String	replacePlaceholders(RenderContext renderContext, String keyPart) Replace placeholders in the keyPart to construct the final key used to store the fragment in the cache.

Methods inherited from class java.lang.Object

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

Field Detail

QUERYSTRING_REGEXP

protected static final Pattern QUERYSTRING_REGEXP

Constructor Detail

QueryStringCacheKeyPartGenerator

public QueryStringCacheKeyPartGenerator()

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