org.hibernate.cache.infinispan.access

Class TransactionalAccessDelegate

java.lang.Object

org.hibernate.cache.infinispan.access.TransactionalAccessDelegate

public 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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
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(Object key, long txTimestamp) Attempt to retrieve an object from the cache.
boolean	insert(Object key, Object value, Object version) Called after an item has been inserted (before the transaction completes), instead of calling evict().
boolean	putFromLoad(Object key, Object value, long txTimestamp, Object version) Attempt to cache an object, after loading from the database.
boolean	putFromLoad(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(Object key) Called after an item has become stale (before the transaction completes).
void	removeAll() Called to evict data from the entire region
boolean	update(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

Constructor Detail

TransactionalAccessDelegate

public 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

get

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

Attempt to retrieve an object from the cache.

Parameters:

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(Object key,
                  Object value,
                  long txTimestamp,
                  Object version)

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

Parameters:

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(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:

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 boolean insert(Object key,
             Object value,
             Object version)
               throws CacheException

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

Parameters:

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 boolean update(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:

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(Object key)
            throws CacheException

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

Parameters:

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