com.hazelcast.map.impl.recordstore

Interface RecordStore<R extends Record>

All Known Implementing Classes:

DefaultRecordStore

public interface RecordStore<R extends Record>

Defines a record-store.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_TTL Default TTL value of a record.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canAcquireLock(Data key, String caller, long threadId)
void	checkIfLoaded()
int	clear()
void	clearPartition(boolean onShutdown) Clears internal partition data.
boolean	containsKey(Data dataKey)
boolean	containsValue(Object testValue)
Record	createRecord(Object value, long ttlMillis, long now)
Storage	createStorage(RecordFactory<R> recordFactory, InMemoryFormat memoryFormat)
boolean	delete(Data dataKey)
void	destroy()
void	disposeDeferredBlocks() This can be used to release unused resources.
void	doPostEvictionOperations(Data key, Object value, boolean isExpired)
Object	evict(Data key, boolean backup)
int	evictAll(boolean backup) Evicts all keys except locked ones.
void	evictEntries(long now)
void	evictExpiredEntries(int percentage, boolean backup) Do expiration operations.
boolean	extendLock(Data key, String caller, long threadId, long ttl)
void	flush()
boolean	forceUnlock(Data dataKey)
Object	get(Data dataKey, boolean backup) Gets record from RecordStore.
MapEntries	getAll(Set<Data> keySet)
long	getHeapCost()
String	getLockOwnerInfo(Data key)
MapContainer	getMapContainer()
MapDataStore<Data,Object>	getMapDataStore()
String	getName()
int	getPartitionId()
R	getRecord(Data key)
R	getRecordOrNull(Data key) Returns live record or null if record is already expired.
Storage	getStorage()
void	init() Initialize the recordStore after creation
boolean	isEmpty()
boolean	isEvictionEnabled()
boolean	isExpirable()
boolean	isExpired(R record, long now, boolean backup) Checks whether a record is expired or not.
boolean	isLoaded()
boolean	isLocked(Data key)
boolean	isTransactionallyLocked(Data key)
Iterator<Record>	iterator() Iterates over record store entries.
Iterator<Record>	iterator(long now, boolean backup) Iterates over record store entries by respecting expiration.
Set<Data>	keySet()
void	loadAll(boolean replaceExistingValues) Loads all keys and values
void	loadAllFromStore(List<Data> keys, boolean replaceExistingValues) Loads all given keys from defined map store.
Iterator<Record>	loadAwareIterator(long now, boolean backup) Iterates over record store entries but first waits map store to load.
Record	loadRecordOrNull(Data key, boolean backup)
void	maybeDoInitialLoad() Performs initial loading from a MapLoader if it has not been done before
boolean	merge(Data dataKey, EntryView mergingEntryView, MapMergePolicy mergePolicy)
void	onKeyLoad(ExecutionCallback<Boolean> callback) Register a callback for when key loading is complete
Object	put(Data dataKey, Object dataValue, long ttl)
R	putBackup(Data key, Object value)
R	putBackup(Data key, Object value, long ttl, boolean putTransient)
Object	putFromLoad(Data key, Object value) Puts key-value pair to map which is the result of a load from map store operation.
Object	putFromLoad(Data key, Object value, long ttl) Puts key-value pair to map which is the result of a load from map store operation.
Object	putFromLoadBackup(Data key, Object value) Puts key-value pair to map which is the result of a load from map store operation on backup.
Object	putIfAbsent(Data dataKey, Object value, long ttl)
void	putRecord(Data key, R record) Puts a data key and a record value to record-store.
void	putTransient(Data dataKey, Object value, long ttl)
Data	readBackupData(Data key) Called when MapConfig.isReadBackupData() is true from MapProxySupport.getInternal(com.hazelcast.nio.serialization.Data) Returns corresponding value for key as Data.
Object	remove(Data dataKey)
boolean	remove(Data dataKey, Object testValue)
void	removeBackup(Data dataKey) Similar to remove(com.hazelcast.nio.serialization.Data) except removeBackup doesn't touch mapstore since it does not return previous value.
Object	replace(Data dataKey, Object update)
boolean	replace(Data dataKey, Object expect, Object update) Sets the value to the given updated value if RecordFactory.isEquals(java.lang.Object, java.lang.Object) comparison of current value and expected value is true.
void	reset() Resets the record store to it's initial state.
boolean	set(Data dataKey, Object value, long ttl) Returns true if key doesn't exist previously, otherwise returns false.
int	size()
void	startLoading() Starts mapLoader
boolean	txnLock(Data key, String caller, long threadId, long referenceId, long ttl)
boolean	unlock(Data key, String caller, long threadId, long referenceId)
void	updateLoadStatus(boolean lastBatch, Throwable exception)

Field Detail

DEFAULT_TTL

static final long DEFAULT_TTL

Default TTL value of a record.

See Also:

Constant Field Values

Method Detail

getName

String getName()

put

Object put(Data dataKey,
         Object dataValue,
         long ttl)

putIfAbsent

Object putIfAbsent(Data dataKey,
                 Object value,
                 long ttl)

putBackup

R putBackup(Data key,
          Object value)

putBackup

R putBackup(Data key,
          Object value,
          long ttl,
          boolean putTransient)

Parameters:

key - the key to be processed.

value - the value to be processed.

ttl - milliseconds. Check out MapProxySupport.putInternal(com.hazelcast.nio.serialization.Data, com.hazelcast.nio.serialization.Data, long, java.util.concurrent.TimeUnit)

putTransient - true if putting transient entry, otherwise false

Returns:

previous record if exists otherwise null.

set

boolean set(Data dataKey,
          Object value,
          long ttl)

Returns true if key doesn't exist previously, otherwise returns false.

See Also:

IMap.set(Object, Object)

remove

Object remove(Data dataKey)

delete

boolean delete(Data dataKey)

remove

boolean remove(Data dataKey,
             Object testValue)

removeBackup

void removeBackup(Data dataKey)

Similar to remove(com.hazelcast.nio.serialization.Data) except removeBackup doesn't touch mapstore since it does not return previous value.

get

Object get(Data dataKey,
         boolean backup)

Gets record from RecordStore. Loads missing keys from map store.

Parameters:

dataKey - key.

backup - true if a backup partition, otherwise false.

Returns:

value of an entry in RecordStore

readBackupData

Data readBackupData(Data key)

Called when MapConfig.isReadBackupData() is true from MapProxySupport.getInternal(com.hazelcast.nio.serialization.Data)

Returns corresponding value for key as Data. This adds an extra serialization step. For the reason of this behaviour please see issue 1292 on github.

Parameters:

key - key to be accessed

Returns:

value as Data independent of InMemoryFormat

getAll

MapEntries getAll(Set<Data> keySet)

containsKey

boolean containsKey(Data dataKey)

replace

Object replace(Data dataKey,
             Object update)

replace

boolean replace(Data dataKey,
              Object expect,
              Object update)

Sets the value to the given updated value if RecordFactory.isEquals(java.lang.Object, java.lang.Object) comparison of current value and expected value is true.

Parameters:

dataKey - key which's value is requested to be replaced.

expect - the expected value

update - the new value

Returns:

true if successful. False return indicates that the actual value was not equal to the expected value.

putTransient

void putTransient(Data dataKey,
                Object value,
                long ttl)

putFromLoad

Object putFromLoad(Data key,
                 Object value)

Puts key-value pair to map which is the result of a load from map store operation.

Parameters:

key - key to put.

value - to put.

Returns:

the previous value associated with key, or null if there was no mapping for key.

See Also:

PutFromLoadAllOperation

putFromLoadBackup

Object putFromLoadBackup(Data key,
                       Object value)

Puts key-value pair to map which is the result of a load from map store operation on backup.

Parameters:

key - key to put.

value - to put.

Returns:

the previous value associated with key, or null if there was no mapping for key.

See Also:

PutFromLoadAllBackupOperation

putFromLoad

Object putFromLoad(Data key,
                 Object value,
                 long ttl)

Puts key-value pair to map which is the result of a load from map store operation.

Parameters:

key - key to put.

value - to put.

ttl - time to live seconds.

Returns:

the previous value associated with key, or null if there was no mapping for key.

See Also:

PutAllOperation

merge

boolean merge(Data dataKey,
            EntryView mergingEntryView,
            MapMergePolicy mergePolicy)

getRecord

R getRecord(Data key)

putRecord

void putRecord(Data key,
             R record)

Puts a data key and a record value to record-store. Used in replication operations.

Parameters:

key - the data key to put record store.

record - the value for record store.

See Also:

MapReplicationOperation

iterator

Iterator<Record> iterator()

Iterates over record store entries.

Returns:

read only iterator for map values.

iterator

Iterator<Record> iterator(long now,
                        boolean backup)

Iterates over record store entries by respecting expiration.

Returns:

read only iterator for map values.

loadAwareIterator

Iterator<Record> loadAwareIterator(long now,
                                 boolean backup)

Iterates over record store entries but first waits map store to load. If an operation needs to wait a data source load like query operations IMap.keySet(com.hazelcast.query.Predicate), this method can be used to return a read-only iterator.

Parameters:

now - current time in millis

backup - true if a backup partition, otherwise false.

Returns:

read only iterator for map values.

keySet

Set<Data> keySet()

size

int size()

txnLock

boolean txnLock(Data key,
              String caller,
              long threadId,
              long referenceId,
              long ttl)

extendLock

boolean extendLock(Data key,
                 String caller,
                 long threadId,
                 long ttl)

unlock

boolean unlock(Data key,
             String caller,
             long threadId,
             long referenceId)

isLocked

boolean isLocked(Data key)

isTransactionallyLocked

boolean isTransactionallyLocked(Data key)

canAcquireLock

boolean canAcquireLock(Data key,
                     String caller,
                     long threadId)

getLockOwnerInfo

String getLockOwnerInfo(Data key)

containsValue

boolean containsValue(Object testValue)

evict

Object evict(Data key,
           boolean backup)

evictAll

int evictAll(boolean backup)

Evicts all keys except locked ones.

Parameters:

backup - true if a backup partition, otherwise false.

Returns:

number of evicted entries.

getMapContainer

MapContainer getMapContainer()

flush

void flush()

clearPartition

void clearPartition(boolean onShutdown)

Clears internal partition data.

Parameters:

onShutdown - true if close is called during MapService shutdown, false otherwise.

reset

void reset()

Resets the record store to it's initial state.

forceUnlock

boolean forceUnlock(Data dataKey)

getHeapCost

long getHeapCost()

isLoaded

boolean isLoaded()

checkIfLoaded

void checkIfLoaded()
                   throws RetryableHazelcastException

Throws:

RetryableHazelcastException

clear

int clear()

isEmpty

boolean isEmpty()

evictExpiredEntries

void evictExpiredEntries(int percentage,
                       boolean backup)

Do expiration operations.

Parameters:

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

backup - true if a backup partition, otherwise false.

isExpirable

boolean isExpirable()

Returns:

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

isExpired

boolean isExpired(R record,
                long now,
                boolean backup)

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

void doPostEvictionOperations(Data key,
                            Object value,
                            boolean isExpired)

loadAllFromStore

void loadAllFromStore(List<Data> keys,
                    boolean replaceExistingValues)

Loads all given keys from defined map store.

Parameters:

keys - keys to be loaded.

replaceExistingValues - true if need to replace existing values otherwise false

updateLoadStatus

void updateLoadStatus(boolean lastBatch,
                    Throwable exception)

getMapDataStore

MapDataStore<Data,Object> getMapDataStore()

getPartitionId

int getPartitionId()

getRecordOrNull

R getRecordOrNull(Data key)

Returns live record or null if record is already expired. Does not load missing keys from a map store.

Parameters:

key - key to be accessed

Returns:

live record or null

See Also:

get(com.hazelcast.nio.serialization.Data, boolean)

evictEntries

void evictEntries(long now)

loadAll

void loadAll(boolean replaceExistingValues)

Loads all keys and values

Parameters:

replaceExistingValues - true if need to replace existing values otherwise false

maybeDoInitialLoad

void maybeDoInitialLoad()

Performs initial loading from a MapLoader if it has not been done before

createStorage

Storage createStorage(RecordFactory<R> recordFactory,
                    InMemoryFormat memoryFormat)

createRecord

Record createRecord(Object value,
                  long ttlMillis,
                  long now)

loadRecordOrNull

Record loadRecordOrNull(Data key,
                      boolean backup)

disposeDeferredBlocks

void disposeDeferredBlocks()

This can be used to release unused resources.

destroy

void destroy()

getStorage

Storage getStorage()

isEvictionEnabled

boolean isEvictionEnabled()

startLoading

void startLoading()

Starts mapLoader

init

void init()

Initialize the recordStore after creation

onKeyLoad

void onKeyLoad(ExecutionCallback<Boolean> callback)

Register a callback for when key loading is complete