org.hibernate.cache.infinispan.access

Class TransactionalAccessDelegate

java.lang.Object

org.hibernate.cache.infinispan.access.TransactionalAccessDelegate

Direct Known Subclasses:

NonTxTransactionalAccessDelegate, TxTransactionalAccessDelegate

public abstract class TransactionalAccessDelegate
extends Object

Defines the strategy for transactional access to entity or collection data in a Infinispan instance.

The intent of this class is to encapsulate common code and serve as a delegate for EntityRegionAccessStrategy and CollectionRegionAccessStrategy implementations.

Since:

3.5

Field Summary

Fields

Modifier and Type	Field and Description
protected org.infinispan.AdvancedCache	cache
protected static org.infinispan.util.logging.Log	log
protected PutFromLoadValidator	putValidator
protected BaseRegion	region
protected static boolean	TRACE_ENABLED
protected org.infinispan.AdvancedCache<Object,Object>	writeCache

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TransactionalAccessDelegate(BaseRegion region, PutFromLoadValidator validator) Create a new transactional access delegate instance.

Method Summary

Modifier and Type	Method and Description
boolean	afterInsert(SessionImplementor session, Object key, Object value, Object version) Called after an item has been inserted (after the transaction completes), instead of calling release().
boolean	afterUpdate(SessionImplementor session, Object key, Object value, Object currentVersion, Object previousVersion, SoftLock lock) Called after an item has been updated (after the transaction completes), instead of calling release().
static TransactionalAccessDelegate	create(BaseRegion region, PutFromLoadValidator validator)
void	evict(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.
Object	get(SessionImplementor session, Object key, long txTimestamp) Attempt to retrieve an object from the cache.
abstract boolean	insert(SessionImplementor session, Object key, Object value, Object version) Called after an item has been inserted (before the transaction completes), instead of calling evict().
boolean	putFromLoad(SessionImplementor session, Object key, Object value, long txTimestamp, Object version) Attempt to cache an object, after loading from the database.
boolean	putFromLoad(SessionImplementor session, Object key, Object value, long txTimestamp, Object version, boolean minimalPutOverride) Attempt to cache an object, after loading from the database, explicitly specifying the minimalPut behavior.
void	remove(SessionImplementor session, Object key) Called after an item has become stale (before the transaction completes).
void	removeAll() Called to evict data from the entire region
void	unlockItem(SessionImplementor session, Object key) Called when we have finished the attempted update/delete (which may or may not have been successful), after transaction completion.
abstract boolean	update(SessionImplementor session, Object key, Object value, Object currentVersion, Object previousVersion) Called after an item has been updated (before the transaction completes), instead of calling evict().

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.infinispan.util.logging.Log log

TRACE_ENABLED

protected static final boolean TRACE_ENABLED

cache

protected final org.infinispan.AdvancedCache cache

region

protected final BaseRegion region

putValidator

protected final PutFromLoadValidator putValidator

writeCache

protected final org.infinispan.AdvancedCache<Object,Object> writeCache

Constructor Detail

TransactionalAccessDelegate

protected TransactionalAccessDelegate(BaseRegion region,
                                      PutFromLoadValidator validator)

Create a new transactional access delegate instance.

Parameters:

region - to control access to

validator - put from load validator

Method Detail

create

public static TransactionalAccessDelegate create(BaseRegion region,
                                                 PutFromLoadValidator validator)

get

public Object get(SessionImplementor session,
                  Object key,
                  long txTimestamp)
           throws CacheException

Attempt to retrieve an object from the cache.

Parameters:

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 - if the cache retrieval failed

putFromLoad

public boolean putFromLoad(SessionImplementor session,
                           Object key,
                           Object value,
                           long txTimestamp,
                           Object version)

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

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

putFromLoad

public boolean putFromLoad(SessionImplementor session,
                           Object key,
                           Object value,
                           long txTimestamp,
                           Object version,
                           boolean minimalPutOverride)
                    throws CacheException

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

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 - if storing the object failed

insert

public abstract boolean insert(SessionImplementor session,
                               Object key,
                               Object value,
                               Object version)
                        throws CacheException

Called after an item has been inserted (before the transaction completes), instead of calling evict().

Parameters:

session - Current session

key - The item key

value - The item

version - The item's version value

Returns:

Were the contents of the cache actual changed by this operation?

Throws:

CacheException - if the insert fails

update

public abstract boolean update(SessionImplementor session,
                               Object key,
                               Object value,
                               Object currentVersion,
                               Object previousVersion)
                        throws CacheException

Called after an item has been updated (before the transaction completes), instead of calling evict().

Parameters:

session - Current session

key - The item key

value - The item

currentVersion - The item's current version value

previousVersion - The item's previous version value

Returns:

Whether the contents of the cache actual changed by this operation

Throws:

CacheException - if the update fails

remove

public void remove(SessionImplementor session,
                   Object key)
            throws CacheException

Called after an item has become stale (before the transaction completes).

Parameters:

session - Current session

key - The key of the item to remove

Throws:

CacheException - if removing the cached item fails

removeAll

public void removeAll()
               throws CacheException

Called to evict data from the entire region

Throws:

CacheException - if eviction the region fails

evict

public void evict(Object key)
           throws CacheException

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

Parameters:

key - The key of the item to remove

Throws:

CacheException - if evicting the item fails

evictAll

public void evictAll()
              throws CacheException

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

Throws:

CacheException - if evicting items fails

unlockItem

public void unlockItem(SessionImplementor session,
                       Object key)
                throws CacheException

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.

Parameters:

session -

key - The item key

Throws:

CacheException - Propogated from underlying Region

afterInsert

public boolean afterInsert(SessionImplementor session,
                           Object key,
                           Object value,
                           Object version)

Called after an item has been inserted (after the transaction completes), instead of calling release(). This method is used by "asynchronous" concurrency strategies.

Parameters:

session -

key - The item key

value - The item

version - The item's version value

Returns:

Were the contents of the cache actual changed by this operation?

Throws:

CacheException - Propagated from underlying Region

afterUpdate

public boolean afterUpdate(SessionImplementor session,
                           Object key,
                           Object value,
                           Object currentVersion,
                           Object previousVersion,
                           SoftLock lock)

Called after an item has been updated (after the transaction completes), instead of calling release(). This method is used by "asynchronous" concurrency strategies.

Parameters:

session -

key - The item key

value - The item

currentVersion - The item's current version value

previousVersion - The item's previous version value

lock - The lock previously obtained from #lockItem

Returns:

Were the contents of the cache actual changed by this operation?

Throws:

CacheException - Propagated from underlying Region