ehcache

net.sf.ehcache.hibernate.strategy
Class ReadOnlyEhcacheEntityRegionAccessStrategy

java.lang.Object
  extended by net.sf.ehcache.hibernate.strategy.ReadOnlyEhcacheEntityRegionAccessStrategy
All Implemented Interfaces:
org.hibernate.cache.access.EntityRegionAccessStrategy

public class ReadOnlyEhcacheEntityRegionAccessStrategy
extends Object
implements org.hibernate.cache.access.EntityRegionAccessStrategy

Ehcache specific read-only entity region access strategy

Author:
Chris Dennis

Field Summary
protected  T region
          The wrapped Hibernate cache region.
protected  org.hibernate.cfg.Settings settings
          The settings for this persistence unit.
 
Constructor Summary
ReadOnlyEhcacheEntityRegionAccessStrategy(EhcacheEntityRegion region, org.hibernate.cfg.Settings settings)
          Create a read-only access strategy accessing the given entity region.
 
Method Summary
 boolean afterInsert(Object key, Object value, Object version)
          
 boolean afterUpdate(Object key, Object value, Object currentVersion, Object previousVersion, org.hibernate.cache.access.SoftLock lock)
          Throws UnsupportedOperationException since this cache is read-only
 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)
          
 org.hibernate.cache.EntityRegion getRegion()
          
 boolean insert(Object key, Object value, Object version)
          This cache is asynchronous hence a no-op
 org.hibernate.cache.access.SoftLock lockItem(Object key, Object version)
          Throws UnsupportedOperationException since this cache is read-only
 org.hibernate.cache.access.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, org.hibernate.cache.access.SoftLock lock)
          A no-op since this cache is read-only
 void unlockRegion(org.hibernate.cache.access.SoftLock lock)
          Region locks are not supported - perform a cache clear as a precaution.
 boolean update(Object key, Object value, Object currentVersion, Object previousVersion)
          Throws UnsupportedOperationException since this cache is read-only
 
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.access.EntityRegionAccessStrategy
evict, evictAll, lockRegion, putFromLoad, remove, removeAll, unlockRegion
 

Field Detail

region

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


settings

protected final org.hibernate.cfg.Settings settings
The settings for this persistence unit.

Constructor Detail

ReadOnlyEhcacheEntityRegionAccessStrategy

public ReadOnlyEhcacheEntityRegionAccessStrategy(EhcacheEntityRegion region,
                                                 org.hibernate.cfg.Settings settings)
Create a read-only access strategy accessing the given entity region.

Method Detail

getRegion

public org.hibernate.cache.EntityRegion getRegion()

Specified by:
getRegion in interface org.hibernate.cache.access.EntityRegionAccessStrategy

get

public Object get(Object key,
                  long txTimestamp)
           throws org.hibernate.cache.CacheException

Specified by:
get in interface org.hibernate.cache.access.EntityRegionAccessStrategy
Throws:
org.hibernate.cache.CacheException

putFromLoad

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

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

lockItem

public org.hibernate.cache.access.SoftLock lockItem(Object key,
                                                    Object version)
                                             throws UnsupportedOperationException
Throws UnsupportedOperationException since this cache is read-only

Specified by:
lockItem in interface org.hibernate.cache.access.EntityRegionAccessStrategy
Throws:
UnsupportedOperationException - always

unlockItem

public void unlockItem(Object key,
                       org.hibernate.cache.access.SoftLock lock)
                throws org.hibernate.cache.CacheException
A no-op since this cache is read-only

Specified by:
unlockItem in interface org.hibernate.cache.access.EntityRegionAccessStrategy
Throws:
org.hibernate.cache.CacheException

insert

public boolean insert(Object key,
                      Object value,
                      Object version)
               throws org.hibernate.cache.CacheException
This cache is asynchronous hence a no-op

Specified by:
insert in interface org.hibernate.cache.access.EntityRegionAccessStrategy
Throws:
org.hibernate.cache.CacheException

afterInsert

public boolean afterInsert(Object key,
                           Object value,
                           Object version)
                    throws org.hibernate.cache.CacheException

Specified by:
afterInsert in interface org.hibernate.cache.access.EntityRegionAccessStrategy
Throws:
org.hibernate.cache.CacheException

update

public boolean update(Object key,
                      Object value,
                      Object currentVersion,
                      Object previousVersion)
               throws UnsupportedOperationException
Throws UnsupportedOperationException since this cache is read-only

Specified by:
update in interface org.hibernate.cache.access.EntityRegionAccessStrategy
Throws:
UnsupportedOperationException - always

afterUpdate

public boolean afterUpdate(Object key,
                           Object value,
                           Object currentVersion,
                           Object previousVersion,
                           org.hibernate.cache.access.SoftLock lock)
                    throws UnsupportedOperationException
Throws UnsupportedOperationException since this cache is read-only

Specified by:
afterUpdate in interface org.hibernate.cache.access.EntityRegionAccessStrategy
Throws:
UnsupportedOperationException - always

putFromLoad

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

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

lockRegion

public final org.hibernate.cache.access.SoftLock lockRegion()
Region locks are not supported.

Returns:
null
See Also:
EntityRegionAccessStrategy.lockRegion(), CollectionRegionAccessStrategy.lockRegion()

unlockRegion

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

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

remove

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

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

removeAll

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

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

evict

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

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

evictAll

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

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

ehcache

Copyright © 2003-2014 Terracotta, Inc.. All Rights Reserved.