org.hibernate.cache.ehcache.internal.regions

Class EhcacheTransactionalDataRegion

java.lang.Object

org.hibernate.cache.ehcache.internal.regions.EhcacheDataRegion

org.hibernate.cache.ehcache.internal.regions.EhcacheTransactionalDataRegion

All Implemented Interfaces:

Region, TransactionalDataRegion

Direct Known Subclasses:

EhcacheCollectionRegion, EhcacheEntityRegion, EhcacheNaturalIdRegion

public class EhcacheTransactionalDataRegion
extends EhcacheDataRegion
implements TransactionalDataRegion

An Ehcache specific TransactionalDataRegion.

This is the common superclass entity and collection regions.

Field Summary

Fields

Modifier and Type	Field and Description
protected CacheDataDescription	metadata Metadata associated with the objects stored in the region.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Remove all mapping from this cache region.
Object	get(Object key) Get the value mapped to this key, or null if no value is mapped to this key.
CacheDataDescription	getCacheDataDescription() Get the description of the type of data to be stored here, which would have been given to the RegionFactory when creating this region
Settings	getSettings() Access the Hibernate settings associated with the persistence unit.
boolean	isTransactionAware() Is the underlying cache implementation aware of (and "participating in") ongoing JTA transactions? Regions which report that they are transaction-aware are considered "synchronous", in that we assume we can immediately (i.e.
boolean	locksAreIndependentOfCache() Returns true if the locks used by the locking methods of this region are the independent of the cache.
void	put(Object key, Object value) Map the given value to the given key, replacing any existing mapping for this key
void	readLock(Object key) Attempts to read lock the mapping for the given key.
void	readUnlock(Object key) Attempts to read unlock the mapping for the given key.
void	remove(Object key) Remove the mapping for this key (if any exists).
void	writeLock(Object key) Attempts to write lock the mapping for the given key.
void	writeUnlock(Object key) Attempts to write unlock the mapping for the given key.

Methods inherited from class org.hibernate.cache.ehcache.internal.regions.EhcacheDataRegion

contains, destroy, getAccessStrategyFactory, getCache, getEhcache, getElementCountInMemory, getElementCountOnDisk, getName, getSizeInMemory, getTimeout, nextTimestamp, toMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.cache.spi.Region

contains, destroy, getElementCountInMemory, getElementCountOnDisk, getName, getSizeInMemory, getTimeout, nextTimestamp, toMap

Field Detail

metadata

protected final CacheDataDescription metadata

Metadata associated with the objects stored in the region.

Method Detail

getSettings

public Settings getSettings()

Access the Hibernate settings associated with the persistence unit.

Returns:

settings

isTransactionAware

public boolean isTransactionAware()

Description copied from interface: TransactionalDataRegion

Is the underlying cache implementation aware of (and "participating in") ongoing JTA transactions?

Regions which report that they are transaction-aware are considered "synchronous", in that we assume we can immediately (i.e. synchronously) write the changes to the cache and that the cache will properly manage application of the written changes within the bounds of ongoing JTA transactions. Conversely, regions reporting false are considered "asynchronous", where it is assumed that changes must be manually delayed by Hibernate until we are certain that the current transaction is successful (i.e. maintaining READ_COMMITTED isolation).

Specified by:

isTransactionAware in interface TransactionalDataRegion

Returns:

True if transaction aware; false otherwise.

getCacheDataDescription

public CacheDataDescription getCacheDataDescription()

Description copied from interface: TransactionalDataRegion

Get the description of the type of data to be stored here, which would have been given to the RegionFactory when creating this region

Specified by:

getCacheDataDescription in interface TransactionalDataRegion

Returns:

The data descriptor.

get

public final Object get(Object key)

Get the value mapped to this key, or null if no value is mapped to this key.

Parameters:

key - The cache key

Returns:

The cached data

put

public final void put(Object key,
       Object value)
               throws CacheException

Map the given value to the given key, replacing any existing mapping for this key

Parameters:

key - The cache key

value - The data to cache

Throws:

CacheException - Indicates a problem accessing the cache

remove

public final void remove(Object key)
                  throws CacheException

Remove the mapping for this key (if any exists).

Parameters:

key - The cache key

Throws:

CacheException - Indicates a problem accessing the cache

clear

public final void clear()
                 throws CacheException

Remove all mapping from this cache region.

Throws:

CacheException - Indicates a problem accessing the cache

writeLock

public final void writeLock(Object key)
                     throws CacheException

Attempts to write lock the mapping for the given key.

Parameters:

key - The cache key

Throws:

CacheException - Indicates a problem accessing the cache

writeUnlock

public final void writeUnlock(Object key)
                       throws CacheException

Attempts to write unlock the mapping for the given key.

Parameters:

key - The cache key

Throws:

CacheException - Indicates a problem accessing the cache

readLock

public final void readLock(Object key)
                    throws CacheException

Attempts to read lock the mapping for the given key.

Parameters:

key - The cache key

Throws:

CacheException - Indicates a problem accessing the cache

readUnlock

public final void readUnlock(Object key)
                      throws CacheException

Attempts to read unlock the mapping for the given key.

Parameters:

key - The cache key

Throws:

CacheException - Indicates a problem accessing the cache

locksAreIndependentOfCache

public final boolean locksAreIndependentOfCache()

Returns true if the locks used by the locking methods of this region are the independent of the cache.

Independent locks are not locked by the cache when the cache is accessed directly. This means that for an independent lock lock holds taken through a region method will not block direct access to the cache via other means.

Returns:

true/false. See discussion above.