com.hazelcast.map.impl.mapstore

Interface MapDataStore<K,V>

Type Parameters:

K - type of key to store

V - type of value to store

All Known Implementing Classes:

AbstractMapDataStore, WriteBehindStore, WriteThroughStore

public interface MapDataStore<K,V>

Map data stores general contract. Provides an extra abstraction layer over write-through and write-behind map-store implementations.

Method Summary

Modifier and Type	Method and Description
V	add(K key, V value, long now)
V	addBackup(K key, V value, long now)
void	addTransient(K key, long now)
V	flush(K key, V value, boolean backup) Flushes the supplied key to the map-store.
void	hardFlush() Flushes write-behind-queue into map-store in calling thread.
boolean	isPostProcessingMapStore()
V	load(K key)
boolean	loadable(K key) Used in IMap.loadAll(boolean) calls.
Map	loadAll(Collection keys) Loads values for the provided keys if a MapLoader is configured for this map.
int	notFinishedOperationsCount()
void	remove(K key, long now)
void	removeAll(Collection keys) Removes keys from map store.
void	removeBackup(K key, long now)
void	reset() Returns all associated resources of this map-data-store back to the initial state.
long	softFlush() Only marks this MapDataStore as flush-able.

Method Detail

add

V add(K key,
      V value,
      long now)

addTransient

void addTransient(K key,
                  long now)

addBackup

V addBackup(K key,
            V value,
            long now)

remove

void remove(K key,
            long now)

removeBackup

void removeBackup(K key,
                  long now)

reset

void reset()

Returns all associated resources of this map-data-store back to the initial state.

load

V load(K key)

loadAll

Map loadAll(Collection keys)

Loads values for the provided keys if a MapLoader is configured for this map. This method never returns null. The returned map will contain deserialised keys and values.

Parameters:

keys - the keys for which values are loaded

Returns:

the map from deserialised key to deserialised value

See Also:

MapLoader.loadAll(Collection)

removeAll

void removeAll(Collection keys)

Removes keys from map store. It also handles Data to object conversions of keys.

Parameters:

keys - to be removed

loadable

boolean loadable(K key)

Used in IMap.loadAll(boolean) calls. If the write-behind map-store feature is enabled, some things may lead to possible data inconsistencies. These are: - calling evict/evictAll, - calling remove, and - not yet stored write-behind queue operations.

With this method, we can be sure if a key can be loadable from map-store or not.

Parameters:

key - the key to query whether it is loadable or not

Returns:

true if the key is loadable

notFinishedOperationsCount

int notFinishedOperationsCount()

isPostProcessingMapStore

boolean isPostProcessingMapStore()

softFlush

long softFlush()

Only marks this MapDataStore as flush-able. Flush means storing entries from write-behind-queue into map-store regardless of the scheduled store-time. Actual flushing is done by another thread than partition-operation thread which runs StoreWorker.

Returns:

last given sequence number to the last store operation

See Also:

MapFlushOperation

hardFlush

void hardFlush()

Flushes write-behind-queue into map-store in calling thread.

After calling of this method, all elements in the WriteBehindQueue of this MapDataStore should be in map-store regardless of the scheduled store-time.

The only call to this method is in node-shutdown.

See Also:

MapManagedService.shutdown(boolean)

flush

V flush(K key,
        V value,
        boolean backup)

Flushes the supplied key to the map-store.

Parameters:

key - key to be flushed

value - value to be flushed

backup - true calling this method for backup partition, false for owner partition.

Returns:

flushed value.