Class TransactionAwareCacheDecorator
- java.lang.Object
- org.springframework.cache.transaction.TransactionAwareCacheDecorator
- All Implemented Interfaces:
Cache
public class TransactionAwareCacheDecorator extends Object implements Cache
Cache decorator which synchronizes itsput(java.lang.Object, java.lang.Object)
,evict(java.lang.Object)
andclear()
operations with Spring-managed transactions (through Spring'sTransactionSynchronizationManager
, performing the actual cache put/evict/clear operation only in the after-commit phase of a successful transaction. If no transaction is active,put(java.lang.Object, java.lang.Object)
,evict(java.lang.Object)
andclear()
operations will be performed immediately, as usual.Note: Use of immediate operations such as
putIfAbsent(java.lang.Object, java.lang.Object)
cannot be deferred to the after-commit phase of a running transaction. Use these with care in a transactional environment.- Since:
- 3.2
- Author:
- Juergen Hoeller, Stephane Nicoll, Stas Volsky
- See Also:
TransactionAwareCacheManagerProxy
Nested Class Summary
Nested classes/interfaces inherited from interface org.springframework.cache.Cache
Cache.ValueRetrievalException, Cache.ValueWrapper
Constructor Summary
Constructors Constructor Description TransactionAwareCacheDecorator(Cache targetCache)
Create a new TransactionAwareCache for the given target Cache.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Remove all mappings from the cache.void
evict(Object key)
Evict the mapping for this key from this cache if it is present.Cache.ValueWrapper
get(Object key)
Return the value to which this cache maps the specified key.<T> T
get(Object key, Class<T> type)
Return the value to which this cache maps the specified key, generically specifying a type that return value will be cast to.<T> T
get(Object key, Callable<T> valueLoader)
Return the value to which this cache maps the specified key, obtaining that value fromvalueLoader
if necessary.String
getName()
Return the cache name.Object
getNativeCache()
Return the underlying native cache provider.Cache
getTargetCache()
Return the target Cache that this Cache should delegate to.void
put(Object key, Object value)
Associate the specified value with the specified key in this cache.Cache.ValueWrapper
putIfAbsent(Object key, Object value)
Atomically associate the specified value with the specified key in this cache if it is not set already.
Constructor Detail
TransactionAwareCacheDecorator
public TransactionAwareCacheDecorator(Cache targetCache)
Create a new TransactionAwareCache for the given target Cache.- Parameters:
targetCache
- the target Cache to decorate
Method Detail
getTargetCache
public Cache getTargetCache()
Return the target Cache that this Cache should delegate to.
getNativeCache
public Object getNativeCache()
Description copied from interface:Cache
Return the underlying native cache provider.- Specified by:
getNativeCache
in interfaceCache
get
public Cache.ValueWrapper get(Object key)
Description copied from interface:Cache
Return the value to which this cache maps the specified key.Returns
null
if the cache contains no mapping for this key; otherwise, the cached value (which may benull
itself) will be returned in aCache.ValueWrapper
.- Specified by:
get
in interfaceCache
- Parameters:
key
- the key whose associated value is to be returned- Returns:
- the value to which this cache maps the specified key, contained within a
Cache.ValueWrapper
which may also hold a cachednull
value. A straightnull
being returned means that the cache contains no mapping for this key. - See Also:
Cache.get(Object, Class)
get
public <T> T get(Object key, Class<T> type)
Description copied from interface:Cache
Return the value to which this cache maps the specified key, generically specifying a type that return value will be cast to.Note: This variant of
get
does not allow for differentiating between a cachednull
value and no cache entry found at all. Use the standardCache.get(Object)
variant for that purpose instead.- Specified by:
get
in interfaceCache
- Parameters:
key
- the key whose associated value is to be returnedtype
- the required type of the returned value (may benull
to bypass a type check; in case of anull
value found in the cache, the specified type is irrelevant)- Returns:
- the value to which this cache maps the specified key (which may be
null
itself), or alsonull
if the cache contains no mapping for this key - See Also:
Cache.get(Object)
get
public <T> T get(Object key, Callable<T> valueLoader)
Description copied from interface:Cache
Return the value to which this cache maps the specified key, obtaining that value fromvalueLoader
if necessary. This method provides a simple substitute for the conventional "if cached, return; otherwise create, cache and return" pattern.If possible, implementations should ensure that the loading operation is synchronized so that the specified
valueLoader
is only called once in case of concurrent access on the same key.If the
valueLoader
throws an exception, it is wrapped in aCache.ValueRetrievalException
put
public void put(Object key, Object value)
Description copied from interface:Cache
Associate the specified value with the specified key in this cache.If the cache previously contained a mapping for this key, the old value is replaced by the specified value.
putIfAbsent
public Cache.ValueWrapper putIfAbsent(Object key, Object value)
Description copied from interface:Cache
Atomically associate the specified value with the specified key in this cache if it is not set already.This is equivalent to:
except that the action is performed atomically. While all out-of-the-boxObject existingValue = cache.get(key); if (existingValue == null) { cache.put(key, value); return null; } else { return existingValue; }
CacheManager
implementations are able to perform the put atomically, the operation may also be implemented in two steps, e.g. with a check for presence and a subsequent put, in a non-atomic way. Check the documentation of the native cache implementation that you are using for more details.- Specified by:
putIfAbsent
in interfaceCache
- Parameters:
key
- the key with which the specified value is to be associatedvalue
- the value to be associated with the specified key- Returns:
- the value to which this cache maps the specified key (which may be
null
itself), or alsonull
if the cache did not contain any mapping for that key prior to this call. Returningnull
is therefore an indicator that the givenvalue
has been associated with the key.
evict
public void evict(Object key)
Description copied from interface:Cache
Evict the mapping for this key from this cache if it is present.