net.sf.ehcache.hibernate.strategy
Class ReadWriteEhcacheEntityRegionAccessStrategy

java.lang.Object
  net.sf.ehcache.hibernate.strategy.ReadWriteEhcacheEntityRegionAccessStrategy

public class ReadWriteEhcacheEntityRegionAccessStrategy
extends Object

Ehcache specific read/write entity region access strategy

Author:

Chris Dennis

Nested Class Summary

protected static class	AbstractReadWriteEhcacheAccessStrategy.Item Wrapper type representing unlocked items.
protected static class	AbstractReadWriteEhcacheAccessStrategy.Lock Wrapper type representing locked items.
protected static interface	AbstractReadWriteEhcacheAccessStrategy.Lockable Interface type implemented by all wrapper objects in the cache.

Field Summary

protected T	region The wrapped Hibernate cache region.
protected Settings	settings The settings for this persistence unit.

Constructor Summary

ReadWriteEhcacheEntityRegionAccessStrategy(EhcacheEntityRegion region, Settings settings)
Create a read/write 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, SoftLock lock)
protected void	decrementLock(Object key, AbstractReadWriteEhcacheAccessStrategy.Lock lock) Unlock and re-put the given key, lock combination.
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) Returns null if the item is not readable.
EntityRegion	getRegion()
protected void	handleMissingLock(Object key, AbstractReadWriteEhcacheAccessStrategy.Lockable lock) Handle the timeout of a previous lock mapped to this key
boolean	insert(Object key, Object value, Object version) A no-op since this is an asynchronous cache access strategy.
SoftLock	lockItem(Object key, Object version) Soft-lock a cache item.
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) Returns false and fails to put the value if there is an existing un-writeable item mapped to this key.
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) Soft-unlock a cache item.
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) A no-op since this is an asynchronous cache access strategy.

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

ReadWriteEhcacheEntityRegionAccessStrategy

public ReadWriteEhcacheEntityRegionAccessStrategy(EhcacheEntityRegion region,
                                                  Settings settings)

Create a read/write access strategy accessing the given entity region.

Method Detail

getRegion

public EntityRegion getRegion()

insert

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

A no-op since this is an asynchronous cache access strategy.

Throws:

CacheException

afterInsert

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

Inserts will only succeed if there is no existing value mapped to this key.

Throws:

CacheException

update

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

A no-op since this is an asynchronous cache access strategy.

Throws:

CacheException

afterUpdate

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

Updates will only succeed if this entry was locked by this transaction and exclusively this transaction for the duration of this transaction. It is important to also note that updates will fail if the soft-lock expired during the course of this transaction.

Throws:

CacheException

get

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

Returns null if the item is not readable. Locked items are not readable, nor are items created after the start of this transaction.

Throws:

CacheException

See Also:

org.hibernate.cache.access.EntityRegionAccessStrategy#get(java.lang.Object, long), org.hibernate.cache.access.CollectionRegionAccessStrategy#get(java.lang.Object, long)

putFromLoad

public final boolean putFromLoad(Object key,
                                 Object value,
                                 long txTimestamp,
                                 Object version,
                                 boolean minimalPutOverride)
                          throws CacheException

Returns false and fails to put the value if there is an existing un-writeable item mapped to this key.

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)

lockItem

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

Soft-lock a cache item.

Throws:

CacheException

See Also:

org.hibernate.cache.access.EntityRegionAccessStrategy#lockItem(java.lang.Object, java.lang.Object), org.hibernate.cache.access.CollectionRegionAccessStrategy#lockItem(java.lang.Object, java.lang.Object)

unlockItem

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

Soft-unlock a cache item.

Throws:

CacheException

See Also:

org.hibernate.cache.access.EntityRegionAccessStrategy#unlockItem(java.lang.Object, org.hibernate.cache.access.SoftLock), org.hibernate.cache.access.CollectionRegionAccessStrategy#unlockItem(java.lang.Object, org.hibernate.cache.access.SoftLock)

decrementLock

protected void decrementLock(Object key,
                             AbstractReadWriteEhcacheAccessStrategy.Lock lock)

Unlock and re-put the given key, lock combination.

handleMissingLock

protected void handleMissingLock(Object key,
                                 AbstractReadWriteEhcacheAccessStrategy.Lockable lock)

Handle the timeout of a previous lock mapped to this key

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)

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)

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()