org.gridgain.grid.cache.hibernate

Class GridHibernateReadWriteAccessStrategy

java.lang.Object

org.gridgain.grid.cache.hibernate.GridHibernateAccessStrategyAdapter

org.gridgain.grid.cache.hibernate.GridHibernateReadWriteAccessStrategy

public class GridHibernateReadWriteAccessStrategy
extends GridHibernateAccessStrategyAdapter

Implementation of AccessType.READ_WRITE cache access strategy.

Configuration of L2 cache and per-entity cache access strategy can be set in the Hibernate configuration file:

 <hibernate-configuration>
     <!-- Enable L2 cache. -->
     <property name="cache.use_second_level_cache">true</property>

     <!-- Use GridGain as L2 cache provider. -->
     <property name="cache.region.factory_class">org.gridgain.grid.cache.hibernate.GridHibernateRegionFactory</property>

     <!-- Specify entity. -->
     <mapping class="com.example.Entity"/>

     <!-- Enable L2 cache with read-write access strategy for entity. -->
     <class-cache class="com.example.Entity" usage="read-write"/>
 </hibernate-configuration>
 

Also cache access strategy can be set using annotations:

 @javax.persistence.Entity
 @javax.persistence.Cacheable
 @org.hibernate.annotations.Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
 public class Entity { ... }
 

Field Summary

Fields inherited from class org.gridgain.grid.cache.hibernate.GridHibernateAccessStrategyAdapter

cache, grid, log

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GridHibernateReadWriteAccessStrategy(org.gridgain.grid.Grid grid, org.gridgain.grid.cache.GridCache<Object,Object> cache, ThreadLocal txCtx)

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	afterInsert(Object key, Object val) Called after Hibernate inserted object in the database and transaction successfully completed.
protected boolean	afterUpdate(Object key, Object val, org.hibernate.cache.spi.access.SoftLock lock) Called after Hibernate updated object in the database and transaction successfully completed.
protected Object	get(Object key) Gets value from cache.
protected boolean	insert(Object key, Object val) Called after Hibernate inserted object in the database but before transaction completed.
protected org.hibernate.cache.spi.access.SoftLock	lock(Object key) Called during database transaction execution before Hibernate attempts to update or remove given key.
protected void	putFromLoad(Object key, Object val) Puts in cache value loaded from the database.
protected void	remove(Object key) Called after Hibernate removed object from database but before transaction completed.
protected void	unlock(Object key, org.hibernate.cache.spi.access.SoftLock lock) Called after Hibernate failed to update or successfully removed given key.
protected boolean	update(Object key, Object val) Called after Hibernate updated object in the database but before transaction completed.

Methods inherited from class org.gridgain.grid.cache.hibernate.GridHibernateAccessStrategyAdapter

evict, evictAll, lockRegion, putFromLoad, removeAll, unlockRegion

Methods inherited from class java.lang.Object

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

Constructor Detail

GridHibernateReadWriteAccessStrategy

protected GridHibernateReadWriteAccessStrategy(org.gridgain.grid.Grid grid,
                                    org.gridgain.grid.cache.GridCache<Object,Object> cache,
                                    ThreadLocal txCtx)

Parameters:

grid - Grid.

cache - Cache.

txCtx - Thread local instance used to track updates done during one Hibernate transaction.

Method Detail

get

protected Object get(Object key)
              throws org.hibernate.cache.CacheException

Gets value from cache. Used by RegionAccessStrategy.get(java.lang.Object, long).

Overrides:

get in class GridHibernateAccessStrategyAdapter

Parameters:

key - Key.

Returns:

Cached value.

Throws:

org.hibernate.cache.CacheException - If failed.

putFromLoad

protected void putFromLoad(Object key,
               Object val)
                    throws org.hibernate.cache.CacheException

Puts in cache value loaded from the database. Used by RegionAccessStrategy.putFromLoad(java.lang.Object, java.lang.Object, long, java.lang.Object).

Overrides:

putFromLoad in class GridHibernateAccessStrategyAdapter

Parameters:

key - Key.

val - Value.

Throws:

org.hibernate.cache.CacheException - If failed.

lock

protected org.hibernate.cache.spi.access.SoftLock lock(Object key)
                                                throws org.hibernate.cache.CacheException

Called during database transaction execution before Hibernate attempts to update or remove given key. Used by RegionAccessStrategy.lockItem(java.lang.Object, java.lang.Object).

Specified by:

lock in class GridHibernateAccessStrategyAdapter

Parameters:

key - Key.

Returns:

Lock representation or null.

Throws:

org.hibernate.cache.CacheException - If failed.

unlock

protected void unlock(Object key,
          org.hibernate.cache.spi.access.SoftLock lock)
               throws org.hibernate.cache.CacheException

Called after Hibernate failed to update or successfully removed given key. Used by RegionAccessStrategy.unlockItem(java.lang.Object, org.hibernate.cache.spi.access.SoftLock).

Specified by:

unlock in class GridHibernateAccessStrategyAdapter

Parameters:

key - Key.

lock - The lock previously obtained from GridHibernateAccessStrategyAdapter.lock(java.lang.Object)

Throws:

org.hibernate.cache.CacheException - If failed.

update

protected boolean update(Object key,
             Object val)
                  throws org.hibernate.cache.CacheException

Called after Hibernate updated object in the database but before transaction completed. Used by EntityRegionAccessStrategy.update(java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object) and NaturalIdRegionAccessStrategy.update(java.lang.Object, java.lang.Object).

Specified by:

update in class GridHibernateAccessStrategyAdapter

Parameters:

key - Key.

val - Value.

Returns:

True if operation updated cache.

Throws:

org.hibernate.cache.CacheException - If failed.

afterUpdate

protected boolean afterUpdate(Object key,
                  Object val,
                  org.hibernate.cache.spi.access.SoftLock lock)
                       throws org.hibernate.cache.CacheException

Called after Hibernate updated object in the database and transaction successfully completed. Used by EntityRegionAccessStrategy.afterUpdate(java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object, org.hibernate.cache.spi.access.SoftLock) and NaturalIdRegionAccessStrategy.afterUpdate(java.lang.Object, java.lang.Object, org.hibernate.cache.spi.access.SoftLock).

Specified by:

afterUpdate in class GridHibernateAccessStrategyAdapter

Parameters:

key - Key.

val - Value.

lock - The lock previously obtained from GridHibernateAccessStrategyAdapter.lock(java.lang.Object)

Returns:

True if operation updated cache.

Throws:

org.hibernate.cache.CacheException - If failed.

insert

protected boolean insert(Object key,
             Object val)
                  throws org.hibernate.cache.CacheException

Called after Hibernate inserted object in the database but before transaction completed. Used by EntityRegionAccessStrategy.insert(java.lang.Object, java.lang.Object, java.lang.Object) and NaturalIdRegionAccessStrategy.insert(java.lang.Object, java.lang.Object).

Specified by:

insert in class GridHibernateAccessStrategyAdapter

Parameters:

key - Key.

val - Value.

Returns:

True if operation updated cache.

Throws:

org.hibernate.cache.CacheException - If failed.

afterInsert

protected boolean afterInsert(Object key,
                  Object val)
                       throws org.hibernate.cache.CacheException

Called after Hibernate inserted object in the database and transaction successfully completed. Used by EntityRegionAccessStrategy.afterInsert(java.lang.Object, java.lang.Object, java.lang.Object) and NaturalIdRegionAccessStrategy.afterInsert(java.lang.Object, java.lang.Object).

Specified by:

afterInsert in class GridHibernateAccessStrategyAdapter

Parameters:

key - Key.

val - Value.

Returns:

True if operation updated cache.

Throws:

org.hibernate.cache.CacheException - If failed.

remove

protected void remove(Object key)
               throws org.hibernate.cache.CacheException

Called after Hibernate removed object from database but before transaction completed. Used by RegionAccessStrategy.remove(java.lang.Object).

Specified by:

remove in class GridHibernateAccessStrategyAdapter

Parameters:

key - Key,

Throws:

org.hibernate.cache.CacheException - If failed.