org.hibernate.testing.cache

Class BaseRegionAccessStrategy

java.lang.Object

org.hibernate.testing.cache.BaseRegionAccessStrategy

All Implemented Interfaces:

RegionAccessStrategy

Direct Known Subclasses:

AbstractReadWriteAccessStrategy

public abstract class BaseRegionAccessStrategy
extends java.lang.Object
implements RegionAccessStrategy

Constructor Summary

Constructors

Constructor and Description
BaseRegionAccessStrategy()

Method Summary

Modifier and Type	Method and Description
void	evict(java.lang.Object key) Forcibly evict an item from the cache immediately without regard for transaction isolation.
void	evictAll() Forcibly evict all items from the cache immediately without regard for transaction isolation.
java.lang.Object	get(SharedSessionContractImplementor session, java.lang.Object key, long txTimestamp) Attempt to retrieve an object from the cache.
protected abstract org.hibernate.testing.cache.BaseGeneralDataRegion	getInternalRegion()
protected abstract boolean	isDefaultMinimalPutOverride()
SoftLock	lockItem(SharedSessionContractImplementor session, java.lang.Object key, java.lang.Object version) We are going to attempt to update/delete the keyed object.
SoftLock	lockRegion() Region locks are not supported.
boolean	putFromLoad(SharedSessionContractImplementor session, java.lang.Object key, java.lang.Object value, long txTimestamp, java.lang.Object version) Attempt to cache an object, after loading from the database.
boolean	putFromLoad(SharedSessionContractImplementor session, java.lang.Object key, java.lang.Object value, long txTimestamp, java.lang.Object version, boolean minimalPutOverride) Attempt to cache an object, after loading from the database, explicitly specifying the minimalPut behavior.
void	remove(SharedSessionContractImplementor session, java.lang.Object key) A no-op since this is an asynchronous cache access strategy.
void	removeAll() Called to evict data from the entire region
void	unlockItem(SharedSessionContractImplementor session, java.lang.Object key, SoftLock lock) Called when we have finished the attempted update/delete (which may or may not have been successful), after transaction completion.
void	unlockRegion(SoftLock lock) Region locks are not supported - perform a cache clear as a precaution.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseRegionAccessStrategy

public BaseRegionAccessStrategy()

Method Detail

getInternalRegion

protected abstract org.hibernate.testing.cache.BaseGeneralDataRegion getInternalRegion()

isDefaultMinimalPutOverride

protected abstract boolean isDefaultMinimalPutOverride()

get

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

Description copied from interface: RegionAccessStrategy

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 RegionAccessStrategy

Parameters:

session - Current session.

key - The key of the item to be retrieved.

txTimestamp - a timestamp prior to the transaction start time

Returns:

the cached object or null

Throws:

CacheException - Propogated from underlying Region

putFromLoad

public boolean putFromLoad(SharedSessionContractImplementor session,
                           java.lang.Object key,
                           java.lang.Object value,
                           long txTimestamp,
                           java.lang.Object version)
                    throws CacheException

Description copied from interface: RegionAccessStrategy

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

Specified by:

putFromLoad in interface RegionAccessStrategy

Parameters:

session - Current session.

key - The item key

value - The item

txTimestamp - a timestamp prior to the transaction start time

version - the item version number

Returns:

true if the object was successfully cached

Throws:

CacheException - Propogated from underlying Region

putFromLoad

public boolean putFromLoad(SharedSessionContractImplementor session,
                           java.lang.Object key,
                           java.lang.Object value,
                           long txTimestamp,
                           java.lang.Object version,
                           boolean minimalPutOverride)
                    throws CacheException

Description copied from interface: RegionAccessStrategy

Attempt to cache an object, after loading from the database, explicitly specifying the minimalPut behavior.

Specified by:

putFromLoad in interface RegionAccessStrategy

Parameters:

session - Current session.

key - The item key

value - The item

txTimestamp - a timestamp prior to the transaction start time

version - the item version number

minimalPutOverride - Explicit minimalPut flag

Returns:

true if the object was successfully cached

Throws:

CacheException - Propogated from underlying Region

lockRegion

public SoftLock lockRegion()
                    throws CacheException

Region locks are not supported.

Specified by:

lockRegion in interface RegionAccessStrategy

Returns:

null

Throws:

CacheException - Propogated from underlying Region

See Also:

RegionAccessStrategy.lockRegion(), RegionAccessStrategy.lockRegion()

unlockRegion

public void unlockRegion(SoftLock lock)
                  throws CacheException

Region locks are not supported - perform a cache clear as a precaution.

Specified by:

unlockRegion in interface RegionAccessStrategy

Parameters:

lock - The lock previously obtained from RegionAccessStrategy.lockRegion()

Throws:

CacheException - Propogated from underlying Region

See Also:

RegionAccessStrategy.unlockRegion(org.hibernate.cache.spi.access.SoftLock), RegionAccessStrategy.unlockRegion(org.hibernate.cache.spi.access.SoftLock)

lockItem

public SoftLock lockItem(SharedSessionContractImplementor session,
                         java.lang.Object key,
                         java.lang.Object version)
                  throws CacheException

Description copied from interface: RegionAccessStrategy

We are going to attempt to update/delete the keyed object. This method is used by "asynchronous" concurrency strategies.

The returned object must be passed back to RegionAccessStrategy.unlockItem(org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object, org.hibernate.cache.spi.access.SoftLock), to release the lock. Concurrency strategies which do not support client-visible locks may silently return null.

Specified by:

lockItem in interface RegionAccessStrategy

Parameters:

session - Current session.

key - The key of the item to lock

version - The item's current version value

Returns:

A representation of our lock on the item; or null.

Throws:

CacheException - Propogated from underlying Region

unlockItem

public void unlockItem(SharedSessionContractImplementor session,
                       java.lang.Object key,
                       SoftLock lock)
                throws CacheException

Description copied from interface: RegionAccessStrategy

Called when we have finished the attempted update/delete (which may or may not have been successful), after transaction completion. This method is used by "asynchronous" concurrency strategies.

Specified by:

unlockItem in interface RegionAccessStrategy

Parameters:

session - Current session.

key - The item key

lock - The lock previously obtained from RegionAccessStrategy.lockItem(org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object, java.lang.Object)

Throws:

CacheException - Propogated from underlying Region

remove

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

A no-op since this is an asynchronous cache access strategy.

Specified by:

remove in interface RegionAccessStrategy

key - The key of the item to remove

Throws:

CacheException - Propogated from underlying Region

See Also:

RegionAccessStrategy.remove(SharedSessionContractImplementor, Object)

removeAll

public void removeAll()
               throws CacheException

Called to evict data from the entire region

Specified by:

removeAll in interface RegionAccessStrategy

Throws:

CacheException - Propogated from underlying Region

See Also:

RegionAccessStrategy.removeAll(), RegionAccessStrategy.removeAll()

evict

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

Description copied from interface: RegionAccessStrategy

Forcibly evict an item from the cache immediately without regard for transaction isolation.

Specified by:

evict in interface RegionAccessStrategy

Parameters:

key - The key of the item to remove

Throws:

CacheException - Propogated from underlying Region

evictAll

public void evictAll()
              throws CacheException

Description copied from interface: RegionAccessStrategy

Forcibly evict all items from the cache immediately without regard for transaction isolation.

Specified by:

evictAll in interface RegionAccessStrategy

Throws:

CacheException - Propogated from underlying Region