com.hazelcast.hibernate.access

Class AbstractAccessDelegate<T extends HazelcastRegion>

java.lang.Object

com.hazelcast.hibernate.access.AbstractAccessDelegate<T>

Type Parameters:

T - implementation type of HazelcastRegion

All Implemented Interfaces:

AccessDelegate<T>

Direct Known Subclasses:

NonStrictReadWriteAccessDelegate, ReadWriteAccessDelegate

public abstract class AbstractAccessDelegate<T extends HazelcastRegion>
extends Object
implements AccessDelegate<T>

Base implementation for consistency guarantees

Author:

Leo Kim (lkim@limewire.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected RegionCache	cache
protected T	hazelcastRegion
protected ILogger	log
protected Comparator<Object>	versionComparator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAccessDelegate(T hazelcastRegion, Properties props)

Method Summary

Methods

Modifier and Type	Method and Description
void	evict(Object key) Forcibly evict an item from the cache immediately without regard for transaction isolation.
void	evictAll() Forcibly evict all items from the cache immediately without regard for transaction isolation.
Object	get(Object key, long txTimestamp) Attempt to retrieve an object from the cache.
T	getHazelcastRegion() Get the wrapped cache region
SoftLock	lockRegion() NO-OP
boolean	putFromLoad(Object key, Object value, long txTimestamp, Object version) Attempt to cache an object, after loading from the database.
boolean	putFromLoad(Object key, Object value, long txTimestamp, Object version, boolean minimalPuts) Attempt to cache an object, after loading from the database, explicitly specifying the minimalPut behavior.
void	unlockRegion(SoftLock lock) Called after we have finished the attempted invalidation of the entire region

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.hazelcast.hibernate.access.AccessDelegate

afterInsert, afterUpdate, insert, lockItem, remove, removeAll, unlockItem, update

Field Detail

log

protected final ILogger log

hazelcastRegion

protected final T extends HazelcastRegion hazelcastRegion

cache

protected final RegionCache cache

versionComparator

protected final Comparator<Object> versionComparator

Constructor Detail

AbstractAccessDelegate

protected AbstractAccessDelegate(T hazelcastRegion,
                      Properties props)

Method Detail

getHazelcastRegion

public final T getHazelcastRegion()

Description copied from interface: AccessDelegate

Get the wrapped cache region

Specified by:

getHazelcastRegion in interface AccessDelegate<T extends HazelcastRegion>

Returns:

The underlying region

get

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

Description copied from interface: AccessDelegate

Attempt to retrieve an object from the cache. Mainly used in attempting to resolve entities/collections from the second level cache.

Specified by:

get in interface AccessDelegate<T extends HazelcastRegion>

Parameters:

key - The key of the item to be retrieved.

txTimestamp - a timestamp prior to the transaction start time

Returns:

the cached object or null

Throws:

org.hibernate.cache.CacheException - Propagated from underlying org.hibernate.cache.Region

putFromLoad

public boolean putFromLoad(Object key,
                  Object value,
                  long txTimestamp,
                  Object version)
                    throws org.hibernate.cache.CacheException

Description copied from interface: AccessDelegate

Attempt to cache an object, after loading from the database.

Specified by:

putFromLoad in interface AccessDelegate<T extends HazelcastRegion>

Parameters:

key - The item key

value - The item

txTimestamp - a timestamp prior to the transaction start time

version - the item version number

Returns:

true if the object was successfully cached

Throws:

org.hibernate.cache.CacheException - Propagated from underlying org.hibernate.cache.Region

putFromLoad

public boolean putFromLoad(Object key,
                  Object value,
                  long txTimestamp,
                  Object version,
                  boolean minimalPuts)
                    throws org.hibernate.cache.CacheException

Description copied from interface: AccessDelegate

Attempt to cache an object, after loading from the database, explicitly specifying the minimalPut behavior.

Specified by:

putFromLoad in interface AccessDelegate<T extends HazelcastRegion>

Parameters:

key - The item key

value - The item

txTimestamp - a timestamp prior to the transaction start time

version - the item version number

minimalPuts - Explicit minimalPut flag

Returns:

true if the object was successfully cached

Throws:

org.hibernate.cache.CacheException - Propagated from underlying org.hibernate.cache.Region

evict

public void evict(Object key)
           throws org.hibernate.cache.CacheException

Description copied from interface: AccessDelegate

Forcibly evict an item from the cache immediately without regard for transaction isolation.

Specified by:

evict in interface AccessDelegate<T extends HazelcastRegion>

Parameters:

key - The key of the item to remove

Throws:

org.hibernate.cache.CacheException - Propagated from underlying org.hibernate.cache.Region

evictAll

public void evictAll()
              throws org.hibernate.cache.CacheException

Description copied from interface: AccessDelegate

Forcibly evict all items from the cache immediately without regard for transaction isolation.

Specified by:

evictAll in interface AccessDelegate<T extends HazelcastRegion>

Throws:

org.hibernate.cache.CacheException - Propagated from underlying org.hibernate.cache.Region

lockRegion

public SoftLock lockRegion()
                    throws org.hibernate.cache.CacheException

NO-OP

Specified by:

lockRegion in interface AccessDelegate<T extends HazelcastRegion>

Returns:

A representation of our lock on the item; or null.

Throws:

org.hibernate.cache.CacheException - Propagated from underlying org.hibernate.cache.Region

unlockRegion

public void unlockRegion(SoftLock lock)
                  throws org.hibernate.cache.CacheException

Description copied from interface: AccessDelegate

Called after we have finished the attempted invalidation of the entire region

Specified by:

unlockRegion in interface AccessDelegate<T extends HazelcastRegion>

Parameters:

lock - The lock previously obtained from AccessDelegate.lockRegion()

Throws:

org.hibernate.cache.CacheException - Propagated from underlying org.hibernate.cache.Region