org.hibernate.testing.cache

Class EntityRegionImpl

java.lang.Object

org.hibernate.testing.cache.EntityRegionImpl

All Implemented Interfaces:

EntityRegion, GeneralDataRegion, Region, TransactionalDataRegion

public class EntityRegionImpl
extends Object
implements EntityRegion

Field Summary

Fields

Modifier and Type	Field and Description
protected Map	cache

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntityRegionImpl(CachingRegionFactory cachingRegionFactory, 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.
boolean	contains(Object key) Determine whether this region contains data for the given key.
void	destroy() The "end state" contract of the region's lifecycle.
void	evict(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).
Object	get(SessionImplementor session, 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
long	getElementCountInMemory() The count of entries currently contained in the regions in-memory store.
long	getElementCountOnDisk() The count of entries currently contained in the regions disk store.
String	getName() Retrieve the name of this region.
CachingRegionFactory	getRegionFactory()
SessionFactoryOptions	getSettings()
long	getSizeInMemory() The number of bytes is this cache region currently consuming in memory.
int	getTimeout() Get a timeout value.
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.
long	nextTimestamp() Get the next timestamp according to the underlying cache implementor.
void	put(SessionImplementor session, Object key, Object value) Put an item into the cache.
Map	toMap() Get the contents of this region as a map.

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

Field Detail

cache

protected final Map cache

Constructor Detail

EntityRegionImpl

protected EntityRegionImpl(CachingRegionFactory cachingRegionFactory,
                           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 Object get(SessionImplementor session,
                  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,
                Object key,
                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(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.

contains

public boolean contains(Object key)

Description copied from interface: Region

Determine whether this region contains data for the given key.

The semantic here is whether the cache contains data visible for the current call context. This should be viewed as a "best effort", meaning blocking should be avoid if possible.

Specified by:

contains in interface Region

Parameters:

key - The cache key

Returns:

True if the underlying cache contains corresponding data; false otherwise.

getRegionFactory

public CachingRegionFactory getRegionFactory()

getName

public String getName()

Description copied from interface: Region

Retrieve the name of this region.

Specified by:

getName in interface Region

Returns:

The region name

destroy

public void destroy()
             throws CacheException

Description copied from interface: Region

The "end state" contract of the region's lifecycle. Called during SessionFactory.close() to give the region a chance to cleanup.

Specified by:

destroy in interface Region

Throws:

CacheException - Indicates problem shutting down

getSizeInMemory

public long getSizeInMemory()

Description copied from interface: Region

The number of bytes is this cache region currently consuming in memory.

Specified by:

getSizeInMemory in interface Region

Returns:

The number of bytes consumed by this region; -1 if unknown or unsupported.

getElementCountInMemory

public long getElementCountInMemory()

Description copied from interface: Region

The count of entries currently contained in the regions in-memory store.

Specified by:

getElementCountInMemory in interface Region

Returns:

The count of entries in memory; -1 if unknown or unsupported.

getElementCountOnDisk

public long getElementCountOnDisk()

Description copied from interface: Region

The count of entries currently contained in the regions disk store.

Specified by:

getElementCountOnDisk in interface Region

Returns:

The count of entries on disk; -1 if unknown or unsupported.

toMap

public Map toMap()

Description copied from interface: Region

Get the contents of this region as a map.

Implementors which do not support this notion should simply return an empty map.

Specified by:

toMap in interface Region

Returns:

The content map.

nextTimestamp

public long nextTimestamp()

Description copied from interface: Region

Get the next timestamp according to the underlying cache implementor.

Specified by:

nextTimestamp in interface Region

Returns:

The next timestamp

getTimeout

public int getTimeout()

Description copied from interface: Region

Get a timeout value.

Specified by:

getTimeout in interface Region

Returns:

The time out value