Summary: Methods | [Expand All]
public interface

CacheConcurrencyStrategy

org.hibernate.cache.CacheConcurrencyStrategy
Known Indirect Subclasses

This interface is deprecated.
As of 3.3; see for details.

Class Overview

Implementors manage transactional access to cached data. Transactions pass in a timestamp indicating transaction start time. Two different implementation patterns are provided for.

  • A transaction-aware cache implementation might be wrapped by a "synchronous" concurrency strategy, where updates to the cache are written to the cache inside the transaction.
  • A non transaction-aware cache would be wrapped by an "asynchronous" concurrency strategy, where items are merely "soft locked" during the transaction and then updated during the "after transaction completion" phase; the soft lock is not an actual lock on the database row - only upon the cached representation of the item.

In terms of entity caches, the expected call sequences are:

In terms of collection caches, all modification actions actually just invalidate the entry(s). The call sequence here is: lock(Object, Object) -> evict(Object) -> release(Object, SoftLock)

Note that, for an asynchronous cache, cache invalidation must be a two step process (lock->release, or lock-afterUpdate), since this is the only way to guarantee consistency with the database for a nontransactional cache implementation. For a synchronous cache, cache invalidation is a single step process (evict, or update). Hence, this interface defines a three step process, to cater for both models.

Note that query result caching does not go through a concurrency strategy; they are managed directly against the underlying cache regions.

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 version, SoftLock lock)
Called after an item has been updated (after the transaction completes), instead of calling release().
abstract void clear()
Evict all items from the cache immediately.
abstract void destroy()
Clean up all resources.
abstract void evict(Object key)
Called after an item has become stale (before the transaction completes).
abstract Object get(Object key, long txTimestamp)
Attempt to retrieve an object from the cache.
abstract Cache getCache()
Get the wrapped cache implementation
abstract String getRegionName()
Get the cache region name
abstract boolean insert(Object key, Object value, Object currentVersion)
Called after an item has been inserted (before the transaction completes), instead of calling evict().
abstract SoftLock lock(Object key, Object version)
We are going to attempt to update/delete the keyed object.
abstract boolean put(Object key, Object value, long txTimestamp, Object version, Comparator versionComparator, boolean minimalPut)
Attempt to cache an object, after loading from the database.
abstract void release(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 remove(Object key)
Evict an item from the cache immediately (without regard for transaction isolation).
abstract void setCache(Cache cache)
Set the underlying cache implementation.
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.

Throws
CacheException

public abstract boolean afterUpdate (Object key, Object value, Object version, 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.

Throws
CacheException

public abstract void clear ()

Evict all items from the cache immediately.

Throws
CacheException

public abstract void destroy ()

Clean up all resources.

public abstract void evict (Object key)

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

Throws
CacheException

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
txTimestamp a timestamp prior to the transaction start time
Returns
  • the cached object or null
Throws
CacheException

public abstract Cache getCache ()

Get the wrapped cache implementation

public abstract String getRegionName ()

Get the cache region name

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

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

Throws
CacheException

public abstract SoftLock lock (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.

Throws
CacheException

public abstract boolean put (Object key, Object value, long txTimestamp, Object version, Comparator versionComparator, boolean minimalPut)

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

Parameters
txTimestamp a timestamp prior to the transaction start time
version the item version number
versionComparator a comparator used to compare version numbers
minimalPut indicates that the cache should avoid a put is the item is already cached
Returns
  • true if the object was successfully cached
Throws
CacheException

public abstract void release (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.

Throws
CacheException

public abstract void remove (Object key)

Evict an item from the cache immediately (without regard for transaction isolation).

Throws
CacheException

public abstract void setCache (Cache cache)

Set the underlying cache implementation.

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.

Throws
CacheException