org.hibernate.cache.jcache.access

Class ReadWriteEntityRegionAccessStrategy

java.lang.Object

org.hibernate.cache.jcache.access.ReadWriteEntityRegionAccessStrategy

All Implemented Interfaces:

EntityRegionAccessStrategy, RegionAccessStrategy

public class ReadWriteEntityRegionAccessStrategy
extends java.lang.Object
implements EntityRegionAccessStrategy

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	org.hibernate.cache.jcache.access.AbstractReadWriteRegionAccessStrategy.Item Wrapper type representing unlocked items.
static class	org.hibernate.cache.jcache.access.AbstractReadWriteRegionAccessStrategy.Lock Wrapper type representing locked items.
protected static interface	org.hibernate.cache.jcache.access.AbstractReadWriteRegionAccessStrategy.Lockable Interface type implemented by all wrapper objects in the cache.

Field Summary

Fields

Modifier and Type	Field and Description
protected R	region
protected java.util.Comparator	versionComparator

Constructor Summary

Constructors

Constructor and Description
ReadWriteEntityRegionAccessStrategy(JCacheEntityRegion region)

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().
void	evict(java.lang.Object key)
void	evictAll()
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	get(SharedSessionContractImplementor session, java.lang.Object key, long txTimestamp)
java.lang.Object	getCacheKeyId(java.lang.Object cacheKey) Performs reverse operation to EntityRegionAccessStrategy.generateCacheKey(Object, EntityPersister, SessionFactoryImplementor, String)
R	getRegion()
protected void	handleMissingLock(java.lang.Object key, org.hibernate.cache.jcache.access.AbstractReadWriteRegionAccessStrategy.Lockable lock)
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().
SoftLock	lockItem(SharedSessionContractImplementor session, java.lang.Object key, java.lang.Object version)
SoftLock	lockRegion()
protected long	nextItemId()
boolean	putFromLoad(SharedSessionContractImplementor session, java.lang.Object key, java.lang.Object value, long txTimestamp, java.lang.Object version)
boolean	putFromLoad(SharedSessionContractImplementor session, java.lang.Object key, java.lang.Object value, long txTimestamp, java.lang.Object version, boolean minimalPutOverride)
void	remove(SharedSessionContractImplementor session, java.lang.Object key)
void	removeAll()
void	unlockItem(SharedSessionContractImplementor session, java.lang.Object key, SoftLock lock)
void	unlockRegion(SoftLock lock)
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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getRegion

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

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

Field Detail

region

protected final R extends JCacheTransactionalDataRegion region

versionComparator

protected final java.util.Comparator versionComparator

Constructor Detail

ReadWriteEntityRegionAccessStrategy

public ReadWriteEntityRegionAccessStrategy(JCacheEntityRegion region)

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

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

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

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

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)

getRegion

public R getRegion()

get

public java.lang.Object get(SharedSessionContractImplementor session,
                            java.lang.Object key,
                            long txTimestamp)
                     throws CacheException

Throws:

CacheException

putFromLoad

public boolean putFromLoad(SharedSessionContractImplementor session,
                           java.lang.Object key,
                           java.lang.Object value,
                           long txTimestamp,
                           java.lang.Object version)
                    throws CacheException

Throws:

CacheException

putFromLoad

public boolean putFromLoad(SharedSessionContractImplementor session,
                           java.lang.Object key,
                           java.lang.Object value,
                           long txTimestamp,
                           java.lang.Object version,
                           boolean minimalPutOverride)
                    throws CacheException

Throws:

CacheException

lockItem

public SoftLock lockItem(SharedSessionContractImplementor session,
                         java.lang.Object key,
                         java.lang.Object version)
                  throws CacheException

Throws:

CacheException

unlockItem

public void unlockItem(SharedSessionContractImplementor session,
                       java.lang.Object key,
                       SoftLock lock)
                throws CacheException

Throws:

CacheException

remove

public void remove(SharedSessionContractImplementor session,
                   java.lang.Object key)
            throws CacheException

Throws:

CacheException

removeAll

public void removeAll()
               throws CacheException

Throws:

CacheException

evict

public void evict(java.lang.Object key)
           throws CacheException

Throws:

CacheException

evictAll

public void evictAll()
              throws CacheException

Throws:

CacheException

lockRegion

public SoftLock lockRegion()
                    throws CacheException

Throws:

CacheException

unlockRegion

public void unlockRegion(SoftLock lock)
                  throws CacheException

Throws:

CacheException

nextItemId

protected long nextItemId()

handleMissingLock

protected void handleMissingLock(java.lang.Object key,
                                 org.hibernate.cache.jcache.access.AbstractReadWriteRegionAccessStrategy.Lockable lock)