nl.vpro.magnolia.jsr107

Class MgnlCacheManager

java.lang.Object

nl.vpro.magnolia.jsr107.MgnlCacheManager

All Implemented Interfaces:

Closeable, AutoCloseable, javax.cache.CacheManager

public class MgnlCacheManager
extends Object
implements javax.cache.CacheManager

Adapts a magnolia CacheFactoryProvider to a CacheManager. This is needed for cache-annotations-ri-guice, but it can be used more generically for code which desires such a cache manager.

Since:

1.0

Author:

Michiel Meeuwissen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MgnlCacheManager.Getter

Constructor Summary

Constructors

Constructor and Description
MgnlCacheManager(info.magnolia.module.cache.inject.CacheFactoryProvider factory, org.jsr107.ri.annotations.guice.CacheLookupUtil util)

Method Summary

Modifier and Type	Method and Description
void	close()
<K,V,C extends javax.cache.configuration.Configuration<K,V>> javax.cache.Cache<K,V>	createCache(String cacheName, C configuration)
void	destroyCache(String cacheName)
void	enableManagement(String cacheName, boolean enabled)
void	enableStatistics(String cacheName, boolean enabled)
<K,V> javax.cache.Cache<K,V>	getCache(String cacheName)
<K,V> javax.cache.Cache<K,V>	getCache(String cacheName, Class<K> keyType, Class<V> valueType)
Iterable<String>	getCacheNames()
javax.cache.spi.CachingProvider	getCachingProvider()
ClassLoader	getClassLoader()
Iterator<Object[]>	getKeys(Class<?> clazz, Object instance, String methodName, Class<?>... keys)
protected Method	getMethod(Class<?> clazz, String methodName, Class<?>... arguments)
protected org.jsr107.ri.annotations.CacheResultMethodDetails	getMethodDetails(Class<?> clazz, String methodName, Class<?>... keyClasses)
<K,V> javax.cache.Cache<K,V>	getUnblockingCache(String cacheName) Caches in magnolia are always blocking.
URI	getURI()
Object	getValue(Class<?> clazz, Object instance, String methodName, Object... key) Gets a value from the cache (without blocking it).
Object	getValue(String cacheName, Object key) Gets a value from the cache (without blocking it) This method requires that you know exactly what the key is in the underlying cache.
MgnlCacheManager.Getter	getValueGetter(Class<?> clazz, Object instance, String methodName, Class<?>... keyClasses)
boolean	isClosed()
<T> T	unwrap(Class<T> clazz)

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.cache.CacheManager

getProperties

Constructor Detail

MgnlCacheManager

@Inject
public MgnlCacheManager(info.magnolia.module.cache.inject.CacheFactoryProvider factory,
                                org.jsr107.ri.annotations.guice.CacheLookupUtil util)

Method Detail

getCachingProvider

public javax.cache.spi.CachingProvider getCachingProvider()

Specified by:

getCachingProvider in interface javax.cache.CacheManager

getURI

public URI getURI()

Specified by:

getURI in interface javax.cache.CacheManager

getClassLoader

public ClassLoader getClassLoader()

Specified by:

getClassLoader in interface javax.cache.CacheManager

createCache

public <K,V,C extends javax.cache.configuration.Configuration<K,V>> javax.cache.Cache<K,V> createCache(String cacheName,
                                                                                                       C configuration)
                                                                                                throws IllegalArgumentException

Specified by:

createCache in interface javax.cache.CacheManager

Throws:

IllegalArgumentException

getCache

public <K,V> javax.cache.Cache<K,V> getCache(String cacheName,
                                             Class<K> keyType,
                                             Class<V> valueType)

Specified by:

getCache in interface javax.cache.CacheManager

getCache

public <K,V> javax.cache.Cache<K,V> getCache(String cacheName)

Specified by:

getCache in interface javax.cache.CacheManager

getUnblockingCache

public <K,V> javax.cache.Cache<K,V> getUnblockingCache(String cacheName)

Caches in magnolia are always blocking. Sometimes this is asking for trouble.

getCacheNames

public Iterable<String> getCacheNames()

Specified by:

getCacheNames in interface javax.cache.CacheManager

destroyCache

public void destroyCache(String cacheName)

Specified by:

destroyCache in interface javax.cache.CacheManager

enableManagement

public void enableManagement(String cacheName,
                             boolean enabled)

Specified by:

enableManagement in interface javax.cache.CacheManager

enableStatistics

public void enableStatistics(String cacheName,
                             boolean enabled)

Specified by:

enableStatistics in interface javax.cache.CacheManager

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface javax.cache.CacheManager

isClosed

public boolean isClosed()

Specified by:

isClosed in interface javax.cache.CacheManager

getValue

public Object getValue(Class<?> clazz,
                       Object instance,
                       String methodName,
                       Object... key)

Gets a value from the cache (without blocking it). Point to the method with the CacheResult annotation, and give its key parameters.

Parameters:

clazz - The class containing the @CacheResult annotation

instance - The instance on which the cache method will be called

methodName - The method for which the cache must be used

key - The arguments of that method that make up the key in the cache (considering the cache key generator and the CacheKey annotations.

getValueGetter

public MgnlCacheManager.Getter getValueGetter(Class<?> clazz,
                                              Object instance,
                                              String methodName,
                                              Class<?>... keyClasses)

getKeys

public Iterator<Object[]> getKeys(Class<?> clazz,
                                  Object instance,
                                  String methodName,
                                  Class<?>... keys)

getMethodDetails

protected org.jsr107.ri.annotations.CacheResultMethodDetails getMethodDetails(Class<?> clazz,
                                                                              String methodName,
                                                                              Class<?>... keyClasses)

getMethod

protected Method getMethod(Class<?> clazz,
                           String methodName,
                           Class<?>... arguments)

getValue

public Object getValue(String cacheName,
                       Object key)

Gets a value from the cache (without blocking it) This method requires that you know exactly what the key is in the underlying cache. getValue(Class, Object, String, Object...) does not have that requirement.

unwrap

public <T> T unwrap(Class<T> clazz)

Specified by:

unwrap in interface javax.cache.CacheManager