org.hibernate.cache.ehcache.internal.strategy

Class ReadWriteEhcacheCollectionRegionAccessStrategy

java.lang.Object

org.hibernate.cache.ehcache.internal.strategy.ReadWriteEhcacheCollectionRegionAccessStrategy

All Implemented Interfaces:

CollectionRegionAccessStrategy, RegionAccessStrategy

public class ReadWriteEhcacheCollectionRegionAccessStrategy
extends Object
implements CollectionRegionAccessStrategy

Ehcache specific read/write collection region access strategy

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	org.hibernate.cache.ehcache.internal.strategy.AbstractReadWriteEhcacheAccessStrategy.Item Wrapper type representing unlocked items.
protected static class	org.hibernate.cache.ehcache.internal.strategy.AbstractReadWriteEhcacheAccessStrategy.Lock Wrapper type representing locked items.
protected static interface	org.hibernate.cache.ehcache.internal.strategy.AbstractReadWriteEhcacheAccessStrategy.Lockable Interface type implemented by all wrapper objects in the cache.

Constructor Summary

Constructors

Constructor and Description
ReadWriteEhcacheCollectionRegionAccessStrategy(EhcacheCollectionRegion region, SessionFactoryOptions settings) Create a read/write access strategy accessing the given collection region.

Method Summary

Modifier and Type	Method and Description
protected void	decrementLock(Object key, org.hibernate.cache.ehcache.internal.strategy.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	generateCacheKey(Object id, CollectionPersister persister, SessionFactoryImplementor factory, String tenantIdentifier) To create instances of CollectionCacheKey for this region, Hibernate will invoke this method exclusively so that generated implementations can generate optimised keys.
Object	get(SessionImplementor session, Object key, long txTimestamp) Returns null if the item is not readable.
Object	getCacheKeyId(Object cacheKey) Performs reverse operation to CollectionRegionAccessStrategy.generateCacheKey(Object, CollectionPersister, SessionFactoryImplementor, String)
CollectionRegion	getRegion() Get the wrapped collection cache region
protected void	handleLockExpiry(Object key, org.hibernate.cache.ehcache.internal.strategy.AbstractReadWriteEhcacheAccessStrategy.Lockable lock) Handle the timeout of a previous lock mapped to this key
SoftLock	lockItem(SessionImplementor session, Object key, Object version) Soft-lock a cache item.
SoftLock	lockRegion() Region locks are not supported.
boolean	putFromLoad(SessionImplementor session, 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(SessionImplementor session, 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.
protected T	region() The wrapped Hibernate cache region.
void	remove(SessionImplementor session, Object key) A no-op since this is an asynchronous cache access strategy.
void	removeAll() Called to evict data from the entire region
protected SessionFactoryOptions	settings() The settings for this persistence unit.
void	unlockItem(SessionImplementor session, 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.

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.spi.access.RegionAccessStrategy

evict, evictAll, get, lockItem, lockRegion, putFromLoad, putFromLoad, remove, removeAll, unlockItem, unlockRegion

Constructor Detail

ReadWriteEhcacheCollectionRegionAccessStrategy

public ReadWriteEhcacheCollectionRegionAccessStrategy(EhcacheCollectionRegion region,
                                                      SessionFactoryOptions settings)

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

Parameters:

region - The wrapped region

settings - The Hibernate settings

Method Detail

getRegion

public CollectionRegion getRegion()

Description copied from interface: CollectionRegionAccessStrategy

Get the wrapped collection cache region

Specified by:

getRegion in interface CollectionRegionAccessStrategy

Returns:

The underlying region

generateCacheKey

public Object generateCacheKey(Object id,
                               CollectionPersister persister,
                               SessionFactoryImplementor factory,
                               String tenantIdentifier)

Description copied from interface: CollectionRegionAccessStrategy

To create instances of CollectionCacheKey for this region, Hibernate will invoke this method exclusively so that generated implementations can generate optimised keys.

Specified by:

generateCacheKey in interface CollectionRegionAccessStrategy

Parameters:

id - the primary identifier of the Collection

persister - the persister for the type for which a key is being generated

factory - a reference to the current SessionFactory

tenantIdentifier - the tenant id, or null if multi-tenancy is not being used.

Returns:

a key which can be used to identify this collection on this same region

getCacheKeyId

public Object getCacheKeyId(Object cacheKey)

Description copied from interface: CollectionRegionAccessStrategy

Performs reverse operation to CollectionRegionAccessStrategy.generateCacheKey(Object, CollectionPersister, SessionFactoryImplementor, String)

Specified by:

getCacheKeyId in interface CollectionRegionAccessStrategy

Parameters:

cacheKey - key previously returned from CollectionRegionAccessStrategy.generateCacheKey(Object, CollectionPersister, SessionFactoryImplementor, String)

Returns:

original key passed to CollectionRegionAccessStrategy.generateCacheKey(Object, CollectionPersister, SessionFactoryImplementor, String)

get

public final Object get(SessionImplementor session,
                        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:

RegionAccessStrategy.get(SessionImplementor, Object, long), RegionAccessStrategy.get(SessionImplementor, Object, long)

putFromLoad

public final boolean putFromLoad(SessionImplementor session,
                                 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:

RegionAccessStrategy.putFromLoad(SessionImplementor, Object, Object, long, Object, boolean), RegionAccessStrategy.putFromLoad(SessionImplementor, Object, Object, long, Object, boolean)

lockItem

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

Soft-lock a cache item.

Throws:

CacheException

See Also:

RegionAccessStrategy.lockItem(SessionImplementor, Object, Object), RegionAccessStrategy.lockItem(SessionImplementor, Object, Object)

unlockItem

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

Soft-unlock a cache item.

Throws:

CacheException

See Also:

RegionAccessStrategy.unlockItem(SessionImplementor, Object, SoftLock), RegionAccessStrategy.unlockItem(SessionImplementor, Object, SoftLock)

decrementLock

protected void decrementLock(Object key,
                             org.hibernate.cache.ehcache.internal.strategy.AbstractReadWriteEhcacheAccessStrategy.Lock lock)

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

handleLockExpiry

protected void handleLockExpiry(Object key,
                                org.hibernate.cache.ehcache.internal.strategy.AbstractReadWriteEhcacheAccessStrategy.Lockable lock)

Handle the timeout of a previous lock mapped to this key

region

protected T region()

The wrapped Hibernate cache region.

settings

protected SessionFactoryOptions settings()

The settings for this persistence unit.

putFromLoad

public final boolean putFromLoad(SessionImplementor session,
                                 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:

RegionAccessStrategy.putFromLoad(SessionImplementor, Object, Object, long, Object), RegionAccessStrategy.putFromLoad(SessionImplementor, Object, Object, long, Object)

lockRegion

public final SoftLock lockRegion()

Region locks are not supported.

Returns:

null

See Also:

RegionAccessStrategy.lockRegion(), RegionAccessStrategy.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:

RegionAccessStrategy.unlockRegion(org.hibernate.cache.spi.access.SoftLock), RegionAccessStrategy.unlockRegion(org.hibernate.cache.spi.access.SoftLock)

remove

public void remove(SessionImplementor session,
                   Object key)
            throws CacheException

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

Throws:

CacheException

See Also:

RegionAccessStrategy.remove(SessionImplementor, Object), RegionAccessStrategy.remove(SessionImplementor, Object)

removeAll

public final void removeAll()
                     throws CacheException

Called to evict data from the entire region

Throws:

CacheException - Propogated from underlying Region

See Also:

RegionAccessStrategy.removeAll(), RegionAccessStrategy.removeAll()

evict

public final void evict(Object key)
                 throws CacheException

Remove the given mapping without regard to transactional safety

Throws:

CacheException

See Also:

RegionAccessStrategy.evict(java.lang.Object), RegionAccessStrategy.evict(java.lang.Object)

evictAll

public final void evictAll()
                    throws CacheException

Remove all mappings without regard to transactional safety

Throws:

CacheException

See Also:

RegionAccessStrategy.evictAll(), RegionAccessStrategy.evictAll()