Class CacheUtils

java.lang.Object

ubic.gemma.persistence.cache.CacheUtils

public class CacheUtils
extends Object

Common helpers for Spring Cache manipulation.

Pre-phase-2 this class branched per native cache type (EhCache 2 vs. Map vs. fallback). Phase 2 retired EhCache 2 and reduced to "Map or generic Spring Cache fallback". Phase 3 reintroduced a real CacheManager-backed Spring CacheManager (EhcacheConfig), so the native cache is now a Cache (JSR-107) for every application cache. The helpers below cover both backings: Map (for tests / ad-hoc ConcurrentMapCache) and Cache (production).

Constructor Summary

Constructors

Constructor	Description
CacheUtils()

Method Summary

Modifier and Type	Method	Description
static CacheKeyLock.LockAcquisition	acquireReadLock(org.springframework.cache.Cache cache, Object key)
static CacheKeyLock.LockAcquisition	acquireWriteLock(org.springframework.cache.Cache cache, Object key)
static boolean	containsKey(org.springframework.cache.Cache cache, Object key)
static void	evictIf(org.springframework.cache.Cache cache, Predicate<Object> predicate)	Evict entries from the cache where the key matches a given predicate.
static org.springframework.cache.Cache	getCache(org.springframework.cache.CacheManager cacheManager, String cacheName)
static Collection<?>	getKeys(org.springframework.cache.Cache cache)
static int	getSize(org.springframework.cache.Cache cache)

Methods inherited from class Object

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

Constructor Details

CacheUtils

public CacheUtils()

Method Details

getCache

public static org.springframework.cache.Cache getCache(org.springframework.cache.CacheManager cacheManager,
 String cacheName)
                                                throws RuntimeException

Throws:

RuntimeException

getSize

public static int getSize(org.springframework.cache.Cache cache)

containsKey

public static boolean containsKey(org.springframework.cache.Cache cache,
 Object key)

getKeys

public static Collection<?> getKeys(org.springframework.cache.Cache cache)

evictIf

public static void evictIf(org.springframework.cache.Cache cache,
 Predicate<Object> predicate)

Evict entries from the cache where the key matches a given predicate.

If the cache cannot enumerate keys, all entries are cleared.

acquireReadLock

public static CacheKeyLock.LockAcquisition acquireReadLock(org.springframework.cache.Cache cache,
 Object key)
                                                    throws InterruptedException

Throws:

InterruptedException

acquireWriteLock

public static CacheKeyLock.LockAcquisition acquireWriteLock(org.springframework.cache.Cache cache,
 Object key)
                                                     throws InterruptedException

Throws:

InterruptedException