net.sf.ehcache.hibernate.strategy
Class ReadOnlyEhcacheCollectionRegionAccessStrategy

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

All Implemented Interfaces:

org.hibernate.cache.access.CollectionRegionAccessStrategy

public class ReadOnlyEhcacheCollectionRegionAccessStrategy
extends Object
implements org.hibernate.cache.access.CollectionRegionAccessStrategy

Ehcache specific read-only collection 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

ReadOnlyEhcacheCollectionRegionAccessStrategy(EhcacheCollectionRegion region, org.hibernate.cfg.Settings settings)
Create a read-only access strategy accessing the given collection region.

Method Summary

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.CollectionRegion	getRegion()
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.

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.CollectionRegionAccessStrategy

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

ReadOnlyEhcacheCollectionRegionAccessStrategy

public ReadOnlyEhcacheCollectionRegionAccessStrategy(EhcacheCollectionRegion region,
                                                     org.hibernate.cfg.Settings settings)

Create a read-only access strategy accessing the given collection region.

Method Detail

getRegion

public org.hibernate.cache.CollectionRegion getRegion()

Specified by:

getRegion in interface org.hibernate.cache.access.CollectionRegionAccessStrategy

get

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

Specified by:

get in interface org.hibernate.cache.access.CollectionRegionAccessStrategy

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.CollectionRegionAccessStrategy

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.CollectionRegionAccessStrategy

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.CollectionRegionAccessStrategy

Throws:

org.hibernate.cache.CacheException

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