org.jahia.services.render.filter.cache

Interface CacheKeyGenerator

All Known Implementing Classes:

DefaultCacheKeyGenerator

public interface CacheKeyGenerator

Describes the module output cache key generator.

Author:

Sergiy Shyrkov

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.
String	replaceField(String key, String fieldName, String newValue) Deprecated. Not used anymore
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.

Method Detail

generate

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

Generates the output cache key based on the provided data.

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

Map<String,String> parse(String key)

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.

Parameters:

key - the cache key to be decomposed

Returns:

a map with key field values

replaceField

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

Deprecated. Not used anymore

getPartGenerator

CacheKeyPartGenerator getPartGenerator(String field)

Return the cache key part generator corresponding to the given field

Parameters:

field - the given field

Returns:

the CacheKeyPartGenerator if found, null if not

replacePlaceholdersInCacheKey

String replacePlaceholdersInCacheKey(RenderContext renderContext,
                                     String key)

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

Parameters:

renderContext - the current render context

key - the key to be transformed

Returns:

the transformed key

prepareContextForContentGeneration

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. 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.

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

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.

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

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.

Throws:

javax.jcr.RepositoryException