org.hibernate.testing.cache

Class ReadWriteEntityRegionAccessStrategy

java.lang.Object

org.hibernate.testing.cache.BaseRegionAccessStrategy

org.hibernate.testing.cache.AbstractReadWriteAccessStrategy

org.hibernate.testing.cache.ReadWriteEntityRegionAccessStrategy

All Implemented Interfaces:

EntityRegionAccessStrategy, RegionAccessStrategy

public class ReadWriteEntityRegionAccessStrategy
extends AbstractReadWriteAccessStrategy
implements EntityRegionAccessStrategy

Nested Class Summary

Nested classes/interfaces inherited from class org.hibernate.testing.cache.AbstractReadWriteAccessStrategy

AbstractReadWriteAccessStrategy.Item, AbstractReadWriteAccessStrategy.Lock, AbstractReadWriteAccessStrategy.Lockable

Field Summary

Fields inherited from class org.hibernate.testing.cache.AbstractReadWriteAccessStrategy

readLock, writeLock

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().
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	getCacheKeyId(java.lang.Object cacheKey) Performs reverse operation to EntityRegionAccessStrategy.generateCacheKey(Object, EntityPersister, SessionFactoryImplementor, String)
protected org.hibernate.testing.cache.BaseGeneralDataRegion	getInternalRegion()
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().
protected boolean	isDefaultMinimalPutOverride()
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 org.hibernate.testing.cache.AbstractReadWriteAccessStrategy

decrementLock, get, handleLockExpiry, lockItem, putFromLoad, unlockItem

Methods inherited from class org.hibernate.testing.cache.BaseRegionAccessStrategy

evict, evictAll, lockRegion, putFromLoad, remove, removeAll, unlockRegion

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, get, lockItem, lockRegion, putFromLoad, putFromLoad, remove, removeAll, unlockItem, unlockRegion

Method Detail

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

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

afterInsert

public boolean afterInsert(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 (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?

Throws:

CacheException - Propagated from underlying Region

afterUpdate

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

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?

Throws:

CacheException - Propagated from underlying Region

getInternalRegion

protected org.hibernate.testing.cache.BaseGeneralDataRegion getInternalRegion()

Specified by:

getInternalRegion in class BaseRegionAccessStrategy

isDefaultMinimalPutOverride

protected boolean isDefaultMinimalPutOverride()

Specified by:

isDefaultMinimalPutOverride in class BaseRegionAccessStrategy

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

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)