org.springframework.cache.transaction

Class TransactionAwareCacheDecorator

java.lang.Object

org.springframework.cache.transaction.TransactionAwareCacheDecorator

All Implemented Interfaces:

Cache

public class TransactionAwareCacheDecorator
extends java.lang.Object
implements Cache

Cache decorator which synchronizes its put(java.lang.Object, java.lang.Object), evict(java.lang.Object) and clear() operations with Spring-managed transactions (through Spring's TransactionSynchronizationManager, 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) and clear() operations will be performed immediately, as usual.

Use of more aggressive 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.

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

Field Summary

Fields

Modifier and Type	Field and Description
private Cache	targetCache

Constructor Summary

Constructors

Constructor and Description
TransactionAwareCacheDecorator(Cache targetCache) Create a new TransactionAwareCache for the given target Cache.

Method Summary

Modifier and Type	Method and Description
void	clear() Remove all mappings from the cache.
void	evict(java.lang.Object key) Evict the mapping for this key from this cache if it is present.
Cache.ValueWrapper	get(java.lang.Object key) Return the value to which this cache maps the specified key.
<T> T	get(java.lang.Object key, java.lang.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.
java.lang.String	getName() Return the cache name.
java.lang.Object	getNativeCache() Return the the underlying native cache provider.
void	put(java.lang.Object key, java.lang.Object value) Associate the specified value with the specified key in this cache.
Cache.ValueWrapper	putIfAbsent(java.lang.Object key, java.lang.Object value) Atomically associate the specified value with the specified key in this cache if it is not set already.

Methods inherited from class java.lang.Object

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

Field Detail

targetCache

private final Cache targetCache

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

getName

public java.lang.String getName()

Description copied from interface: Cache

Return the cache name.

Specified by:

getName in interface Cache

getNativeCache

public java.lang.Object getNativeCache()

Description copied from interface: Cache

Return the the underlying native cache provider.

Specified by:

getNativeCache in interface Cache

get

public Cache.ValueWrapper get(java.lang.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 be null itself) will be returned in a Cache.ValueWrapper.

Specified by:

get in interface Cache

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 cached null value. A straight null being returned means that the cache contains no mapping for this key.

See Also:

Cache.get(Object, Class)

get

public <T> T get(java.lang.Object key,
                 java.lang.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 cached null value and no cache entry found at all. Use the standard Cache.get(Object) variant for that purpose instead.

Specified by:

get in interface Cache

Parameters:

key - the key whose associated value is to be returned

type - the required type of the returned value (may be null to bypass a type check; in case of a null 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 also null if the cache contains no mapping for this key

See Also:

Cache.get(Object)

put

public void put(java.lang.Object key,
                java.lang.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.

Specified by:

put in interface Cache

Parameters:

key - the key with which the specified value is to be associated

value - the value to be associated with the specified key

putIfAbsent

public Cache.ValueWrapper putIfAbsent(java.lang.Object key,
                                      java.lang.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:

 Object existingValue = cache.get(key);
 if (existingValue == null) {
     cache.put(key, value);
     return null;
 } else {
     return existingValue;
 }
 

except that the action is performed atomically. While all out-of-the-box 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 interface Cache

Parameters:

key - the key with which the specified value is to be associated

value - 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 also null if the cache did not contain any mapping for that key prior to this call. Returning null is therefore an indicator that the given value has been associated with the key.

evict

public void evict(java.lang.Object key)

Description copied from interface: Cache

Evict the mapping for this key from this cache if it is present.

Specified by:

evict in interface Cache

Parameters:

key - the key whose mapping is to be removed from the cache

clear

public void clear()

Description copied from interface: Cache

Remove all mappings from the cache.

Specified by:

clear in interface Cache