Summary: Methods | [Expand All]
public interface

EntityRegionAccessStrategy

org.hibernate.cache.access.EntityRegionAccessStrategy
Known Indirect Subclasses

Class Overview

Contract for managing transactional and concurrent access to cached entity data. The expected call sequences related to various operations are:

There is another usage pattern that is used to invalidate entries after performing "bulk" HQL/SQL operations: lockRegion() -> removeAll() -> unlockRegion(SoftLock)

Summary

Public Methods
abstract boolean afterInsert(Object key, Object value, Object version)
Called after an item has been inserted (after the transaction completes), instead of calling release().
abstract boolean afterUpdate(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().
abstract void evict(Object key)
Forcibly evict an item from the cache immediately without regard for transaction isolation.
abstract void evictAll()
Forcibly evict all items from the cache immediately without regard for transaction isolation.
abstract Object get(Object key, long txTimestamp)
Attempt to retrieve an object from the cache.
abstract EntityRegion getRegion()
Get the wrapped entity cache region
abstract boolean insert(Object key, Object value, Object version)
Called after an item has been inserted (before the transaction completes), instead of calling evict().
abstract SoftLock lockItem(Object key, Object version)
We are going to attempt to update/delete the keyed object.
abstract SoftLock lockRegion()
Lock the entire region
abstract 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.
abstract boolean putFromLoad(Object key, Object value, long txTimestamp, Object version)
Attempt to cache an object, after loading from the database.
abstract void remove(Object key)
Called after an item has become stale (before the transaction completes).
abstract void removeAll()
Called to evict data from the entire region
abstract void unlockItem(Object key, SoftLock lock)
Called when we have finished the attempted update/delete (which may or may not have been successful), after transaction completion.
abstract void unlockRegion(SoftLock lock)
Called after we have finished the attempted invalidation of the entire region
abstract 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().

Public Methods

public abstract boolean afterInsert (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
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 Propogated from underlying Region

public abstract boolean afterUpdate (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
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(Object, Object)
Returns
  • Were the contents of the cache actual changed by this operation?
Throws
CacheException Propogated from underlying Region

public abstract void evict (Object key)

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

Parameters
key The key of the item to remove
Throws
CacheException Propogated from underlying Region

public abstract void evictAll ()

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

Throws
CacheException Propogated from underlying Region

public abstract Object get (Object key, long txTimestamp)

Attempt to retrieve an object from the cache. Mainly used in attempting to resolve entities/collections from the second level 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 Propogated from underlying Region

public abstract EntityRegion getRegion ()

Get the wrapped entity cache region

Returns
  • The underlying region

public abstract boolean insert (Object key, Object value, Object version)

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

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 Propogated from underlying Region

public abstract SoftLock lockItem (Object key, Object version)

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 release(), to release the lock. Concurrency strategies which do not support client-visible locks may silently return null.

Parameters
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

public abstract SoftLock lockRegion ()

Lock the entire region

Returns
  • A representation of our lock on the item; or null.
Throws
CacheException Propogated from underlying Region

public abstract 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.

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 Propogated from underlying Region

public abstract 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
Throws
CacheException Propogated from underlying Region

public abstract void remove (Object key)

Called after an item has become stale (before the transaction completes). This method is used by "synchronous" concurrency strategies.

Parameters
key The key of the item to remove
Throws
CacheException Propogated from underlying Region

public abstract void removeAll ()

Called to evict data from the entire region

Throws
CacheException Propogated from underlying Region

public abstract void unlockItem (Object key, SoftLock lock)

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
key The item key
lock The lock previously obtained from lockItem(Object, Object)
Throws
CacheException Propogated from underlying Region

public abstract void unlockRegion (SoftLock lock)

Called after we have finished the attempted invalidation of the entire region

Parameters
lock The lock previously obtained from lockRegion()
Throws
CacheException Propogated from underlying Region

public abstract 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(). This method is used by "synchronous" concurrency strategies.

Parameters
key The item key
value The item
currentVersion The item's current version value
previousVersion The item's previous version value
Returns
  • Were the contents of the cache actual changed by this operation?
Throws
CacheException Propogated from underlying Region