org.hibernate.cache

Class TransactionalCache

java.lang.Object

org.hibernate.cache.TransactionalCache

All Implemented Interfaces:

CacheConcurrencyStrategy

public class TransactionalCache
extends java.lang.Object
implements CacheConcurrencyStrategy

Support for fully transactional cache implementations like JBoss TreeCache. Note that this might be a less scalable concurrency strategy than ReadWriteCache. This is a "synchronous" concurrency strategy.

Author:

Gavin King

Constructor Summary

Constructors

Constructor and Description
TransactionalCache()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	afterInsert(java.lang.Object key, java.lang.Object value, java.lang.Object version) Do nothing.
boolean	afterUpdate(java.lang.Object key, java.lang.Object value, java.lang.Object version, SoftLock clientLock) Do nothing.
void	clear() Evict all items from the cache immediately.
void	destroy() Clean up all resources.
void	evict(java.lang.Object key) Called after an item has become stale (before the transaction completes).
java.lang.Object	get(java.lang.Object key, long txTimestamp) Attempt to retrieve an object from the cache.
Cache	getCache() Get the wrapped cache implementation
java.lang.String	getRegionName() Get the cache region name
boolean	insert(java.lang.Object key, java.lang.Object value, java.lang.Object currentVersion) Called after an item has been inserted (before the transaction completes), instead of calling evict().
SoftLock	lock(java.lang.Object key, java.lang.Object version) Do nothing, returning null.
boolean	put(java.lang.Object key, java.lang.Object value, long txTimestamp, java.lang.Object version, java.util.Comparator versionComparator, boolean minimalPut) Attempt to cache an object, after loading from the database.
void	release(java.lang.Object key, SoftLock clientLock) Do nothing.
void	remove(java.lang.Object key) Evict an item from the cache immediately (without regard for transaction isolation).
void	setCache(Cache cache) Set the underlying cache implementation.
java.lang.String	toString()
boolean	update(java.lang.Object key, java.lang.Object value, java.lang.Object currentVersion, java.lang.Object previousVersion) Called after an item has been updated (before the transaction completes), instead of calling evict().

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionalCache

public TransactionalCache()

Method Detail

getRegionName

public java.lang.String getRegionName()

Description copied from interface: CacheConcurrencyStrategy

Get the cache region name

Specified by:

getRegionName in interface CacheConcurrencyStrategy

get

public java.lang.Object get(java.lang.Object key,
                   long txTimestamp)
                     throws CacheException

Description copied from interface: CacheConcurrencyStrategy

Attempt to retrieve an object from the cache. Mainly used in attempting to resolve entities/collections from the second level cache.

Specified by:

get in interface CacheConcurrencyStrategy

txTimestamp - a timestamp prior to the transaction start time

Returns:

the cached object or null

Throws:

CacheException

put

public boolean put(java.lang.Object key,
          java.lang.Object value,
          long txTimestamp,
          java.lang.Object version,
          java.util.Comparator versionComparator,
          boolean minimalPut)
            throws CacheException

Description copied from interface: CacheConcurrencyStrategy

Attempt to cache an object, after loading from the database.

Specified by:

put in interface CacheConcurrencyStrategy

txTimestamp - a timestamp prior to the transaction start time

version - the item version number

versionComparator - a comparator used to compare version numbers

minimalPut - indicates that the cache should avoid a put is the item is already cached

Returns:

true if the object was successfully cached

Throws:

CacheException

lock

public SoftLock lock(java.lang.Object key,
            java.lang.Object version)
              throws CacheException

Do nothing, returning null.

Specified by:

lock in interface CacheConcurrencyStrategy

Throws:

CacheException

release

public void release(java.lang.Object key,
           SoftLock clientLock)
             throws CacheException

Do nothing.

Specified by:

release in interface CacheConcurrencyStrategy

Throws:

CacheException

update

public boolean update(java.lang.Object key,
             java.lang.Object value,
             java.lang.Object currentVersion,
             java.lang.Object previousVersion)
               throws CacheException

Description copied from interface: CacheConcurrencyStrategy

Called after an item has been updated (before the transaction completes), instead of calling evict(). This method is used by "synchronous" concurrency strategies.

Specified by:

update in interface CacheConcurrencyStrategy

Throws:

CacheException

insert

public boolean insert(java.lang.Object key,
             java.lang.Object value,
             java.lang.Object currentVersion)
               throws CacheException

Description copied from interface: CacheConcurrencyStrategy

Called after an item has been inserted (before the transaction completes), instead of calling evict(). This method is used by "synchronous" concurrency strategies.

Specified by:

insert in interface CacheConcurrencyStrategy

Throws:

CacheException

evict

public void evict(java.lang.Object key)
           throws CacheException

Description copied from interface: CacheConcurrencyStrategy

Called after an item has become stale (before the transaction completes). This method is used by "synchronous" concurrency strategies.

Specified by:

evict in interface CacheConcurrencyStrategy

Throws:

CacheException

remove

public void remove(java.lang.Object key)
            throws CacheException

Description copied from interface: CacheConcurrencyStrategy

Evict an item from the cache immediately (without regard for transaction isolation).

Specified by:

remove in interface CacheConcurrencyStrategy

Throws:

CacheException

clear

public void clear()
           throws CacheException

Description copied from interface: CacheConcurrencyStrategy

Evict all items from the cache immediately.

Specified by:

clear in interface CacheConcurrencyStrategy

Throws:

CacheException

destroy

public void destroy()

Description copied from interface: CacheConcurrencyStrategy

Clean up all resources.

Specified by:

destroy in interface CacheConcurrencyStrategy

setCache

public void setCache(Cache cache)

Description copied from interface: CacheConcurrencyStrategy

Set the underlying cache implementation.

Specified by:

setCache in interface CacheConcurrencyStrategy

getCache

public Cache getCache()

Description copied from interface: CacheConcurrencyStrategy

Get the wrapped cache implementation

Specified by:

getCache in interface CacheConcurrencyStrategy

afterInsert

public boolean afterInsert(java.lang.Object key,
                  java.lang.Object value,
                  java.lang.Object version)
                    throws CacheException

Do nothing.

Specified by:

afterInsert in interface CacheConcurrencyStrategy

Throws:

CacheException

afterUpdate

public boolean afterUpdate(java.lang.Object key,
                  java.lang.Object value,
                  java.lang.Object version,
                  SoftLock clientLock)
                    throws CacheException

Do nothing.

Specified by:

afterUpdate in interface CacheConcurrencyStrategy

Throws:

CacheException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object