nl.vpro.magnolia.jsr107

Class MgnlObjectsAwareCacheKeyGenerator

java.lang.Object

nl.vpro.magnolia.jsr107.MgnlObjectsAwareCacheKeyGenerator

All Implemented Interfaces:

javax.cache.annotation.CacheKeyGenerator

public class MgnlObjectsAwareCacheKeyGenerator
extends Object
implements javax.cache.annotation.CacheKeyGenerator

A CacheKeyGenerator that maps every Node argument to its path, which makes it Serializable It also recognizes some other magnolia objects, which can trivially be serialized but are not Serializable themselves. Currently these are info.magnolia.module.site.Site and info.magnolia.dam.api.Item. These are not magnolia core classes by the way. This class can be used as an argument for CacheResult.cacheKeyGenerator() for methods which have these kind of JCR or other magnolia objects as arguments.

Since:

1.13

Author:

Michiel Meeuwissen

Constructor Summary

Constructors

Constructor and Description
MgnlObjectsAwareCacheKeyGenerator()

Method Summary

Modifier and Type	Method and Description
javax.cache.annotation.GeneratedCacheKey	generateCacheKey(javax.cache.annotation.CacheKeyInvocationContext<? extends Annotation> cacheKeyInvocationContext)
static <T> void	register(Class<T> clazz, Function<T,Serializable> function)
protected static void	register(String clazz, String method)

Methods inherited from class java.lang.Object

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

Constructor Detail

MgnlObjectsAwareCacheKeyGenerator

public MgnlObjectsAwareCacheKeyGenerator()

Method Detail

register

public static <T> void register(Class<T> clazz,
                                Function<T,Serializable> function)

register

protected static void register(String clazz,
                               String method)

generateCacheKey

public javax.cache.annotation.GeneratedCacheKey generateCacheKey(javax.cache.annotation.CacheKeyInvocationContext<? extends Annotation> cacheKeyInvocationContext)

Specified by:

generateCacheKey in interface javax.cache.annotation.CacheKeyGenerator