ehcache

net.sf.ehcache.hibernate.strategy
Class TransactionalEhcacheEntityRegionAccessStrategy

java.lang.Object
  extended by net.sf.ehcache.hibernate.strategy.TransactionalEhcacheEntityRegionAccessStrategy

public class TransactionalEhcacheEntityRegionAccessStrategy
extends Object

JTA EntityRegionAccessStrategy.

Author:
Chris Dennis, Ludovic Orban

Field Summary
protected  T region
          The wrapped Hibernate cache region.
protected  Settings settings
          The settings for this persistence unit.
 
Constructor Summary
TransactionalEhcacheEntityRegionAccessStrategy(EhcacheEntityRegion region, Ehcache ehcache, Settings settings)
          Construct a new entity region access strategy.
 
Method Summary
 boolean afterInsert(Object key, Object value, Object version)
          
 boolean afterUpdate(Object key, Object value, Object currentVersion, Object previousVersion, SoftLock lock)
          
 void evict(Object key)
          Remove the given mapping without regard to transactional safety
 void evictAll()
          Remove all mappings without regard to transactional safety
 Object get(Object key, long txTimestamp)
          
 EntityRegion getRegion()
          
 boolean insert(Object key, Object value, Object version)
          
 SoftLock lockItem(Object key, Object version)
          
 SoftLock lockRegion()
          Region locks are not supported.
 boolean putFromLoad(Object key, Object value, long txTimestamp, Object version)
          This method is a placeholder for method signatures supplied by interfaces pulled in further down the class hierarchy.
 boolean putFromLoad(Object key, Object value, long txTimestamp, Object version, boolean minimalPutOverride)
          This method is a placeholder for method signatures supplied by interfaces pulled in further down the class hierarchy.
 void remove(Object key)
          A no-op since this is an asynchronous cache access strategy.
 void removeAll()
          Called to evict data from the entire region
 void unlockItem(Object key, SoftLock lock)
          
 void unlockRegion(SoftLock lock)
          Region locks are not supported - perform a cache clear as a precaution.
 boolean update(Object key, Object value, Object currentVersion, Object previousVersion)
          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

region

protected final T extends EhcacheTransactionalDataRegion region
The wrapped Hibernate cache region.


settings

protected final Settings settings
The settings for this persistence unit.

Constructor Detail

TransactionalEhcacheEntityRegionAccessStrategy

public TransactionalEhcacheEntityRegionAccessStrategy(EhcacheEntityRegion region,
                                                      Ehcache ehcache,
                                                      Settings settings)
Construct a new entity region access strategy.

Parameters:
region - the Hibernate region.
ehcache - the cache.
settings - the Hibernate settings.
Method Detail

afterInsert

public boolean afterInsert(Object key,
                           Object value,
                           Object version)


afterUpdate

public boolean afterUpdate(Object key,
                           Object value,
                           Object currentVersion,
                           Object previousVersion,
                           SoftLock lock)


get

public Object get(Object key,
                  long txTimestamp)
           throws CacheException

Throws:
CacheException

getRegion

public EntityRegion getRegion()


insert

public boolean insert(Object key,
                      Object value,
                      Object version)
               throws CacheException

Throws:
CacheException

lockItem

public SoftLock lockItem(Object key,
                         Object version)
                  throws CacheException

Throws:
CacheException

putFromLoad

public boolean putFromLoad(Object key,
                           Object value,
                           long txTimestamp,
                           Object version,
                           boolean minimalPutOverride)
                    throws CacheException
This method is a placeholder for method signatures supplied by interfaces pulled in further down the class hierarchy.

Throws:
CacheException
See Also:
org.hibernate.cache.access.EntityRegionAccessStrategy#putFromLoad(java.lang.Object, java.lang.Object, long, java.lang.Object, boolean), org.hibernate.cache.access.CollectionRegionAccessStrategy#putFromLoad(java.lang.Object, java.lang.Object, long, java.lang.Object, boolean)

remove

public void remove(Object key)
            throws CacheException
A no-op since this is an asynchronous cache access strategy.

Throws:
CacheException
See Also:
org.hibernate.cache.access.EntityRegionAccessStrategy#remove(java.lang.Object), org.hibernate.cache.access.CollectionRegionAccessStrategy#remove(java.lang.Object)

unlockItem

public void unlockItem(Object key,
                       SoftLock lock)
                throws CacheException

Throws:
CacheException

update

public boolean update(Object key,
                      Object value,
                      Object currentVersion,
                      Object previousVersion)
               throws CacheException

Throws:
CacheException

putFromLoad

public final boolean putFromLoad(Object key,
                                 Object value,
                                 long txTimestamp,
                                 Object version)
                          throws CacheException
This method is a placeholder for method signatures supplied by interfaces pulled in further down the class hierarchy.

Throws:
CacheException
See Also:
org.hibernate.cache.access.EntityRegionAccessStrategy#putFromLoad(java.lang.Object, java.lang.Object, long, java.lang.Object), org.hibernate.cache.access.CollectionRegionAccessStrategy#putFromLoad(java.lang.Object, java.lang.Object, long, java.lang.Object)

lockRegion

public final SoftLock lockRegion()
Region locks are not supported.

Returns:
null
See Also:
org.hibernate.cache.access.EntityRegionAccessStrategy#lockRegion(), org.hibernate.cache.access.CollectionRegionAccessStrategy#lockRegion()

unlockRegion

public final void unlockRegion(SoftLock lock)
                        throws CacheException
Region locks are not supported - perform a cache clear as a precaution.

Throws:
CacheException
See Also:
org.hibernate.cache.access.EntityRegionAccessStrategy#unlockRegion(org.hibernate.cache.access.SoftLock), org.hibernate.cache.access.CollectionRegionAccessStrategy#unlockRegion(org.hibernate.cache.access.SoftLock)

removeAll

public final void removeAll()
                     throws CacheException
Called to evict data from the entire region

Throws:
CacheException - Propogated from underlying org.hibernate.cache.Region
See Also:
org.hibernate.cache.access.EntityRegionAccessStrategy#removeAll(), org.hibernate.cache.access.CollectionRegionAccessStrategy#removeAll()

evict

public final void evict(Object key)
                 throws CacheException
Remove the given mapping without regard to transactional safety

Throws:
CacheException
See Also:
org.hibernate.cache.access.EntityRegionAccessStrategy#evict(java.lang.Object), org.hibernate.cache.access.CollectionRegionAccessStrategy#evict(java.lang.Object)

evictAll

public final void evictAll()
                    throws CacheException
Remove all mappings without regard to transactional safety

Throws:
CacheException
See Also:
org.hibernate.cache.access.EntityRegionAccessStrategy#evictAll(), org.hibernate.cache.access.CollectionRegionAccessStrategy#evictAll()

ehcache

Copyright 2001-2014, Terracotta, Inc.