org.hibernate.cache.spi.access

Interface EntityRegionAccessStrategy

All Superinterfaces:

RegionAccessStrategy

public interface EntityRegionAccessStrategy
extends RegionAccessStrategy

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

• INSERTS : insert(org.hibernate.engine.spi.SessionImplementor, java.lang.Object, java.lang.Object, java.lang.Object) -> afterInsert(org.hibernate.engine.spi.SessionImplementor, java.lang.Object, java.lang.Object, java.lang.Object)
• UPDATES : RegionAccessStrategy.lockItem(org.hibernate.engine.spi.SessionImplementor, java.lang.Object, java.lang.Object) -> update(org.hibernate.engine.spi.SessionImplementor, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object) -> afterUpdate(org.hibernate.engine.spi.SessionImplementor, java.lang.Object, java.lang.Object, 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

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)

Author:

Gavin King, Steve Ebersole

Method Summary

Modifier and Type	Method and Description
boolean	afterInsert(SessionImplementor session, Object key, Object value, Object version) Called after an item has been inserted (after the transaction completes), instead of calling release().
boolean	afterUpdate(SessionImplementor session, Object key, Object value, Object currentVersion, Object previousVersion, SoftLock lock) Called after an item has been updated (after the transaction completes), instead of calling release().
Object	generateCacheKey(Object id, EntityPersister persister, SessionFactoryImplementor factory, String tenantIdentifier) To create instances of keys for this region, Hibernate will invoke this method exclusively so that generated implementations can generate optimised keys.
Object	getCacheKeyId(Object cacheKey) Performs reverse operation to generateCacheKey(Object, EntityPersister, SessionFactoryImplementor, String)
EntityRegion	getRegion() Get the wrapped entity cache region
boolean	insert(SessionImplementor session, Object key, Object value, Object version) Called after an item has been inserted (before the transaction completes), instead of calling evict().
boolean	update(SessionImplementor session, Object key, Object value, Object currentVersion, Object previousVersion) 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 id,
                        EntityPersister persister,
                        SessionFactoryImplementor factory,
                        String tenantIdentifier)

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

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

Object getCacheKeyId(Object cacheKey)

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

Parameters:

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

Returns:

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

getRegion

EntityRegion getRegion()

Get the wrapped entity cache region

Returns:

The underlying region

insert

boolean insert(SessionImplementor session,
               Object key,
               Object value,
               Object version)
        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

version - The item's version value

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,
                    Object version)
             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

version - The item's version value

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,
               Object currentVersion,
               Object previousVersion)
        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

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

afterUpdate

boolean afterUpdate(SessionImplementor session,
                    Object key,
                    Object value,
                    Object currentVersion,
                    Object previousVersion,
                    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

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

Returns:

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

Throws:

CacheException - Propagated from underlying Region