org.jahia.services.render.filter.cache

Interface CacheKeyPartGenerator

All Known Implementing Classes:

AclCacheKeyPartGenerator, AjaxCacheKeyPartGenerator, AreaResourceCacheKeyPartGenerator, CanonicalPathCacheKeyPartGenerator, ContextCacheKeyPartGenerator, CustomCacheKeyPartGenerator, InAreaCacheKeyPartGenerator, LanguageCacheKeyPartGenerator, ModuleParamsCacheKeyPartGenerator, PathCacheKeyPartGenerator, QueryStringCacheKeyPartGenerator, ReadOnlyCacheKeyPartGenerator, ResourceIDCacheKeyPartGenerator, SiteCacheKeyPartGenerator, TemplateCacheKeyPartGenerator, TemplateNodesCacheKeyPartGenerator, TemplateTypeCacheKeyPartGenerator, WrappedCacheKeyPartGenerator

public interface CacheKeyPartGenerator

Interface used to implement custom Cache key part User: toto Date: 11/20/12 Time: 12:20 PM

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.

Method Detail

getKey

String getKey()

Returns:

The key to identify the part generator

getValue

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

Get value of this given key part.

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

String replacePlaceholders(RenderContext renderContext,
                           String keyPart)

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.

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