com.hazelcast.map.impl.recordstore

Class AbstractEvictableRecordStore

java.lang.Object

com.hazelcast.map.impl.recordstore.AbstractEvictableRecordStore

All Implemented Interfaces:

RecordStore<Record>

Direct Known Subclasses:

DefaultRecordStore

public abstract class AbstractEvictableRecordStore
extends Object

Contains eviction specific functionality.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractEvictableRecordStore.ReadOnlyRecordIterator Read only iterator.

Field Summary

Fields

Modifier and Type	Field and Description
protected ClearExpiredRecordsTask	clearExpiredRecordsTask
protected EventService	eventService
protected Iterator<Record>	expirationIterator Iterates over a pre-set entry count/percentage in one round.
protected InvalidationQueue<ExpiredKey>	expiredKeys
protected long	expiryDelayMillis
protected boolean	hasEntryWithCustomExpiration
protected InMemoryFormat	inMemoryFormat
protected LockStore	lockStore
protected MapContainer	mapContainer
protected MapDataStore<Data,Object>	mapDataStore
protected MapEventPublisher	mapEventPublisher
protected MapServiceContext	mapServiceContext
protected MapStoreContext	mapStoreContext
protected RecordStoreMutationObserver<Record>	mutationObserver
protected String	name
protected int	partitionId
protected RecordFactory	recordFactory
protected SerializationService	serializationService
protected LocalRecordStoreStatsImpl	stats
protected Storage<Data,Record>	storage
protected Address	thisAddress
protected ValueComparator	valueComparator

Fields inherited from interface com.hazelcast.map.impl.recordstore.RecordStore

DEFAULT_MAX_IDLE, DEFAULT_TTL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractEvictableRecordStore(MapContainer mapContainer, int partitionId)

Method Summary

Modifier and Type	Method and Description
void	accessRecord(Record record, long now) Touches the given record, updating its last access time to now and maintaining statistics.
protected LockStore	createLockStore()
Record	createRecord(Data key, Object value, long ttlMillis, long maxIdle, long now)
protected com.hazelcast.map.impl.recordstore.RecordStoreLoader	createRecordStoreLoader(MapStoreContext mapStoreContext)
Storage	createStorage(RecordFactory recordFactory, InMemoryFormat memoryFormat)
void	disposeDeferredBlocks() This can be used to release unused resources.
void	doPostEvictionOperations(Record record) Does post eviction operations like sending events
void	evictEntries(Data excludedKey) Evicts entries from this record-store.
void	evictExpiredEntries(int percentage, boolean backup) Do expiration operations.
Object	get(Data dataKey, boolean backup, Address callerAddress) Same as RecordStore.get(Data, boolean, Address, boolean) with parameter touch set true.
InvalidationQueue<ExpiredKey>	getExpiredKeysQueue()
LocalRecordStoreStats	getLocalRecordStoreStats()
int	getLockedEntryCount()
MapContainer	getMapContainer()
String	getName()
protected long	getNow()
protected Record	getOrNullIfExpired(Record record, long now, boolean backup) Check if record is reachable according to TTL or idle times.
long	getOwnedEntryCost()
int	getPartitionId() Returns the partition id this RecordStore belongs to.
Storage<Data,? extends Record>	getStorage()
void	init() Initialize the recordStore after creation
boolean	isExpirable()
boolean	isExpired(Record record, long now, boolean backup) Checks whether a record is expired or not.
protected boolean	isMaxIdleDefined(long maxIdle)
protected boolean	isTtlDefined(long ttl)
protected void	markRecordStoreExpirable(long ttl, long maxIdle)
protected void	mergeRecordExpiration(Record record, EntryView mergingEntry)
protected void	mergeRecordExpiration(Record record, SplitBrainMergeTypes.MapMergeTypes mergingEntry)
protected boolean	persistenceEnabledFor(CallerProvenance provenance)
protected void	removeIndex(Collection<Record> records)
protected void	removeIndex(Record record)
void	sampleAndForceRemoveEntries(int entryCountToRemove)
protected void	saveIndex(Record record, Object oldValue)
void	setSizeEstimator(EntryCostEstimator entryCostEstimator)
boolean	shouldEvict() Returns true if eviction is allowed on this record-store, otherwise false
protected Data	toData(Object value)
protected void	updateRecord(Data key, Record record, Object value, long now, boolean countAsAccess)
protected void	updateStatsOnGet(long now)
protected void	updateStatsOnPut(boolean countAsAccess, long now)
protected void	updateStatsOnPut(long hits)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hazelcast.map.impl.recordstore.RecordStore

canAcquireLock, checkIfLoaded, clear, clearPartition, containsKey, containsValue, delete, destroy, evict, evictAll, existInMemory, extendLock, fetchEntries, fetchKeys, forceUnlock, get, getAll, getLockOwnerInfo, getMapDataStore, getRecord, getRecordOrNull, hasQueryCache, isEmpty, isKeyLoadFinished, isLoaded, isLocked, isLockedBy, isTransactionallyLocked, iterator, iterator, loadAll, loadAllFromStore, loadAwareIterator, loadRecordOrNull, localLock, lock, maybeDoInitialLoad, merge, merge, merge, merge, put, putBackup, putBackup, putFromLoad, putFromLoadBackup, putIfAbsent, putRecord, putTransient, readBackupData, remove, remove, removeBackup, replace, replace, reset, set, setPreMigrationLoadedStatus, setTtl, setWithUncountedAccess, size, softFlush, startLoading, txnLock, unlock, updateLoadStatus

Field Detail

expiryDelayMillis

protected final long expiryDelayMillis

thisAddress

protected final Address thisAddress

eventService

protected final EventService eventService

mapEventPublisher

protected final MapEventPublisher mapEventPublisher

clearExpiredRecordsTask

protected final ClearExpiredRecordsTask clearExpiredRecordsTask

expiredKeys

protected final InvalidationQueue<ExpiredKey> expiredKeys

expirationIterator

protected Iterator<Record> expirationIterator

Iterates over a pre-set entry count/percentage in one round. Used in expiration logic for traversing entries. Initializes lazily.

hasEntryWithCustomExpiration

protected volatile boolean hasEntryWithCustomExpiration

partitionId

protected final int partitionId

name

protected final String name

lockStore

protected final LockStore lockStore

mapContainer

protected final MapContainer mapContainer

recordFactory

protected final RecordFactory recordFactory

inMemoryFormat

protected final InMemoryFormat inMemoryFormat

mapStoreContext

protected final MapStoreContext mapStoreContext

valueComparator

protected final ValueComparator valueComparator

mapServiceContext

protected final MapServiceContext mapServiceContext

serializationService

protected final SerializationService serializationService

mapDataStore

protected final MapDataStore<Data,Object> mapDataStore

stats

protected final LocalRecordStoreStatsImpl stats

mutationObserver

protected final RecordStoreMutationObserver<Record> mutationObserver

storage

protected Storage<Data,Record> storage

Constructor Detail

AbstractEvictableRecordStore

protected AbstractEvictableRecordStore(MapContainer mapContainer,
                                       int partitionId)

Method Detail

evictExpiredEntries

public void evictExpiredEntries(int percentage,
                                boolean backup)

Description copied from interface: RecordStore

Do expiration operations.

Parameters:

percentage - of max expirables according to the record store size.

backup - true if a backup partition, otherwise false.

isExpirable

public boolean isExpirable()

Returns:

true if record store has at least one candidate entry for expiration else return false.

get

public Object get(Data dataKey,
                  boolean backup,
                  Address callerAddress)

Description copied from interface: RecordStore

Same as RecordStore.get(Data, boolean, Address, boolean) with parameter touch set true.

evictEntries

public void evictEntries(Data excludedKey)

Description copied from interface: RecordStore

Evicts entries from this record-store.

Parameters:

excludedKey - this key has lowest priority to be selected for eviction

sampleAndForceRemoveEntries

public void sampleAndForceRemoveEntries(int entryCountToRemove)

shouldEvict

public boolean shouldEvict()

Description copied from interface: RecordStore

Returns true if eviction is allowed on this record-store, otherwise false

Returns:

true if eviction is allowed on this record-store, otherwise false

markRecordStoreExpirable

protected void markRecordStoreExpirable(long ttl,
                                        long maxIdle)

isTtlDefined

protected boolean isTtlDefined(long ttl)

isMaxIdleDefined

protected boolean isMaxIdleDefined(long maxIdle)

getOrNullIfExpired

protected Record getOrNullIfExpired(Record record,
                                    long now,
                                    boolean backup)

Check if record is reachable according to TTL or idle times. If not reachable return null.

Parameters:

record - Record

Returns:

null if evictable.

isExpired

public boolean isExpired(Record record,
                         long now,
                         boolean backup)

Description copied from interface: RecordStore

Checks whether a record is expired or not.

Parameters:

record - the record from record-store.

now - current time in millis

backup - true if a backup partition, otherwise false.

Returns:

true if the record is expired, false otherwise.

doPostEvictionOperations

public void doPostEvictionOperations(Record record)

Description copied from interface: RecordStore

Does post eviction operations like sending events

Parameters:

record - record to process

getExpiredKeysQueue

public InvalidationQueue<ExpiredKey> getExpiredKeysQueue()

accessRecord

public void accessRecord(Record record,
                         long now)

Description copied from interface: RecordStore

Touches the given record, updating its last access time to now and maintaining statistics.

An implementation is not supposed to be thread safe.

Parameters:

record - the accessed record

now - the current time

mergeRecordExpiration

protected void mergeRecordExpiration(Record record,
                                     EntryView mergingEntry)

mergeRecordExpiration

protected void mergeRecordExpiration(Record record,
                                     SplitBrainMergeTypes.MapMergeTypes mergingEntry)

persistenceEnabledFor

protected boolean persistenceEnabledFor(@Nonnull
                                        CallerProvenance provenance)

getLocalRecordStoreStats

public LocalRecordStoreStats getLocalRecordStoreStats()

Specified by:

getLocalRecordStoreStats in interface RecordStore<Record>

init

public void init()

Description copied from interface: RecordStore

Initialize the recordStore after creation

Specified by:

init in interface RecordStore<Record>

createRecord

public Record createRecord(Data key,
                           Object value,
                           long ttlMillis,
                           long maxIdle,
                           long now)

Specified by:

createRecord in interface RecordStore<Record>

createStorage

public Storage createStorage(RecordFactory recordFactory,
                             InMemoryFormat memoryFormat)

Specified by:

createStorage in interface RecordStore<Record>

getName

public String getName()

Specified by:

getName in interface RecordStore<Record>

getMapContainer

public MapContainer getMapContainer()

Specified by:

getMapContainer in interface RecordStore<Record>

getOwnedEntryCost

public long getOwnedEntryCost()

Specified by:

getOwnedEntryCost in interface RecordStore<Record>

getNow

protected long getNow()

updateRecord

protected void updateRecord(Data key,
                            Record record,
                            Object value,
                            long now,
                            boolean countAsAccess)

getPartitionId

public int getPartitionId()

Description copied from interface: RecordStore

Returns the partition id this RecordStore belongs to.

Specified by:

getPartitionId in interface RecordStore<Record>

Returns:

the partition id.

saveIndex

protected void saveIndex(Record record,
                         Object oldValue)

removeIndex

protected void removeIndex(Record record)

removeIndex

protected void removeIndex(Collection<Record> records)

createLockStore

protected LockStore createLockStore()

getLockedEntryCount

public int getLockedEntryCount()

Specified by:

getLockedEntryCount in interface RecordStore<Record>

createRecordStoreLoader

protected com.hazelcast.map.impl.recordstore.RecordStoreLoader createRecordStoreLoader(MapStoreContext mapStoreContext)

toData

protected Data toData(Object value)

setSizeEstimator

public void setSizeEstimator(EntryCostEstimator entryCostEstimator)

disposeDeferredBlocks

public void disposeDeferredBlocks()

Description copied from interface: RecordStore

This can be used to release unused resources.

Specified by:

disposeDeferredBlocks in interface RecordStore<Record>

getStorage

public Storage<Data,? extends Record> getStorage()

Specified by:

getStorage in interface RecordStore<Record>

updateStatsOnPut

protected void updateStatsOnPut(boolean countAsAccess,
                                long now)

updateStatsOnPut

protected void updateStatsOnPut(long hits)

updateStatsOnGet

protected void updateStatsOnGet(long now)