org.hibernate.cache.ehcache.internal.strategy

Class TransactionalEhcacheNaturalIdRegionAccessStrategy

java.lang.Object

org.hibernate.cache.ehcache.internal.strategy.TransactionalEhcacheNaturalIdRegionAccessStrategy

All Implemented Interfaces:

NaturalIdRegionAccessStrategy, RegionAccessStrategy

public class TransactionalEhcacheNaturalIdRegionAccessStrategy
extends java.lang.Object
implements NaturalIdRegionAccessStrategy

JTA NaturalIdRegionAccessStrategy.

Constructor Summary

Constructors

Constructor and Description
TransactionalEhcacheNaturalIdRegionAccessStrategy(EhcacheNaturalIdRegion region, net.sf.ehcache.Ehcache ehcache, SessionFactoryOptions settings) Construct a new collection region access strategy.

Method Summary

Modifier and Type	Method and Description
boolean	afterInsert(SessionImplementor session, java.lang.Object key, java.lang.Object value) Called after an item has been inserted (after the transaction completes), instead of calling release().
boolean	afterUpdate(SessionImplementor session, java.lang.Object key, java.lang.Object value, 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[] naturalIdValues, EntityPersister persister, SessionImplementor session) To create instances of NaturalIdCacheKey for this region, Hibernate will invoke this method exclusively so that generated implementations can generate optimised keys.
java.lang.Object	get(SessionImplementor session, java.lang.Object key, long txTimestamp) Attempt to retrieve an object from the cache.
java.lang.Object[]	getNaturalIdValues(java.lang.Object cacheKey) Performs reverse operation to NaturalIdRegionAccessStrategy.generateCacheKey(Object[], EntityPersister, SessionImplementor), returning the original naturalIdValues.
NaturalIdRegion	getRegion() Get the wrapped naturalId cache region
boolean	insert(SessionImplementor session, java.lang.Object key, java.lang.Object value) Called after an item has been inserted (before the transaction completes), instead of calling evict().
SoftLock	lockItem(SessionImplementor 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(SessionImplementor 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(SessionImplementor 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(SessionImplementor 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(SessionImplementor 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(SessionImplementor session, java.lang.Object key, java.lang.Object value) 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

TransactionalEhcacheNaturalIdRegionAccessStrategy

public TransactionalEhcacheNaturalIdRegionAccessStrategy(EhcacheNaturalIdRegion region,
                                                         net.sf.ehcache.Ehcache ehcache,
                                                         SessionFactoryOptions settings)

Construct a new collection region access strategy.

Parameters:

region - the Hibernate region.

ehcache - the cache.

settings - the Hibernate settings.

Method Detail

afterInsert

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

Description copied from interface: NaturalIdRegionAccessStrategy

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 NaturalIdRegionAccessStrategy

Parameters:

session - Current session

key - The item key

value - The item

Returns:

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

afterUpdate

public boolean afterUpdate(SessionImplementor session,
                           java.lang.Object key,
                           java.lang.Object value,
                           SoftLock lock)

Description copied from interface: NaturalIdRegionAccessStrategy

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 NaturalIdRegionAccessStrategy

Parameters:

session - Current session

key - The item key

value - The item

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

Returns:

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

get

public java.lang.Object get(SessionImplementor 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 NaturalIdRegion getRegion()

Description copied from interface: NaturalIdRegionAccessStrategy

Get the wrapped naturalId cache region

Specified by:

getRegion in interface NaturalIdRegionAccessStrategy

Returns:

The underlying region

insert

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

Description copied from interface: NaturalIdRegionAccessStrategy

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 NaturalIdRegionAccessStrategy

Parameters:

session - Current session

key - The item key

value - The item

Returns:

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

Throws:

CacheException - Propagated from underlying Region

lockItem

public SoftLock lockItem(SessionImplementor 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.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

putFromLoad

public boolean putFromLoad(SessionImplementor 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(SessionImplementor, Object, Object, long, Object, boolean), RegionAccessStrategy.putFromLoad(SessionImplementor, Object, Object, long, Object, boolean)

remove

public void remove(SessionImplementor 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(SessionImplementor, Object), RegionAccessStrategy.remove(SessionImplementor, Object)

unlockItem

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

Throws:

CacheException - Propogated from underlying Region

update

public boolean update(SessionImplementor session,
                      java.lang.Object key,
                      java.lang.Object value)
               throws CacheException

Description copied from interface: NaturalIdRegionAccessStrategy

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 NaturalIdRegionAccessStrategy

Parameters:

session - Current session

key - The item key

value - The item

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[] naturalIdValues,
                                         EntityPersister persister,
                                         SessionImplementor session)

Description copied from interface: NaturalIdRegionAccessStrategy

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

Specified by:

generateCacheKey in interface NaturalIdRegionAccessStrategy

Parameters:

naturalIdValues - the sequence of values which unequivocally identifies a cached element on this region

persister - the persister of the element being cached

Returns:

a key which can be used to identify this an element unequivocally on this same region

getNaturalIdValues

public java.lang.Object[] getNaturalIdValues(java.lang.Object cacheKey)

Description copied from interface: NaturalIdRegionAccessStrategy

Performs reverse operation to NaturalIdRegionAccessStrategy.generateCacheKey(Object[], EntityPersister, SessionImplementor), returning the original naturalIdValues.

Specified by:

getNaturalIdValues in interface NaturalIdRegionAccessStrategy

Parameters:

cacheKey - key returned from NaturalIdRegionAccessStrategy.generateCacheKey(Object[], EntityPersister, SessionImplementor)

Returns:

the sequence of values which unequivocally identifies a cached element on this region

region

protected T region()

The wrapped Hibernate cache region.

settings

protected SessionFactoryOptions settings()

The settings for this persistence unit.

putFromLoad

public final boolean putFromLoad(SessionImplementor 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(SessionImplementor, Object, Object, long, Object), RegionAccessStrategy.putFromLoad(SessionImplementor, 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()