org.hibernate.cache.spi.access

Interface NaturalIdRegionAccessStrategy

All Superinterfaces:

RegionAccessStrategy

public interface NaturalIdRegionAccessStrategy
extends RegionAccessStrategy

Contract for managing transactional and concurrent access to cached naturalId data. The expected call sequences related to various operations are:

• INSERTS : insert(org.hibernate.engine.spi.SessionImplementor, java.lang.Object, java.lang.Object) -> afterInsert(org.hibernate.engine.spi.SessionImplementor, java.lang.Object, java.lang.Object)
• UPDATES : RegionAccessStrategy.lockItem(org.hibernate.engine.spi.SessionImplementor, java.lang.Object, java.lang.Object) -> RegionAccessStrategy.remove(org.hibernate.engine.spi.SessionImplementor, java.lang.Object) -> update(org.hibernate.engine.spi.SessionImplementor, java.lang.Object, java.lang.Object) -> afterUpdate(org.hibernate.engine.spi.SessionImplementor, java.lang.Object, java.lang.Object, org.hibernate.cache.spi.access.SoftLock)
• DELETES : RegionAccessStrategy.lockItem(org.hibernate.engine.spi.SessionImplementor, java.lang.Object, java.lang.Object) -> RegionAccessStrategy.remove(org.hibernate.engine.spi.SessionImplementor, java.lang.Object) -> RegionAccessStrategy.unlockItem(org.hibernate.engine.spi.SessionImplementor, java.lang.Object, org.hibernate.cache.spi.access.SoftLock)
• LOADS : @putFromLoad

Note the special case of UPDATES above. Because the cache key itself has changed here we need to remove the old entry as well as

There is another usage pattern that is used to invalidate entries after performing "bulk" HQL/SQL operations: RegionAccessStrategy.lockRegion() -> RegionAccessStrategy.removeAll() -> RegionAccessStrategy.unlockRegion(org.hibernate.cache.spi.access.SoftLock)

IMPORTANT : NaturalIds are not versioned so null will always be passed to the version parameter to:

• RegionAccessStrategy.putFromLoad(SessionImplementor, Object, Object, long, Object)
• RegionAccessStrategy.putFromLoad(SessionImplementor, Object, Object, long, Object, boolean)
• RegionAccessStrategy.lockItem(SessionImplementor, Object, Object)

Author:

Gavin King, Steve Ebersole, Eric Dalquist

Method Summary

Modifier and Type	Method and Description
boolean	afterInsert(SessionImplementor session, Object key, Object value) Called after an item has been inserted (after the transaction completes), instead of calling release().
boolean	afterUpdate(SessionImplementor session, Object key, Object value, SoftLock lock) Called after an item has been updated (after the transaction completes), instead of calling release().
Object	generateCacheKey(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.
Object[]	getNaturalIdValues(Object cacheKey) Performs reverse operation to generateCacheKey(Object[], EntityPersister, SessionImplementor), returning the original naturalIdValues.
NaturalIdRegion	getRegion() Get the wrapped naturalId cache region
boolean	insert(SessionImplementor session, Object key, Object value) Called after an item has been inserted (before the transaction completes), instead of calling evict().
boolean	update(SessionImplementor session, Object key, Object value) Called after an item has been updated (before the transaction completes), instead of calling evict().

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

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

Method Detail

generateCacheKey

Object generateCacheKey(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.

Parameters:

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

persister - the persister of the element being cached

session -

Returns:

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

getNaturalIdValues

Object[] getNaturalIdValues(Object cacheKey)

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

Parameters:

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

Returns:

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

getRegion

NaturalIdRegion getRegion()

Get the wrapped naturalId cache region

Returns:

The underlying region

insert

boolean insert(SessionImplementor session,
               Object key,
               Object value)
        throws CacheException

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

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

boolean afterInsert(SessionImplementor session,
                    Object key,
                    Object value)
             throws CacheException

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

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

boolean update(SessionImplementor session,
               Object key,
               Object value)
        throws CacheException

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

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

boolean afterUpdate(SessionImplementor session,
                    Object key,
                    Object value,
                    SoftLock lock)
             throws CacheException

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

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?

Throws:

CacheException - Propogated from underlying Region