org.hibernate.testing.cache

Class EntityRegionImpl

java.lang.Object

org.hibernate.testing.cache.BaseRegion

org.hibernate.testing.cache.EntityRegionImpl

All Implemented Interfaces:

EntityRegion, GeneralDataRegion, Region, TransactionalDataRegion

public class EntityRegionImpl
extends BaseRegion
implements EntityRegion

Field Summary

Fields inherited from class org.hibernate.testing.cache.BaseRegion

cache

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntityRegionImpl(CachingRegionFactory cachingRegionFactory, java.lang.String name, CacheDataDescription metadata, SessionFactoryOptions settings)

Method Summary

Modifier and Type	Method and Description
EntityRegionAccessStrategy	buildAccessStrategy(AccessType accessType) Build an access strategy for the requested access type.
void	evict(java.lang.Object key) Evict an item from the cache immediately (without regard for transaction isolation).
void	evictAll() Evict all contents of this particular cache region (without regard for transaction isolation).
java.lang.Object	get(SessionImplementor session, java.lang.Object key) Get an item from the cache.
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
SessionFactoryOptions	getSettings()
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.
void	put(SessionImplementor session, java.lang.Object key, java.lang.Object value) Put an item into the cache.

Methods inherited from class org.hibernate.testing.cache.BaseRegion

contains, destroy, getDataMap, getElementCountInMemory, getElementCountOnDisk, getName, getRegionFactory, 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.TransactionalDataRegion

getCacheDataDescription, isTransactionAware

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

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

Constructor Detail

EntityRegionImpl

protected EntityRegionImpl(CachingRegionFactory cachingRegionFactory,
                           java.lang.String name,
                           CacheDataDescription metadata,
                           SessionFactoryOptions settings)

Method Detail

getSettings

public SessionFactoryOptions getSettings()

buildAccessStrategy

public EntityRegionAccessStrategy buildAccessStrategy(AccessType accessType)
                                               throws CacheException

Description copied from interface: EntityRegion

Build an access strategy for the requested access type.

Specified by:

buildAccessStrategy in interface EntityRegion

Parameters:

accessType - The type of access strategy to build; never null.

Returns:

The appropriate strategy contract for accessing this region for the requested type of access.

Throws:

CacheException - Usually indicates mis-configuration.

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.

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.

get

public java.lang.Object get(SessionImplementor session,
                            java.lang.Object key)
                     throws CacheException

Description copied from interface: GeneralDataRegion

Get an item from the cache.

Specified by:

get in interface GeneralDataRegion

key - The key of the item to be retrieved.

Returns:

the cached object or null

Throws:

CacheException - Indicates a problem accessing the item or region.

put

public void put(SessionImplementor session,
                java.lang.Object key,
                java.lang.Object value)
         throws CacheException

Description copied from interface: GeneralDataRegion

Put an item into the cache.

Specified by:

put in interface GeneralDataRegion

key - The key under which to cache the item.

value - The item to cache.

Throws:

CacheException - Indicates a problem accessing the region.

evict

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

Description copied from interface: GeneralDataRegion

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

Specified by:

evict in interface GeneralDataRegion

Parameters:

key - The key of the item to remove

Throws:

CacheException - Indicates a problem accessing the item or region.

evictAll

public void evictAll()
              throws CacheException

Description copied from interface: GeneralDataRegion

Evict all contents of this particular cache region (without regard for transaction isolation).

Specified by:

evictAll in interface GeneralDataRegion

Throws:

CacheException - Indicates problem accessing the region.