com.hazelcast.cache.impl.nearcache.impl.store

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

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BaseHeapNearCacheRecordStore

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractNearCacheRecordStore.MaxSizeEvictionChecker

Field Summary

Fields

Modifier and Type	Field and Description
protected EvictionChecker	evictionChecker
protected EvictionPolicyEvaluator<KS,R>	evictionPolicyEvaluator
protected EvictionStrategy<KS,R,NCRM>	evictionStrategy
protected long	maxIdleMillis
protected MaxSizeChecker	maxSizeChecker
protected NearCacheConfig	nearCacheConfig
protected NearCacheStatsImpl	nearCacheStats
protected NCRM	records
protected static int	REFERENCE_SIZE
protected SerializationService	serializationService
protected long	timeToLiveMillis

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

NO_LISTENER

Constructor Summary

Constructors

Constructor and Description
AbstractNearCacheRecordStore(NearCacheConfig nearCacheConfig, NearCacheContext nearCacheContext)
AbstractNearCacheRecordStore(NearCacheConfig nearCacheConfig, NearCacheContext nearCacheContext, NearCacheStatsImpl nearCacheStats)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkAvailable()
void	clear() Removes all stored values.
protected void	clearRecords()
protected EvictionChecker	createEvictionChecker(NearCacheConfig nearCacheConfig)
protected EvictionPolicyEvaluator<KS,R>	createEvictionPolicyEvaluator(EvictionConfig evictionConfig)
protected EvictionStrategy<KS,R,NCRM>	createEvictionStrategy(EvictionConfig evictionConfig)
protected abstract MaxSizeChecker	createNearCacheMaxSizeChecker(EvictionConfig evictionConfig, NearCacheConfig nearCacheConfig, NearCacheContext nearCacheContext)
protected abstract NCRM	createNearCacheRecordMap(NearCacheConfig nearCacheConfig, NearCacheContext nearCacheContext)
protected V	dataToValue(Data data)
void	destroy() Clears the record store and destroys it.
protected void	destroyStore()
void	doEviction() Does eviction as specified configuration EvictionConfig in NearCacheConfig regardless from the max-size policy.
void	doEvictionIfRequired() 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	getRecord(K key)
protected abstract long	getRecordStorageMemoryCost(R record)
protected long	getTotalStorageMemoryCost(K key, R record)
protected boolean	isAvailable()
protected boolean	isEvictionEnabled()
protected boolean	isRecordExpired(R record)
void	onEvict(KS key, R record) Called when an Evictable entry is evicted.
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	onRecordAccess(R record)
protected void	onRecordCreate(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, V value) Puts (associates) a value with the given key.
protected abstract R	putRecord(K key, R record)
protected abstract void	putToRecord(R record, V value)
protected abstract V	recordToValue(R record)
boolean	remove(K key) Removes the value associated with the given key.
protected abstract R	removeRecord(K key)
int	size() Gets the number of stored records.
protected Data	toData(Object obj)
protected V	toValue(Object obj)
protected Data	valueToData(V value)
protected abstract R	valueToRecord(V value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hazelcast.cache.impl.nearcache.NearCacheRecordStore

doExpiration, selectToSave

Field Detail

REFERENCE_SIZE

protected static final int REFERENCE_SIZE

timeToLiveMillis

protected final long timeToLiveMillis

maxIdleMillis

protected final long maxIdleMillis

nearCacheConfig

protected final NearCacheConfig nearCacheConfig

serializationService

protected final SerializationService serializationService

nearCacheStats

protected final NearCacheStatsImpl nearCacheStats

records

protected NCRM extends NearCacheRecordMap<KS,R> records

maxSizeChecker

protected final MaxSizeChecker maxSizeChecker

evictionPolicyEvaluator

protected final EvictionPolicyEvaluator<KS,R extends NearCacheRecord> evictionPolicyEvaluator

evictionChecker

protected final EvictionChecker evictionChecker

evictionStrategy

protected final EvictionStrategy<KS,R extends NearCacheRecord,NCRM extends NearCacheRecordMap<KS,R>> evictionStrategy

Constructor Detail

AbstractNearCacheRecordStore

public AbstractNearCacheRecordStore(NearCacheConfig nearCacheConfig,
                            NearCacheContext nearCacheContext)

AbstractNearCacheRecordStore

public AbstractNearCacheRecordStore(NearCacheConfig nearCacheConfig,
                            NearCacheContext nearCacheContext,
                            NearCacheStatsImpl nearCacheStats)

Method Detail

createNearCacheMaxSizeChecker

protected abstract MaxSizeChecker createNearCacheMaxSizeChecker(EvictionConfig evictionConfig,
                                           NearCacheConfig nearCacheConfig,
                                           NearCacheContext nearCacheContext)

createNearCacheRecordMap

protected abstract NCRM createNearCacheRecordMap(NearCacheConfig nearCacheConfig,
                            NearCacheContext nearCacheContext)

getKeyStorageMemoryCost

protected abstract long getKeyStorageMemoryCost(K key)

getRecordStorageMemoryCost

protected abstract long getRecordStorageMemoryCost(R record)

valueToRecord

protected abstract R valueToRecord(V value)

recordToValue

protected abstract V recordToValue(R record)

getRecord

protected abstract R getRecord(K key)

putRecord

protected abstract R putRecord(K key,
          R record)

putToRecord

protected abstract void putToRecord(R record,
               V value)

removeRecord

protected abstract R removeRecord(K key)

checkAvailable

protected void checkAvailable()

createEvictionPolicyEvaluator

protected EvictionPolicyEvaluator<KS,R> createEvictionPolicyEvaluator(EvictionConfig evictionConfig)

createEvictionChecker

protected EvictionChecker createEvictionChecker(NearCacheConfig nearCacheConfig)

createEvictionStrategy

protected EvictionStrategy<KS,R,NCRM> createEvictionStrategy(EvictionConfig evictionConfig)

isAvailable

protected boolean isAvailable()

valueToData

protected Data valueToData(V value)

dataToValue

protected V dataToValue(Data data)

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)

onRecordCreate

protected void onRecordCreate(R record)

onRecordAccess

protected void onRecordAccess(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)

isEvictionEnabled

protected boolean isEvictionEnabled()

onEvict

public void onEvict(KS key,
           R record)

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.

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,
       V value)

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.

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

remove

public boolean remove(K key)

Description copied from interface: NearCacheRecordStore

Removes the value associated with the given key.

Specified by:

remove in interface NearCacheRecordStore<K,V>

Parameters:

key - the key from which the value will be removed.

Returns:

true if the value was removed, otherwise false.

clearRecords

protected void clearRecords()

clear

public void clear()

Description copied from interface: NearCacheRecordStore

Removes all stored values.

Specified by:

clear in interface NearCacheRecordStore<K,V>

destroyStore

protected void destroyStore()

destroy

public void destroy()

Description copied from interface: NearCacheRecordStore

Clears the record store and destroys it.

Specified by:

destroy in interface NearCacheRecordStore<K,V>

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.

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.

doEvictionIfRequired

public void doEvictionIfRequired()

Description copied from interface: NearCacheRecordStore

Does eviction as specified configuration EvictionConfig in NearCacheConfig.

Specified by:

doEvictionIfRequired in interface NearCacheRecordStore<K,V>

doEviction

public void doEviction()

Description copied from interface: NearCacheRecordStore

Does eviction as specified configuration EvictionConfig in NearCacheConfig regardless from the max-size policy.

Specified by:

doEviction in interface NearCacheRecordStore<K,V>