org.hibernate.cache.jcache.access

Class ReadOnlyNaturalIdRegionAccessStrategy

java.lang.Object

org.hibernate.cache.jcache.access.ReadOnlyNaturalIdRegionAccessStrategy

All Implemented Interfaces:

NaturalIdRegionAccessStrategy, RegionAccessStrategy

public class ReadOnlyNaturalIdRegionAccessStrategy
extends java.lang.Object
implements NaturalIdRegionAccessStrategy

Constructor Summary

Constructors

Constructor and Description
ReadOnlyNaturalIdRegionAccessStrategy(JCacheNaturalIdRegion jCacheNaturalIdRegion)

Method Summary

Modifier and Type	Method and Description
boolean	afterInsert(SharedSessionContractImplementor 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(SharedSessionContractImplementor 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) 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.
java.lang.Object	generateCacheKey(java.lang.Object[] naturalIdValues, EntityPersister persister, SharedSessionContractImplementor 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(SharedSessionContractImplementor 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, SharedSessionContractImplementor), returning the original naturalIdValues.
R	getRegion()
boolean	insert(SharedSessionContractImplementor 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(SharedSessionContractImplementor session, java.lang.Object key, java.lang.Object version) We are going to attempt to update/delete the keyed object.
SoftLock	lockRegion() Lock the entire region
boolean	putFromLoad(SharedSessionContractImplementor session, java.lang.Object key, java.lang.Object value, long txTimestamp, java.lang.Object version) Attempt to cache an object, after loading from the database.
boolean	putFromLoad(SharedSessionContractImplementor session, java.lang.Object key, java.lang.Object value, long txTimestamp, java.lang.Object version, boolean minimalPutOverride) Attempt to cache an object, after loading from the database, explicitly specifying the minimalPut behavior.
void	remove(SharedSessionContractImplementor session, java.lang.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(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) Called after we have finished the attempted invalidation of the entire region
boolean	update(SharedSessionContractImplementor 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.NaturalIdRegionAccessStrategy

getRegion

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

evict, evictAll, get, lockItem, lockRegion, putFromLoad, putFromLoad, remove, removeAll, unlockItem, unlockRegion

Constructor Detail

ReadOnlyNaturalIdRegionAccessStrategy

public ReadOnlyNaturalIdRegionAccessStrategy(JCacheNaturalIdRegion jCacheNaturalIdRegion)

Method Detail

insert

public boolean insert(SharedSessionContractImplementor 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

afterInsert

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

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?

Throws:

CacheException - Propagated from underlying Region

update

public boolean update(SharedSessionContractImplementor 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

afterUpdate

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

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.SharedSessionContractImplementor, java.lang.Object, java.lang.Object)

Returns:

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

Throws:

CacheException - Propogated from underlying Region

generateCacheKey

public java.lang.Object generateCacheKey(java.lang.Object[] naturalIdValues,
                                         EntityPersister persister,
                                         SharedSessionContractImplementor 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, SharedSessionContractImplementor), returning the original naturalIdValues.

Specified by:

getNaturalIdValues in interface NaturalIdRegionAccessStrategy

Parameters:

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

Returns:

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

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

putFromLoad

public boolean putFromLoad(SharedSessionContractImplementor session,
                           java.lang.Object key,
                           java.lang.Object value,
                           long txTimestamp,
                           java.lang.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

putFromLoad

public boolean putFromLoad(SharedSessionContractImplementor session,
                           java.lang.Object key,
                           java.lang.Object value,
                           long txTimestamp,
                           java.lang.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

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

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

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

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

remove

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

evict

public void evict(java.lang.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

getRegion

public R getRegion()