org.hibernate.testing.cache

Class AbstractReadWriteAccessStrategy

java.lang.Object

org.hibernate.testing.cache.BaseRegionAccessStrategy

org.hibernate.testing.cache.AbstractReadWriteAccessStrategy

All Implemented Interfaces:

RegionAccessStrategy

Direct Known Subclasses:

ReadWriteEntityRegionAccessStrategy

public abstract class AbstractReadWriteAccessStrategy
extends BaseRegionAccessStrategy

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractReadWriteAccessStrategy.Item Wrapper type representing unlocked items.
static class	AbstractReadWriteAccessStrategy.Lock Wrapper type representing locked items.
static interface	AbstractReadWriteAccessStrategy.Lockable Interface type implemented by all wrapper objects in the cache.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.locks.Lock	readLock
protected java.util.concurrent.locks.Lock	writeLock

Constructor Summary

Constructors

Constructor and Description
AbstractReadWriteAccessStrategy()

Method Summary

Modifier and Type	Method and Description
protected void	decrementLock(SharedSessionContractImplementor session, java.lang.Object key, AbstractReadWriteAccessStrategy.Lock lock) Unlock and re-put the given key, lock combination.
java.lang.Object	get(SharedSessionContractImplementor session, java.lang.Object key, long txTimestamp) Returns null if the item is not readable.
protected void	handleLockExpiry(SharedSessionContractImplementor session, java.lang.Object key, AbstractReadWriteAccessStrategy.Lockable lock) Handle the timeout of a previous lock mapped to this key
SoftLock	lockItem(SharedSessionContractImplementor session, java.lang.Object key, java.lang.Object version) Soft-lock a cache item.
boolean	putFromLoad(SharedSessionContractImplementor session, java.lang.Object key, java.lang.Object value, long txTimestamp, java.lang.Object version, boolean minimalPutOverride) Returns false and fails to put the value if there is an existing un-writeable item mapped to this key.
void	unlockItem(SharedSessionContractImplementor session, java.lang.Object key, SoftLock lock) Soft-unlock a cache item.

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

evict, evictAll, getInternalRegion, isDefaultMinimalPutOverride, lockRegion, putFromLoad, remove, removeAll, unlockRegion

Methods inherited from class java.lang.Object

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

Field Detail

readLock

protected java.util.concurrent.locks.Lock readLock

writeLock

protected java.util.concurrent.locks.Lock writeLock

Constructor Detail

AbstractReadWriteAccessStrategy

public AbstractReadWriteAccessStrategy()

Method Detail

get

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

Returns null if the item is not readable. Locked items are not readable, nor are items created after the start of this transaction.

Specified by:

get in interface RegionAccessStrategy

Overrides:

get in class BaseRegionAccessStrategy

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 final boolean putFromLoad(SharedSessionContractImplementor session,
                                 java.lang.Object key,
                                 java.lang.Object value,
                                 long txTimestamp,
                                 java.lang.Object version,
                                 boolean minimalPutOverride)
                          throws CacheException

Returns false and fails to put the value if there is an existing un-writeable item mapped to this key.

Specified by:

putFromLoad in interface RegionAccessStrategy

Overrides:

putFromLoad in class BaseRegionAccessStrategy

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

lockItem

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

Soft-lock a cache item.

Specified by:

lockItem in interface RegionAccessStrategy

Overrides:

lockItem in class BaseRegionAccessStrategy

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 final void unlockItem(SharedSessionContractImplementor session,
                             java.lang.Object key,
                             SoftLock lock)
                      throws CacheException

Soft-unlock a cache item.

Specified by:

unlockItem in interface RegionAccessStrategy

Overrides:

unlockItem in class BaseRegionAccessStrategy

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

decrementLock

protected void decrementLock(SharedSessionContractImplementor session,
                             java.lang.Object key,
                             AbstractReadWriteAccessStrategy.Lock lock)

Unlock and re-put the given key, lock combination.

handleLockExpiry

protected void handleLockExpiry(SharedSessionContractImplementor session,
                                java.lang.Object key,
                                AbstractReadWriteAccessStrategy.Lockable lock)

Handle the timeout of a previous lock mapped to this key