org.hibernate.cache.ehcache.internal.strategy

Class ReadWriteEhcacheNaturalIdRegionAccessStrategy

java.lang.Object

org.hibernate.cache.ehcache.internal.strategy.ReadWriteEhcacheNaturalIdRegionAccessStrategy

All Implemented Interfaces:

NaturalIdRegionAccessStrategy, RegionAccessStrategy

public class ReadWriteEhcacheNaturalIdRegionAccessStrategy
extends java.lang.Object
implements NaturalIdRegionAccessStrategy

Ehcache specific read/write NaturalId 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
ReadWriteEhcacheNaturalIdRegionAccessStrategy(EhcacheNaturalIdRegion region, SessionFactoryOptions settings) Create a read/write access strategy accessing the given NaturalId region.

Method Summary

Modifier and Type	Method and Description
boolean	afterInsert(SessionImplementor session, java.lang.Object key, java.lang.Object value) Called after an item has been inserted (after the transaction completes), instead of calling release().
boolean	afterUpdate(SessionImplementor session, java.lang.Object key, java.lang.Object value, SoftLock lock) Called after an item has been updated (after the transaction completes), instead of calling release().
protected void	decrementLock(java.lang.Object key, org.hibernate.cache.ehcache.internal.strategy.AbstractReadWriteEhcacheAccessStrategy.Lock lock) Unlock and re-put the given key, lock combination.
void	evict(java.lang.Object key) Remove the given mapping without regard to transactional safety
void	evictAll() Remove all mappings without regard to transactional safety
java.lang.Object	generateCacheKey(java.lang.Object[] naturalIdValues, EntityPersister persister, SessionImplementor session) To create instances of NaturalIdCacheKey for this region, Hibernate will invoke this method exclusively so that generated implementations can generate optimised keys.
java.lang.Object	get(SessionImplementor session, java.lang.Object key, long txTimestamp) Returns null if the item is not readable.
java.lang.Object[]	getNaturalIdValues(java.lang.Object cacheKey) Performs reverse operation to NaturalIdRegionAccessStrategy.generateCacheKey(Object[], EntityPersister, SessionImplementor), returning the original naturalIdValues.
NaturalIdRegion	getRegion() Get the wrapped naturalId cache region
protected void	handleLockExpiry(java.lang.Object key, org.hibernate.cache.ehcache.internal.strategy.AbstractReadWriteEhcacheAccessStrategy.Lockable lock) Handle the timeout of a previous lock mapped to this key
boolean	insert(SessionImplementor session, java.lang.Object key, java.lang.Object value) Called after an item has been inserted (before the transaction completes), instead of calling evict().
SoftLock	lockItem(SessionImplementor session, java.lang.Object key, java.lang.Object version) Soft-lock a cache item.
SoftLock	lockRegion() Region locks are not supported.
boolean	putFromLoad(SessionImplementor session, java.lang.Object key, java.lang.Object value, long txTimestamp, java.lang.Object version) This method is a placeholder for method signatures supplied by interfaces pulled in further down the class hierarchy.
boolean	putFromLoad(SessionImplementor session, java.lang.Object key, java.lang.Object value, long txTimestamp, java.lang.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, java.lang.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, java.lang.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(SessionImplementor session, java.lang.Object key, java.lang.Object value) Called after an item has been updated (before the transaction completes), instead of calling evict().

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

ReadWriteEhcacheNaturalIdRegionAccessStrategy

public ReadWriteEhcacheNaturalIdRegionAccessStrategy(EhcacheNaturalIdRegion region,
                                                     SessionFactoryOptions settings)

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

Parameters:

region - The wrapped region

settings - The Hibernate settings

Method Detail

getRegion

public NaturalIdRegion getRegion()

Description copied from interface: NaturalIdRegionAccessStrategy

Get the wrapped naturalId cache region

Specified by:

getRegion in interface NaturalIdRegionAccessStrategy

Returns:

The underlying region

insert

public boolean insert(SessionImplementor session,
                      java.lang.Object key,
                      java.lang.Object value)
               throws CacheException

Called after an item has been inserted (before the transaction completes), instead of calling evict(). This method is used by "synchronous" concurrency strategies.

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

Specified by:

insert in interface NaturalIdRegionAccessStrategy

Parameters:

session - Current session

key - The item key

value - The item

Returns:

Were the contents of the cache actual changed by this operation?

Throws:

CacheException - Propagated from underlying Region

afterInsert

public boolean afterInsert(SessionImplementor session,
                           java.lang.Object key,
                           java.lang.Object value)
                    throws CacheException

Called after an item has been inserted (after the transaction completes), instead of calling release(). This method is used by "asynchronous" concurrency strategies.

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

Specified by:

afterInsert in interface NaturalIdRegionAccessStrategy

Parameters:

session - Current session

key - The item key

value - The item

Returns:

Were the contents of the cache actual changed by this operation?

Throws:

CacheException - Propagated from underlying Region

update

public boolean update(SessionImplementor session,
                      java.lang.Object key,
                      java.lang.Object value)
               throws CacheException

Called after an item has been updated (before the transaction completes), instead of calling evict(). This method is used by "synchronous" concurrency strategies.

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

Specified by:

update in interface NaturalIdRegionAccessStrategy

Parameters:

session - Current session

key - The item key

value - The item

Returns:

Were the contents of the cache actual changed by this operation?

Throws:

CacheException - Propagated from underlying Region

afterUpdate

public boolean afterUpdate(SessionImplementor session,
                           java.lang.Object key,
                           java.lang.Object value,
                           SoftLock lock)
                    throws CacheException

Called after an item has been updated (after the transaction completes), instead of calling release(). This method is used by "asynchronous" concurrency strategies.

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.

Specified by:

afterUpdate in interface NaturalIdRegionAccessStrategy

Parameters:

session - Current session

key - The item key

value - The item

lock - The lock previously obtained from RegionAccessStrategy.lockItem(org.hibernate.engine.spi.SessionImplementor, java.lang.Object, java.lang.Object)

Returns:

Were the contents of the cache actual changed by this operation?

Throws:

CacheException - Propogated from underlying Region

generateCacheKey

public java.lang.Object generateCacheKey(java.lang.Object[] naturalIdValues,
                                         EntityPersister persister,
                                         SessionImplementor session)

Description copied from interface: NaturalIdRegionAccessStrategy

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

Specified by:

generateCacheKey in interface NaturalIdRegionAccessStrategy

Parameters:

naturalIdValues - the sequence of values which unequivocally identifies a cached element on this region

persister - the persister of the element being cached

Returns:

a key which can be used to identify this an element unequivocally on this same region

getNaturalIdValues

public java.lang.Object[] getNaturalIdValues(java.lang.Object cacheKey)

Description copied from interface: NaturalIdRegionAccessStrategy

Performs reverse operation to NaturalIdRegionAccessStrategy.generateCacheKey(Object[], EntityPersister, SessionImplementor), returning the original naturalIdValues.

Specified by:

getNaturalIdValues in interface NaturalIdRegionAccessStrategy

Parameters:

cacheKey - key returned from NaturalIdRegionAccessStrategy.generateCacheKey(Object[], EntityPersister, SessionImplementor)

Returns:

the sequence of values which unequivocally identifies a cached element on this region

get

public final java.lang.Object get(SessionImplementor session,
                                  java.lang.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,
                                 java.lang.Object key,
                                 java.lang.Object value,
                                 long txTimestamp,
                                 java.lang.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,
                               java.lang.Object key,
                               java.lang.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,
                             java.lang.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(java.lang.Object key,
                             org.hibernate.cache.ehcache.internal.strategy.AbstractReadWriteEhcacheAccessStrategy.Lock lock)

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

handleLockExpiry

protected void handleLockExpiry(java.lang.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,
                                 java.lang.Object key,
                                 java.lang.Object value,
                                 long txTimestamp,
                                 java.lang.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,
                   java.lang.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(java.lang.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()