org.hibernate.cache.ehcache.internal.strategy

Class TransactionalEhcacheEntityRegionAccessStrategy

java.lang.Object

org.hibernate.cache.ehcache.internal.strategy.TransactionalEhcacheEntityRegionAccessStrategy

All Implemented Interfaces:

EntityRegionAccessStrategy, RegionAccessStrategy

public class TransactionalEhcacheEntityRegionAccessStrategy
extends java.lang.Object
implements EntityRegionAccessStrategy

JTA EntityRegionAccessStrategy.

Constructor Summary

Constructors

Constructor and Description
TransactionalEhcacheEntityRegionAccessStrategy(EhcacheEntityRegion region, net.sf.ehcache.Ehcache ehcache, SessionFactoryOptions settings) Construct a new entity region access strategy.

Method Summary

Modifier and Type	Method and Description
boolean	afterInsert(SharedSessionContractImplementor session, java.lang.Object key, java.lang.Object value, java.lang.Object version) Called after an item has been inserted (after the transaction completes), instead of calling release().
boolean	afterUpdate(SharedSessionContractImplementor session, java.lang.Object key, java.lang.Object value, java.lang.Object currentVersion, java.lang.Object previousVersion, SoftLock lock) Called after an item has been updated (after the transaction completes), instead of calling release().
void	evict(java.lang.Object key) Remove the given mapping without regard to transactional safety
void	evictAll() Remove all mappings without regard to transactional safety
java.lang.Object	generateCacheKey(java.lang.Object id, EntityPersister persister, SessionFactoryImplementor factory, java.lang.String tenantIdentifier) To create instances of keys for this region, Hibernate will invoke this method exclusively so that generated implementations can generate optimised keys.
java.lang.Object	get(SharedSessionContractImplementor session, java.lang.Object key, long txTimestamp) Attempt to retrieve an object from the cache.
java.lang.Object	getCacheKeyId(java.lang.Object cacheKey) Performs reverse operation to EntityRegionAccessStrategy.generateCacheKey(Object, EntityPersister, SessionFactoryImplementor, String)
EntityRegion	getRegion() Get the wrapped entity cache region
boolean	insert(SharedSessionContractImplementor session, java.lang.Object key, java.lang.Object value, java.lang.Object version) Called after an item has been inserted (before the transaction completes), instead of calling evict().
SoftLock	lockItem(SharedSessionContractImplementor session, java.lang.Object key, java.lang.Object version) We are going to attempt to update/delete the keyed object.
SoftLock	lockRegion() Region locks are not supported.
boolean	putFromLoad(SharedSessionContractImplementor session, java.lang.Object key, java.lang.Object value, long txTimestamp, java.lang.Object version) This method is a placeholder for method signatures supplied by interfaces pulled in further down the class hierarchy.
boolean	putFromLoad(SharedSessionContractImplementor session, java.lang.Object key, java.lang.Object value, long txTimestamp, java.lang.Object version, boolean minimalPutOverride) This method is a placeholder for method signatures supplied by interfaces pulled in further down the class hierarchy.
protected T	region() The wrapped Hibernate cache region.
void	remove(SharedSessionContractImplementor session, java.lang.Object key) A no-op since this is an asynchronous cache access strategy.
void	removeAll() Called to evict data from the entire region
protected SessionFactoryOptions	settings() The settings for this persistence unit.
void	unlockItem(SharedSessionContractImplementor session, java.lang.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) Region locks are not supported - perform a cache clear as a precaution.
boolean	update(SharedSessionContractImplementor session, java.lang.Object key, java.lang.Object value, java.lang.Object currentVersion, java.lang.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

Methods inherited from interface org.hibernate.cache.spi.access.RegionAccessStrategy

evict, evictAll, lockRegion, putFromLoad, removeAll, unlockRegion

Constructor Detail

TransactionalEhcacheEntityRegionAccessStrategy

public TransactionalEhcacheEntityRegionAccessStrategy(EhcacheEntityRegion region,
                                                      net.sf.ehcache.Ehcache ehcache,
                                                      SessionFactoryOptions settings)

Construct a new entity region access strategy.

Parameters:

region - the Hibernate region.

ehcache - the cache.

settings - the Hibernate settings.

Method Detail

afterInsert

public boolean afterInsert(SharedSessionContractImplementor session,
                           java.lang.Object key,
                           java.lang.Object value,
                           java.lang.Object version)

Description copied from interface: EntityRegionAccessStrategy

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

Specified by:

afterInsert in interface EntityRegionAccessStrategy

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?

afterUpdate

public boolean afterUpdate(SharedSessionContractImplementor session,
                           java.lang.Object key,
                           java.lang.Object value,
                           java.lang.Object currentVersion,
                           java.lang.Object previousVersion,
                           SoftLock lock)

Description copied from interface: EntityRegionAccessStrategy

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

Specified by:

afterUpdate in interface EntityRegionAccessStrategy

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

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

Returns:

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

get

public java.lang.Object get(SharedSessionContractImplementor session,
                            java.lang.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

getRegion

public EntityRegion getRegion()

Description copied from interface: EntityRegionAccessStrategy

Get the wrapped entity cache region

Specified by:

getRegion in interface EntityRegionAccessStrategy

Returns:

The underlying region

insert

public boolean insert(SharedSessionContractImplementor session,
                      java.lang.Object key,
                      java.lang.Object value,
                      java.lang.Object version)
               throws CacheException

Description copied from interface: EntityRegionAccessStrategy

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

Specified by:

insert in interface EntityRegionAccessStrategy

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

lockItem

public SoftLock lockItem(SharedSessionContractImplementor session,
                         java.lang.Object key,
                         java.lang.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.SharedSessionContractImplementor, 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

putFromLoad

public boolean putFromLoad(SharedSessionContractImplementor session,
                           java.lang.Object key,
                           java.lang.Object value,
                           long txTimestamp,
                           java.lang.Object version,
                           boolean minimalPutOverride)
                    throws CacheException

This method is a placeholder for method signatures supplied by interfaces pulled in further down the class hierarchy.

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

See Also:

RegionAccessStrategy.putFromLoad(SharedSessionContractImplementor, Object, Object, long, Object, boolean), RegionAccessStrategy.putFromLoad(SharedSessionContractImplementor, Object, Object, long, Object, boolean)

remove

public void remove(SharedSessionContractImplementor session,
                   java.lang.Object key)
            throws CacheException

A no-op since this is an asynchronous cache access strategy.

Specified by:

remove in interface RegionAccessStrategy

key - The key of the item to remove

Throws:

CacheException - Propogated from underlying Region

See Also:

RegionAccessStrategy.remove(SharedSessionContractImplementor, Object), RegionAccessStrategy.remove(SharedSessionContractImplementor, Object)

unlockItem

public void unlockItem(SharedSessionContractImplementor session,
                       java.lang.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.SharedSessionContractImplementor, java.lang.Object, java.lang.Object)

Throws:

CacheException - Propogated from underlying Region

update

public boolean update(SharedSessionContractImplementor session,
                      java.lang.Object key,
                      java.lang.Object value,
                      java.lang.Object currentVersion,
                      java.lang.Object previousVersion)
               throws CacheException

Description copied from interface: EntityRegionAccessStrategy

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

Specified by:

update in interface EntityRegionAccessStrategy

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:

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

Throws:

CacheException - Propagated from underlying Region

generateCacheKey

public java.lang.Object generateCacheKey(java.lang.Object id,
                                         EntityPersister persister,
                                         SessionFactoryImplementor factory,
                                         java.lang.String tenantIdentifier)

Description copied from interface: EntityRegionAccessStrategy

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

Specified by:

generateCacheKey in interface EntityRegionAccessStrategy

Parameters:

id - the primary identifier of the entity

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 entity on this same region

getCacheKeyId

public java.lang.Object getCacheKeyId(java.lang.Object cacheKey)

Description copied from interface: EntityRegionAccessStrategy

Performs reverse operation to EntityRegionAccessStrategy.generateCacheKey(Object, EntityPersister, SessionFactoryImplementor, String)

Specified by:

getCacheKeyId in interface EntityRegionAccessStrategy

Parameters:

cacheKey - key previously returned from EntityRegionAccessStrategy.generateCacheKey(Object, EntityPersister, SessionFactoryImplementor, String)

Returns:

original id passed to EntityRegionAccessStrategy.generateCacheKey(Object, EntityPersister, SessionFactoryImplementor, String)

region

protected T region()

The wrapped Hibernate cache region.

settings

protected SessionFactoryOptions settings()

The settings for this persistence unit.

putFromLoad

public final boolean putFromLoad(SharedSessionContractImplementor session,
                                 java.lang.Object key,
                                 java.lang.Object value,
                                 long txTimestamp,
                                 java.lang.Object version)
                          throws CacheException

This method is a placeholder for method signatures supplied by interfaces pulled in further down the class hierarchy.

Throws:

CacheException

See Also:

RegionAccessStrategy.putFromLoad(SharedSessionContractImplementor, Object, Object, long, Object), RegionAccessStrategy.putFromLoad(SharedSessionContractImplementor, Object, Object, long, Object)

lockRegion

public final SoftLock lockRegion()

Region locks are not supported.

Returns:

null

See Also:

RegionAccessStrategy.lockRegion(), RegionAccessStrategy.lockRegion()

unlockRegion

public final void unlockRegion(SoftLock lock)
                        throws CacheException

Region locks are not supported - perform a cache clear as a precaution.

Throws:

CacheException

See Also:

RegionAccessStrategy.unlockRegion(org.hibernate.cache.spi.access.SoftLock), RegionAccessStrategy.unlockRegion(org.hibernate.cache.spi.access.SoftLock)

removeAll

public final void removeAll()
                     throws CacheException

Called to evict data from the entire region

Throws:

CacheException - Propogated from underlying Region

See Also:

RegionAccessStrategy.removeAll(), RegionAccessStrategy.removeAll()

evict

public final void evict(java.lang.Object key)
                 throws CacheException

Remove the given mapping without regard to transactional safety

Throws:

CacheException

See Also:

RegionAccessStrategy.evict(java.lang.Object), RegionAccessStrategy.evict(java.lang.Object)

evictAll

public final void evictAll()
                    throws CacheException

Remove all mappings without regard to transactional safety

Throws:

CacheException

See Also:

RegionAccessStrategy.evictAll(), RegionAccessStrategy.evictAll()