org.hibernate.cache.ehcache.internal.nonstop

Class NonstopAwareCollectionRegionAccessStrategy

java.lang.Object

org.hibernate.cache.ehcache.internal.nonstop.NonstopAwareCollectionRegionAccessStrategy

All Implemented Interfaces:

CollectionRegionAccessStrategy, RegionAccessStrategy

public class NonstopAwareCollectionRegionAccessStrategy
extends Object
implements CollectionRegionAccessStrategy

Implementation of CollectionRegionAccessStrategy that handles NonStopCacheException using HibernateNonstopCacheExceptionHandler

Constructor Summary

Constructors

Constructor and Description
NonstopAwareCollectionRegionAccessStrategy(CollectionRegionAccessStrategy actualStrategy, HibernateNonstopCacheExceptionHandler hibernateNonstopExceptionHandler) Constructor accepting the actual CollectionRegionAccessStrategy and the HibernateNonstopCacheExceptionHandler

Method Summary

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	generateCacheKey(Object id, CollectionPersister persister, SessionFactoryImplementor factory, String tenantIdentifier) To create instances of CollectionCacheKey for this region, Hibernate will invoke this method exclusively so that generated implementations can generate optimised keys.
Object	get(SessionImplementor session, Object key, long txTimestamp) Attempt to retrieve an object from the cache.
Object	getCacheKeyId(Object cacheKey) Performs reverse operation to CollectionRegionAccessStrategy.generateCacheKey(Object, CollectionPersister, SessionFactoryImplementor, String)
CollectionRegion	getRegion() Get the wrapped collection cache region
SoftLock	lockItem(SessionImplementor session, Object key, Object version) We are going to attempt to update/delete the keyed object.
SoftLock	lockRegion() Lock the entire region
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, SoftLock lock) Called when we have finished the attempted update/delete (which may or may not have been successful), after transaction completion.
void	unlockRegion(SoftLock lock) Called after we have finished the attempted invalidation of the entire region

Methods inherited from class java.lang.Object

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

Constructor Detail

NonstopAwareCollectionRegionAccessStrategy

public NonstopAwareCollectionRegionAccessStrategy(CollectionRegionAccessStrategy actualStrategy,
                                                  HibernateNonstopCacheExceptionHandler hibernateNonstopExceptionHandler)

Constructor accepting the actual CollectionRegionAccessStrategy and the HibernateNonstopCacheExceptionHandler

Parameters:

actualStrategy - The wrapped strategy

hibernateNonstopExceptionHandler - The exception handler

Method Detail

getRegion

public CollectionRegion getRegion()

Description copied from interface: CollectionRegionAccessStrategy

Get the wrapped collection cache region

Specified by:

getRegion in interface CollectionRegionAccessStrategy

Returns:

The underlying region

evict

public void evict(Object key)
           throws CacheException

Description copied from interface: RegionAccessStrategy

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

Specified by:

evict in interface RegionAccessStrategy

Parameters:

key - The key of the item to remove

Throws:

CacheException - Propogated from underlying Region

evictAll

public void evictAll()
              throws CacheException

Description copied from interface: RegionAccessStrategy

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

Specified by:

evictAll in interface RegionAccessStrategy

Throws:

CacheException - Propogated from underlying Region

get

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

Description copied from interface: RegionAccessStrategy

Attempt to retrieve an object from the cache. Mainly used in attempting to resolve entities/collections from the second level cache.

Specified by:

get in interface RegionAccessStrategy

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

lockItem

public SoftLock lockItem(SessionImplementor session,
                         Object key,
                         Object version)
                  throws CacheException

Description copied from interface: RegionAccessStrategy

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 RegionAccessStrategy.unlockItem(org.hibernate.engine.spi.SessionImplementor, java.lang.Object, org.hibernate.cache.spi.access.SoftLock), to release the lock. Concurrency strategies which do not support client-visible locks may silently return null.

Specified by:

lockItem in interface RegionAccessStrategy

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

lockRegion

public SoftLock lockRegion()
                    throws CacheException

Description copied from interface: RegionAccessStrategy

Lock the entire region

Specified by:

lockRegion in interface RegionAccessStrategy

Returns:

A representation of our lock on the item; or null.

Throws:

CacheException - Propogated from underlying Region

putFromLoad

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

Description copied from interface: RegionAccessStrategy

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

Specified by:

putFromLoad in interface RegionAccessStrategy

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

putFromLoad

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

Description copied from interface: RegionAccessStrategy

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

Specified by:

putFromLoad in interface RegionAccessStrategy

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

Throws:

CacheException - Propogated from underlying Region

remove

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

Description copied from interface: RegionAccessStrategy

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

Specified by:

remove in interface RegionAccessStrategy

key - The key of the item to remove

Throws:

CacheException - Propogated from underlying Region

removeAll

public void removeAll()
               throws CacheException

Description copied from interface: RegionAccessStrategy

Called to evict data from the entire region

Specified by:

removeAll in interface RegionAccessStrategy

Throws:

CacheException - Propogated from underlying Region

unlockItem

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

Description copied from interface: RegionAccessStrategy

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.

Specified by:

unlockItem in interface RegionAccessStrategy

Parameters:

session - Current session.

key - The item key

lock - The lock previously obtained from RegionAccessStrategy.lockItem(org.hibernate.engine.spi.SessionImplementor, java.lang.Object, java.lang.Object)

Throws:

CacheException - Propogated from underlying Region

unlockRegion

public void unlockRegion(SoftLock lock)
                  throws CacheException

Description copied from interface: RegionAccessStrategy

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

Specified by:

unlockRegion in interface RegionAccessStrategy

Parameters:

lock - The lock previously obtained from RegionAccessStrategy.lockRegion()

Throws:

CacheException - Propogated from underlying Region

generateCacheKey

public Object generateCacheKey(Object id,
                               CollectionPersister persister,
                               SessionFactoryImplementor factory,
                               String tenantIdentifier)

Description copied from interface: CollectionRegionAccessStrategy

To create instances of CollectionCacheKey for this region, Hibernate will invoke this method exclusively so that generated implementations can generate optimised keys.

Specified by:

generateCacheKey in interface CollectionRegionAccessStrategy

Parameters:

id - the primary identifier of the Collection

persister - the persister for the type for which a key is being generated

factory - a reference to the current SessionFactory

tenantIdentifier - the tenant id, or null if multi-tenancy is not being used.

Returns:

a key which can be used to identify this collection on this same region

getCacheKeyId

public Object getCacheKeyId(Object cacheKey)

Description copied from interface: CollectionRegionAccessStrategy

Performs reverse operation to CollectionRegionAccessStrategy.generateCacheKey(Object, CollectionPersister, SessionFactoryImplementor, String)

Specified by:

getCacheKeyId in interface CollectionRegionAccessStrategy

Parameters:

cacheKey - key previously returned from CollectionRegionAccessStrategy.generateCacheKey(Object, CollectionPersister, SessionFactoryImplementor, String)

Returns:

original key passed to CollectionRegionAccessStrategy.generateCacheKey(Object, CollectionPersister, SessionFactoryImplementor, String)