com.hazelcast.internal.nearcache.impl.store

Class AbstractNearCacheRecordStore<K,V,KS,R extends NearCacheRecord,NCRM extends SampleableNearCacheRecordMap<KS,R>>

java.lang.Object

com.hazelcast.internal.nearcache.impl.store.AbstractNearCacheRecordStore<K,V,KS,R,NCRM>

Type Parameters:

K - the type of the key stored in Near Cache

V - the type of the value stored in Near Cache

KS - the type of the key of the underlying NearCacheRecordMap

R - the type of the value of the underlying NearCacheRecordMap

NCRM - the type of the underlying NearCacheRecordMap

All Implemented Interfaces:

EvictionListener<KS,R>, NearCacheRecordStore<K,V>, InitializingObject

Direct Known Subclasses:

BaseHeapNearCacheRecordStore

public abstract class AbstractNearCacheRecordStore<K,V,KS,R extends NearCacheRecord,NCRM extends SampleableNearCacheRecordMap<KS,R>>
extends Object
implements NearCacheRecordStore<K,V>, EvictionListener<KS,R>

Abstract implementation of NearCacheRecordStore and EvictionListener.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractNearCacheRecordStore.ReserveForUpdateFunction

Field Summary

Fields

Modifier and Type	Field and Description
protected ClassLoader	classLoader
protected EvictionChecker	evictionChecker
protected boolean	evictionDisabled
protected EvictionPolicyEvaluator<KS,R>	evictionPolicyEvaluator
protected SamplingEvictionStrategy<KS,R,NCRM>	evictionStrategy
protected InMemoryFormat	inMemoryFormat
protected long	maxIdleMillis
protected static long	MILLI_SECONDS_IN_A_SECOND
protected NearCacheConfig	nearCacheConfig
protected NearCacheStatsImpl	nearCacheStats
protected NCRM	records
protected static long	REFERENCE_SIZE If Unsafe is available, Object array index scale (every index represents a reference) can be assumed as reference size.
protected static AtomicLongFieldUpdater<AbstractNearCacheRecordStore>	RESERVATION_ID
protected long	reservationId
protected SerializationService	serializationService
protected StaleReadDetector	staleReadDetector
protected long	timeToLiveMillis

Fields inherited from interface com.hazelcast.internal.eviction.EvictionListener

NO_LISTENER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractNearCacheRecordStore(NearCacheConfig nearCacheConfig, NearCacheStatsImpl nearCacheStats, SerializationService serializationService, ClassLoader classLoader)
	AbstractNearCacheRecordStore(NearCacheConfig nearCacheConfig, SerializationService serializationService, ClassLoader classLoader)

Method Summary

Modifier and Type	Method and Description
protected boolean	canUpdateStats(R record)
protected void	checkAvailable()
void	clear() Removes all stored values.
protected abstract boolean	containsRecordKey(K key)
protected abstract EvictionChecker	createNearCacheEvictionChecker(EvictionConfig evictionConfig, NearCacheConfig nearCacheConfig)
protected abstract NCRM	createNearCacheRecordMap(NearCacheConfig nearCacheConfig)
protected abstract R	createRecord(V value)
void	destroy() Clears the record store and destroys it.
void	doEviction(boolean withoutMaxSizeCheck) Does eviction as specified configuration EvictionConfig in NearCacheConfig.
V	get(K key) Gets the value associated with the given key.
protected abstract long	getKeyStorageMemoryCost(K key)
NearCacheStats	getNearCacheStats() Get the NearCacheStats instance to monitor this record store.
protected abstract R	getOrCreateToReserve(K key, Data keyData)
abstract R	getRecord(K key) Gets the record associated with the given key.
protected abstract long	getRecordStorageMemoryCost(R record)
StaleReadDetector	getStaleReadDetector()
protected long	getTotalStorageMemoryCost(K key, R record)
void	initialize()
protected boolean	isRecordExpired(R record)
void	onEvict(KS key, R record, boolean wasExpired) Called when an Evictable entry is evicted.
protected void	onExpire(K key, R record)
protected void	onGet(K key, V value, R record)
protected void	onGetError(K key, V value, R record, Throwable error)
protected void	onPut(K key, V value, R record, R oldRecord)
protected void	onPutError(K key, V value, R record, R oldRecord, Throwable error)
protected void	onRecordCreate(K key, Data keyData, R record)
protected void	onRemove(K key, R record, boolean removed)
protected void	onRemoveError(K key, R record, boolean removed, Throwable error)
void	put(K key, Data keyData, V value, Data valueData) Puts (associates) a value with the given key.
protected abstract R	putRecord(K key, R record)
protected V	recordToValue(R record)
void	setStaleReadDetector(StaleReadDetector staleReadDetector)
int	size() Gets the number of stored records.
protected Data	toData(Object obj)
protected V	toValue(Object obj)
V	tryPublishReserved(K key, V value, long reservationId, boolean deserialize) Tries to update reserved key with supplied value.
long	tryReserveForUpdate(K key, Data keyData) Tries to reserve supplied key for update.
protected abstract V	updateAndGetReserved(K key, V value, long reservationId, boolean deserialize)
protected abstract void	updateRecordValue(R record, V value)
protected R	updateReservedRecordInternal(K key, V value, R reservedRecord, long reservationId)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hazelcast.internal.nearcache.NearCacheRecordStore

doExpiration, invalidate, loadKeys, storeKeys

Field Detail

RESERVATION_ID

protected static final AtomicLongFieldUpdater<AbstractNearCacheRecordStore> RESERVATION_ID

REFERENCE_SIZE

protected static final long REFERENCE_SIZE

If Unsafe is available, Object array index scale (every index represents a reference) can be assumed as reference size.

Otherwise, we assume reference size as integer size that means we assume 32 bit JVM or compressed-references enabled 64 bit JVM by ignoring compressed-references disable mode on 64 bit JVM.

MILLI_SECONDS_IN_A_SECOND

protected static final long MILLI_SECONDS_IN_A_SECOND

See Also:

Constant Field Values

timeToLiveMillis

protected final long timeToLiveMillis

maxIdleMillis

protected final long maxIdleMillis

evictionDisabled

protected final boolean evictionDisabled

classLoader

protected final ClassLoader classLoader

inMemoryFormat

protected final InMemoryFormat inMemoryFormat

nearCacheConfig

protected final NearCacheConfig nearCacheConfig

nearCacheStats

protected final NearCacheStatsImpl nearCacheStats

serializationService

protected final SerializationService serializationService

records

protected NCRM extends SampleableNearCacheRecordMap<KS,R> records

evictionChecker

protected EvictionChecker evictionChecker

evictionStrategy

protected SamplingEvictionStrategy<KS,R extends NearCacheRecord,NCRM extends SampleableNearCacheRecordMap<KS,R>> evictionStrategy

evictionPolicyEvaluator

protected EvictionPolicyEvaluator<KS,R extends NearCacheRecord> evictionPolicyEvaluator

reservationId

protected volatile long reservationId

staleReadDetector

protected volatile StaleReadDetector staleReadDetector

Constructor Detail

AbstractNearCacheRecordStore

public AbstractNearCacheRecordStore(NearCacheConfig nearCacheConfig,
                                    SerializationService serializationService,
                                    ClassLoader classLoader)

AbstractNearCacheRecordStore

protected AbstractNearCacheRecordStore(NearCacheConfig nearCacheConfig,
                                       NearCacheStatsImpl nearCacheStats,
                                       SerializationService serializationService,
                                       ClassLoader classLoader)

Method Detail

initialize

public void initialize()

Specified by:

initialize in interface InitializingObject

setStaleReadDetector

public void setStaleReadDetector(StaleReadDetector staleReadDetector)

Specified by:

setStaleReadDetector in interface NearCacheRecordStore<K,V>

See Also:

StaleReadDetector

getRecord

public abstract R getRecord(K key)

Description copied from interface: NearCacheRecordStore

Gets the record associated with the given key.

Specified by:

getRecord in interface NearCacheRecordStore<K,V>

Parameters:

key - the key from which to get the associated NearCacheRecord.

Returns:

the NearCacheRecord associated with the given key.

createNearCacheEvictionChecker

protected abstract EvictionChecker createNearCacheEvictionChecker(EvictionConfig evictionConfig,
                                                                  NearCacheConfig nearCacheConfig)

createNearCacheRecordMap

protected abstract NCRM createNearCacheRecordMap(NearCacheConfig nearCacheConfig)

getKeyStorageMemoryCost

protected abstract long getKeyStorageMemoryCost(K key)

getRecordStorageMemoryCost

protected abstract long getRecordStorageMemoryCost(R record)

createRecord

protected abstract R createRecord(V value)

updateRecordValue

protected abstract void updateRecordValue(R record,
                                          V value)

getOrCreateToReserve

protected abstract R getOrCreateToReserve(K key,
                                          Data keyData)

updateAndGetReserved

protected abstract V updateAndGetReserved(K key,
                                          V value,
                                          long reservationId,
                                          boolean deserialize)

putRecord

protected abstract R putRecord(K key,
                               R record)

containsRecordKey

protected abstract boolean containsRecordKey(K key)

checkAvailable

protected void checkAvailable()

toData

protected Data toData(Object obj)

toValue

protected V toValue(Object obj)

getTotalStorageMemoryCost

protected long getTotalStorageMemoryCost(K key,
                                         R record)

isRecordExpired

protected boolean isRecordExpired(R record)

recordToValue

protected V recordToValue(R record)

onGet

protected void onGet(K key,
                     V value,
                     R record)

onGetError

protected void onGetError(K key,
                          V value,
                          R record,
                          Throwable error)

onPut

protected void onPut(K key,
                     V value,
                     R record,
                     R oldRecord)

onPutError

protected void onPutError(K key,
                          V value,
                          R record,
                          R oldRecord,
                          Throwable error)

onRemove

protected void onRemove(K key,
                        R record,
                        boolean removed)

onRemoveError

protected void onRemoveError(K key,
                             R record,
                             boolean removed,
                             Throwable error)

onExpire

protected void onExpire(K key,
                        R record)

onEvict

public void onEvict(KS key,
                    R record,
                    boolean wasExpired)

Description copied from interface: EvictionListener

Called when an Evictable entry is evicted.

Specified by:

onEvict in interface EvictionListener<KS,R extends NearCacheRecord>

Parameters:

key - Accessor of the Evictable entry that is evicted.

record - Evictable entry that is evicted.

wasExpired - true if the entry was evicted due to expiration, false otherwise

get

public V get(K key)

Description copied from interface: NearCacheRecordStore

Gets the value associated with the given key.

Specified by:

get in interface NearCacheRecordStore<K,V>

Parameters:

key - the key from which to get the associated value.

Returns:

the value associated with the given key.

put

public void put(K key,
                Data keyData,
                V value,
                Data valueData)

Description copied from interface: NearCacheRecordStore

Puts (associates) a value with the given key.

Specified by:

put in interface NearCacheRecordStore<K,V>

Parameters:

key - the key to which the given value will be associated.

keyData - the key as Data to which the given value will be associated.

value - the value that will be associated with the key.

canUpdateStats

protected boolean canUpdateStats(R record)

clear

public void clear()

Description copied from interface: NearCacheRecordStore

Removes all stored values.

Specified by:

clear in interface NearCacheRecordStore<K,V>

destroy

public void destroy()

Description copied from interface: NearCacheRecordStore

Clears the record store and destroys it.

Specified by:

destroy in interface NearCacheRecordStore<K,V>

getNearCacheStats

public NearCacheStats getNearCacheStats()

Description copied from interface: NearCacheRecordStore

Get the NearCacheStats instance to monitor this record store.

Specified by:

getNearCacheStats in interface NearCacheRecordStore<K,V>

Returns:

the NearCacheStats instance to monitor this record store.

size

public int size()

Description copied from interface: NearCacheRecordStore

Gets the number of stored records.

Specified by:

size in interface NearCacheRecordStore<K,V>

Returns:

the number of stored records.

doEviction

public void doEviction(boolean withoutMaxSizeCheck)

Description copied from interface: NearCacheRecordStore

Does eviction as specified configuration EvictionConfig in NearCacheConfig.

Specified by:

doEviction in interface NearCacheRecordStore<K,V>

Parameters:

withoutMaxSizeCheck - set true to evict regardless of a max size check, otherwise set false to evict after a max size check.

tryReserveForUpdate

public long tryReserveForUpdate(K key,
                                Data keyData)

Description copied from interface: NearCacheRecordStore

Tries to reserve supplied key for update.

If one thread takes reservation, only that thread can update the key.

Specified by:

tryReserveForUpdate in interface NearCacheRecordStore<K,V>

Parameters:

key - key to be reserved for update

keyData - key to be reserved for update as Data

Returns:

reservation ID if reservation succeeds, else returns NearCacheRecord.NOT_RESERVED

tryPublishReserved

public V tryPublishReserved(K key,
                            V value,
                            long reservationId,
                            boolean deserialize)

Description copied from interface: NearCacheRecordStore

Tries to update reserved key with supplied value. If update happens, value is published. Publishing means making the value readable to all threads. If update fails, record is not updated.

Specified by:

tryPublishReserved in interface NearCacheRecordStore<K,V>

Parameters:

key - reserved key for update

value - value to be associated with reserved key

reservationId - ID for this reservation

deserialize - eagerly deserialize returning value

Returns:

associated value if deserialize is true and update succeeds, otherwise returns null

getStaleReadDetector

public StaleReadDetector getStaleReadDetector()

onRecordCreate

protected void onRecordCreate(K key,
                              Data keyData,
                              R record)

updateReservedRecordInternal

protected R updateReservedRecordInternal(K key,
                                         V value,
                                         R reservedRecord,
                                         long reservationId)