com.hazelcast.hibernate.local

Class LocalRegionCache

java.lang.Object

com.hazelcast.hibernate.local.LocalRegionCache

All Implemented Interfaces:

RegionCache

Direct Known Subclasses:

TimestampsRegionCache

public class LocalRegionCache
extends Object
implements RegionCache

Local only RegionCache implementation based on a topic to distribute cache updates.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LocalRegionCache.EvictionConfig Generic representation of eviction-related configuration.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConcurrentMap<Object,Expirable>	cache
protected com.hazelcast.config.MapConfig	config
protected com.hazelcast.core.HazelcastInstance	hazelcastInstance
protected UUID	listenerRegistrationId
protected AtomicLong	markerIdCounter
protected com.hazelcast.topic.MessageListener<Object>	messageListener
protected com.hazelcast.topic.ITopic<Object>	topic
protected Comparator	versionComparator

Constructor Summary

Constructors

Constructor and Description
LocalRegionCache(String name, com.hazelcast.core.HazelcastInstance hazelcastInstance, org.hibernate.cache.spi.CacheDataDescription metadata)
LocalRegionCache(String name, com.hazelcast.core.HazelcastInstance hazelcastInstance, org.hibernate.cache.spi.CacheDataDescription metadata, boolean withTopic)
LocalRegionCache(String name, com.hazelcast.core.HazelcastInstance hazelcastInstance, org.hibernate.cache.spi.CacheDataDescription metadata, boolean withTopic, LocalRegionCache.EvictionConfig evictionConfig)

Method Summary

Modifier and Type	Method and Description
Map	asMap()
void	clear()
boolean	contains(Object key)
protected Object	createMessage(Object key, Object value, Object currentVersion)
protected com.hazelcast.topic.MessageListener<Object>	createMessageListener()
void	destroy()
Object	get(Object key, long txTimestamp)
long	getSizeInMemory()
boolean	insert(Object key, Object value, Object currentVersion)
protected void	maybeInvalidate(Object messageObject)
protected void	maybeNotifyTopic(Object key, Object value, Object version)
protected long	nextTimestamp()
boolean	put(Object key, Object value, long txTimestamp, Object version)
boolean	remove(Object key)
long	size()
org.hibernate.cache.spi.access.SoftLock	tryLock(Object key, Object version)
void	unlock(Object key, org.hibernate.cache.spi.access.SoftLock lock)
boolean	update(Object key, Object newValue, Object newVersion, org.hibernate.cache.spi.access.SoftLock softLock)

Methods inherited from class java.lang.Object

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

Field Detail

hazelcastInstance

protected final com.hazelcast.core.HazelcastInstance hazelcastInstance

topic

protected final com.hazelcast.topic.ITopic<Object> topic

listenerRegistrationId

protected final UUID listenerRegistrationId

messageListener

protected final com.hazelcast.topic.MessageListener<Object> messageListener

cache

protected final ConcurrentMap<Object,Expirable> cache

versionComparator

protected final Comparator versionComparator

markerIdCounter

protected final AtomicLong markerIdCounter

config

protected com.hazelcast.config.MapConfig config

Constructor Detail

LocalRegionCache

public LocalRegionCache(String name,
                        com.hazelcast.core.HazelcastInstance hazelcastInstance,
                        org.hibernate.cache.spi.CacheDataDescription metadata)

Parameters:

name - the name for this region cache, which is also used to retrieve configuration/topic

hazelcastInstance - the HazelcastInstance to which this region cache belongs, used to retrieve configuration and to lookup an ITopic to register a MessageListener with (optional)

metadata - metadata describing the cached data, used to compare data versions (optional)

LocalRegionCache

public LocalRegionCache(String name,
                        com.hazelcast.core.HazelcastInstance hazelcastInstance,
                        org.hibernate.cache.spi.CacheDataDescription metadata,
                        boolean withTopic)

Parameters:

name - the name for this region cache, which is also used to retrieve configuration/topic

hazelcastInstance - the HazelcastInstance to which this region cache belongs, used to retrieve configuration and to lookup an ITopic to register a MessageListener with if withTopic is true (optional)

metadata - metadata describing the cached data, used to compare data versions (optional)

withTopic - true to register a MessageListener with the ITopic whose name matches this region cache if a HazelcastInstance was provided to look up the topic; otherwise, false not to register a listener even if an instance was provided

LocalRegionCache

public LocalRegionCache(String name,
                        com.hazelcast.core.HazelcastInstance hazelcastInstance,
                        org.hibernate.cache.spi.CacheDataDescription metadata,
                        boolean withTopic,
                        LocalRegionCache.EvictionConfig evictionConfig)

Parameters:

name - the name for this region cache, which is also used to retrieve configuration/topic

hazelcastInstance - the HazelcastInstance to which this region cache belongs, used to retrieve configuration and to lookup an ITopic to register a MessageListener with if withTopic is true (optional)

metadata - metadata describing the cached data, used to compare data versions (optional)

withTopic - true to register a MessageListener with the ITopic whose name matches this region cache if a HazelcastInstance was provided to look up the topic; otherwise, false not to register a listener even if an instance was provided

evictionConfig - provides the parameters which should be used when evicting entries from the cache; if null, this will be derived from the Hazelcast MapConfig; if the MapConfig cannot be resolved, this will use defaults.

Method Detail

get

public Object get(Object key,
                  long txTimestamp)

Specified by:

get in interface RegionCache

insert

public boolean insert(Object key,
                      Object value,
                      Object currentVersion)

Specified by:

insert in interface RegionCache

put

public boolean put(Object key,
                   Object value,
                   long txTimestamp,
                   Object version)

Specified by:

put in interface RegionCache

update

public boolean update(Object key,
                      Object newValue,
                      Object newVersion,
                      org.hibernate.cache.spi.access.SoftLock softLock)

Specified by:

update in interface RegionCache

maybeNotifyTopic

protected void maybeNotifyTopic(Object key,
                                Object value,
                                Object version)

createMessage

protected Object createMessage(Object key,
                               Object value,
                               Object currentVersion)

createMessageListener

protected com.hazelcast.topic.MessageListener<Object> createMessageListener()

remove

public boolean remove(Object key)

Specified by:

remove in interface RegionCache

tryLock

public org.hibernate.cache.spi.access.SoftLock tryLock(Object key,
                                                       Object version)

Specified by:

tryLock in interface RegionCache

unlock

public void unlock(Object key,
                   org.hibernate.cache.spi.access.SoftLock lock)

Specified by:

unlock in interface RegionCache

contains

public boolean contains(Object key)

Specified by:

contains in interface RegionCache

clear

public void clear()

Specified by:

clear in interface RegionCache

destroy

public void destroy()

Specified by:

destroy in interface RegionCache

size

public long size()

Specified by:

size in interface RegionCache

getSizeInMemory

public long getSizeInMemory()

Specified by:

getSizeInMemory in interface RegionCache

asMap

public Map asMap()

Specified by:

asMap in interface RegionCache

maybeInvalidate

protected void maybeInvalidate(Object messageObject)

nextTimestamp

protected long nextTimestamp()