ICacheRecordStore (Hazelcast Root 3.12-BETA-2 API)

All Known Implementing Classes:

AbstractCacheRecordStore, CacheRecordStore
```
public interface ICacheRecordStore
```
ICacheRecordStore is the core contract providing internal functionality to ICache implementations on partition scope. All of the ICache methods actually map to a method on this interface through Hazelcast's RPC mechanism. Hazelcast Operation is sent to the relevant partition to be executed and the final results are returned to the callers.
For each partition, there is only one ICacheRecordStore in the cluster.
Implementations of this interface may provide different internal data persistence like on-heap storage.
Each expirible cache entry is actually a Data, CacheRecord pair.
Key type: always serialized form of Data.

Value types: depend on the configuration.

See Also:

CacheRecordStore

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`clear()` clears all internal data without publishing any events
`void`	`close(boolean onShutdown)` Close is equivalent to below operations in the given order: close resources. unregister all listeners.
`boolean`	`contains(Data key)` Determines if this store contains an entry for the specified key.
`void`	`destroy()` Destroy is equivalent to below operations in the given order: clear all. close resources. unregister all listeners.
`void`	`destroyInternals()` Like `destroy()` but does not touch state on other services like event journal service.
`void`	`disposeDeferredBlocks()`
`void`	`evictExpiredEntries(int percentage)` Do expiration operations.
`boolean`	`evictIfRequired()` Evict cache record store if eviction is required.
`CacheEntryIterationResult`	`fetchEntries(int tableIndex, int size)` Starting from the provided table index, a set of entries are returned with a maximum size of `size`
`CacheKeyIterationResult`	`fetchKeys(int tableIndex, int size)` Starting from the provided table index, a set of keys are returned with a maximum size of `size`
`Object`	`get(Data key, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Gets the value to which the specified key is mapped, or `null` if this cache contains no mapping for the key.
`MapEntries`	`getAll(Set<Data> keySet, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Gets a collection of entries from the store, returning them as `Map` of the values associated with the set of keys requested.
`Object`	`getAndPut(Data key, Object value, javax.cache.expiry.ExpiryPolicy expiryPolicy, String caller, int completionId)` Associates the specified value with the specified key in this cache, returning an existing value if one existed.
`Object`	`getAndRemove(Data key, String caller, int completionId)` Atomically removes the entry for a key only if it is currently mapped to some value.
`Object`	`getAndReplace(Data key, Object value, javax.cache.expiry.ExpiryPolicy expiryPolicy, String caller, int completionId)` Atomically replaces the value for a given key if and only if there is a value currently mapped by the key.
`CacheStatisticsImpl`	`getCacheStats()` Gets the Cache statistics associated with this `CacheService`.
`CacheConfig`	`getConfig()` Gets the configuration of the cache that this store belongs to.
`InvalidationQueue<ExpiredKey>`	`getExpiredKeysQueue()`
`Object`	`getExpiryPolicy(Data key)`
`String`	`getName()` Gets the name of the distributed object name of the cache.
`ObjectNamespace`	`getObjectNamespace()` Returns `ObjectNamespace` associated with this record store.
`int`	`getPartitionId()`
`Map<Data,CacheRecord>`	`getReadOnlyRecords()` Returns a readonly map of the internal key value store.
`CacheRecord`	`getRecord(Data key)` Gets internal record of the store by key.
`void`	`init()` Initializes record store.
`Object`	`invoke(Data key, javax.cache.processor.EntryProcessor entryProcessor, Object[] arguments, int completionId)` Invokes an `EntryProcessor` against the `Cache.Entry` specified by the provided key.
`boolean`	`isExpirable()`
`boolean`	`isWanReplicationEnabled()` Determines whether wan replication is enabled or not for this record store.
`Set<Data>`	`loadAll(Set<Data> keys, boolean replaceExistingValues)` Synchronously loads the specified entries into the cache using the configured `CacheLoader` for the given keys.
`CacheRecord`	`merge(CacheEntryView<Data,Data> cacheEntryView, CacheMergePolicy mergePolicy, String caller, String origin, int completionId, CallerProvenance callerProvenance)` Merges the given `CacheEntryView` via the given `CacheMergePolicy`.
`CacheRecord`	`merge(SplitBrainMergeTypes.CacheMergeTypes mergingEntry, SplitBrainMergePolicy<Data,SplitBrainMergeTypes.CacheMergeTypes> mergePolicy, CallerProvenance callerProvenance)` Merges the given `SplitBrainMergeTypes.CacheMergeTypes` via the given `SplitBrainMergePolicy`.
`CacheRecord`	`put(Data key, Object value, javax.cache.expiry.ExpiryPolicy expiryPolicy, String caller, int completionId)` Associates the specified value with the specified key in this cache, returning an existing value if one existed.
`boolean`	`putIfAbsent(Data key, Object value, javax.cache.expiry.ExpiryPolicy expiryPolicy, String caller, int completionId)` Removes the mapping for a key from this cache if it is present.
`void`	`putRecord(Data key, CacheRecord record, boolean updateJournal)` Associates the specified record with the specified key.
`boolean`	`remove(Data key, Object value, String caller, String origin, int completionId)` Atomically removes the mapping for a key only if currently mapped to the given value.
`boolean`	`remove(Data key, String caller, String origin, int completionId)`
`boolean`	`remove(Data key, String caller, String origin, int completionId, CallerProvenance provenance)` Removes the mapping for a key from this cache if it is present.
`void`	`removeAll(Set<Data> keys, int completionId)` records of keys will be deleted one by one and will publish a REMOVE event for each key.
`CacheRecord`	`removeRecord(Data key)` Removes the record for a key.
`boolean`	`replace(Data key, Object value, javax.cache.expiry.ExpiryPolicy expiryPolicy, String caller, int completionId)` Atomically replaces the entry for a key only if currently mapped to some value.
`boolean`	`replace(Data key, Object oldValue, Object newValue, javax.cache.expiry.ExpiryPolicy expiryPolicy, String caller, int completionId)` Atomically replaces the entry for a key only if currently mapped to a given value.
`void`	`reset()` Resets the record store to it's initial state.
`void`	`sampleAndForceRemoveEntries(int count)`
`boolean`	`setExpiryPolicy(Collection<Data> keys, Object expiryPolicy, String source)` Sets expiry policy for the records with given keys if and only if there is a value currently mapped by the key
`int`	`size()` Calculates the entry size of this store which reflects the partition size of the cache.

- Method Detail
  - get
```
Object get(Data key,
           javax.cache.expiry.ExpiryPolicy expiryPolicy)
```
    Gets the value to which the specified key is mapped, or null if this cache contains no mapping for the key.
    If the cache is configured to use read-through, and get would return null because the entry is missing from the cache, the Cache's CacheLoader is called in an attempt to load the entry.
    
    Parameters:
    
    key - the key whose associated value is to be returned.
    
    expiryPolicy - custom expiry policy or null to use configured default value.
    
    Returns:
    
    the element, or null, if it does not exist.
  - put
```
CacheRecord put(Data key,
                Object value,
                javax.cache.expiry.ExpiryPolicy expiryPolicy,
                String caller,
                int completionId)
```
    Associates the specified value with the specified key in this cache, returning an existing value if one existed.
    If the cache previously contained a mapping for the key, the old value is replaced by the specified value. (A cache c is said to contain a mapping for a key k if and only if c.contains(k) would return true.)
    The previous value is returned, or null if there was no value associated with the key previously.
    
    Parameters:
    
    key - key with which the specified value is to be associated.
    
    value - value to be associated with the specified key.
    
    expiryPolicy - custom expiry policy or null to use configured default value.
    
    caller - UUID of the calling node or client.
    
    Returns:
    
    the stored CacheRecord (added as new record or updated). null if record has expired.
  - getAndPut
```
Object getAndPut(Data key,
                 Object value,
                 javax.cache.expiry.ExpiryPolicy expiryPolicy,
                 String caller,
                 int completionId)
```
    Associates the specified value with the specified key in this cache, returning an existing value if one existed.
    If the cache previously contained a mapping for the key, the old value is replaced by the specified value. (A cache c is said to contain a mapping for a key k if and only if c.contains(k) would return true.)
    The previous value is returned, or null if there was no value associated with the key previously.
    
    Parameters:
    
    key - key with which the specified value is to be associated.
    
    value - value to be associated with the specified key.
    
    expiryPolicy - custom expiry policy or null to use configured default value.
    
    caller - UUID of the calling node or client.
    
    Returns:
    
    the value associated with the key at the start of the operation or null if none was associated.
  - putIfAbsent
```
boolean putIfAbsent(Data key,
                    Object value,
                    javax.cache.expiry.ExpiryPolicy expiryPolicy,
                    String caller,
                    int completionId)
```
    Removes the mapping for a key from this cache if it is present.
    More formally, if this cache contains a mapping from key k to value v such that (key==null ? k==null : key.equals(k)), that mapping is removed. (The cache can contain at most one such mapping.)
    
    Returns true if this cache previously associated the key, or false if the cache contained no mapping for the key.
    The cache will not contain a mapping for the specified key once the call returns.
    
    Parameters:
    
    key - key with which the specified value is to be associated.
    
    value - value to be associated with the specified key.
    
    expiryPolicy - custom expiry policy or null to use configured default value.
    
    caller - UUID of the calling node or client.
    
    Returns:
    
    true if a value was set..
  - getAndRemove
```
Object getAndRemove(Data key,
                    String caller,
                    int completionId)
```
    Atomically removes the entry for a key only if it is currently mapped to some value.
    This is equivalent to:
```
 if (cache.containsKey(key)) {
   V oldValue = cache.get(key);
   cache.remove(key);
   return oldValue;
 } else {
   return null;
 }
 
```
    except that the action is performed atomically.
    Parameters:
    
    key - key with which the specified value is associated.
    
    caller - UUID of the calling node or client.
    
    Returns:
    
    the value if one existed or null if no mapping existed for this key.
  - remove
```
boolean remove(Data key,
               String caller,
               String origin,
               int completionId,
               CallerProvenance provenance)
```
    Removes the mapping for a key from this cache if it is present.
    More formally, if this cache contains a mapping from key k to value v such that (key==null ? k==null : key.equals(k)), that mapping is removed. (The cache can contain at most one such mapping.)
    
    Returns true if this cache previously associated the key, or false if the cache contained no mapping for the key.
    The cache will not contain a mapping for the specified key once the call returns.
    
    Parameters:
    
    key - key whose mapping is to be removed from the cache.
    
    caller - UUID of the calling node or client.
    
    origin - Source of the call
    
    completionId - User generated id which shall be received as a field of the cache event upon completion of the request in the cluster.
    
    provenance - caller operation provenance
    
    Returns:
    
    returns false if there was no matching key.
  - remove
```
boolean remove(Data key,
               String caller,
               String origin,
               int completionId)
```
  - remove
```
boolean remove(Data key,
               Object value,
               String caller,
               String origin,
               int completionId)
```
    Atomically removes the mapping for a key only if currently mapped to the given value.
    This is equivalent to:
```
 if (cache.containsKey(key) && equals(cache.get(key), oldValue) {
   cache.remove(key);
   return true;
 } else {
   return false;
 }
 
```
    except that the action is performed atomically.
    Parameters:
    
    key - key whose mapping is to be removed from the cache.
    
    value - value expected to be associated with the specified key.
    
    caller - UUID of the calling node or client.
    
    origin - Source of the call
    
    completionId - User generated id which shall be received as a field of the cache event upon completion of the request in the cluster.
    
    Returns:
    
    returns false if there was no matching key.
  - replace
```
boolean replace(Data key,
                Object value,
                javax.cache.expiry.ExpiryPolicy expiryPolicy,
                String caller,
                int completionId)
```
    Atomically replaces the entry for a key only if currently mapped to some value.
    This is equivalent to
```
 if (cache.containsKey(key)) {
   cache.put(key, value);
   return true;
 } else {
   return false;
 }
```
    except that the action is performed atomically.
    Parameters:
    
    key - the key with which the specified value is associated.
    
    value - the value to be associated with the specified key.
    
    expiryPolicy - custom expiry policy or null to use configured default value.
    
    caller - UUID of the calling node or client.
    
    Returns:
    
    true if the value was replaced.
  - replace
```
boolean replace(Data key,
                Object oldValue,
                Object newValue,
                javax.cache.expiry.ExpiryPolicy expiryPolicy,
                String caller,
                int completionId)
```
    Atomically replaces the entry for a key only if currently mapped to a given value.
    This is equivalent to:
```
 if (cache.containsKey(key) && equals(cache.get(key), oldValue)) {
  cache.put(key, newValue);
 return true;
 } else {
  return false;
 }
 
```
    except that the action is performed atomically.
    Parameters:
    
    key - key with which the specified value is associated.
    
    oldValue - value expected to be associated with the specified key.
    
    newValue - value to be associated with the specified key.
    
    expiryPolicy - custom expiry policy or null to use configured default value.
    
    caller - UUID of the calling node or client.
    
    Returns:
    
    true if the value was replaced.
  - getAndReplace
```
Object getAndReplace(Data key,
                     Object value,
                     javax.cache.expiry.ExpiryPolicy expiryPolicy,
                     String caller,
                     int completionId)
```
    Atomically replaces the value for a given key if and only if there is a value currently mapped by the key.
    This is equivalent to
```
 if (cache.containsKey(key)) {
   V oldValue = cache.get(key);
   cache.put(key, value);
   return oldValue;
 } else {
   return null;
 }
 
```
    except that the action is performed atomically.
    Parameters:
    
    key - key with which the specified value is associated.
    
    value - value to be associated with the specified key.
    
    expiryPolicy - custom expiry policy or null to use configured default value.
    
    caller - uuid of the calling node or client.
    
    Returns:
    
    the previous value associated with the specified key, or null if there was no mapping for the key.
  - setExpiryPolicy
```
boolean setExpiryPolicy(Collection<Data> keys,
                        Object expiryPolicy,
                        String source)
```
    Sets expiry policy for the records with given keys if and only if there is a value currently mapped by the key
    
    Parameters:
    
    keys - keys for the entries
    
    expiryPolicy - custom expiry policy or null to use configured default value
  - getExpiryPolicy
```
Object getExpiryPolicy(Data key)
```
  - contains
```
boolean contains(Data key)
```
    Determines if this store contains an entry for the specified key.
    More formally, returns true if and only if this store contains a mapping for a key k such that key.equals(k) (There can be at most one such mapping.)
    
    Parameters:
    
    key - key whose presence in this store is to be tested.
    
    Returns:
    
    true if this map contains a mapping for the specified key.
  - getAll
```
MapEntries getAll(Set<Data> keySet,
                  javax.cache.expiry.ExpiryPolicy expiryPolicy)
```
    Gets a collection of entries from the store, returning them as Map of the values associated with the set of keys requested.
    If the cache is configured read-through, and a get for a key would return null because an entry is missing from the cache, the Cache's CacheLoader is called in an attempt to load the entry. If an entry cannot be loaded for a given key, the key will not be present in the returned Map.
    
    Parameters:
    
    keySet - keys whose associated values are to be returned.
    
    expiryPolicy - custom expiry policy or null to use configured default value.
    
    Returns:
    
    A simple wrapper for map of entries that were found for the given keys. Keys not found in the cache are not in the result.
  - size
```
int size()
```
    Calculates the entry size of this store which reflects the partition size of the cache.
    
    Returns:
    
    partition size of the cache.
  - clear
```
void clear()
```
    clears all internal data without publishing any events
  - reset
```
void reset()
```
    Resets the record store to it's initial state. Used in replication operations.
  - removeAll
```
void removeAll(Set<Data> keys,
               int completionId)
```
    records of keys will be deleted one by one and will publish a REMOVE event for each key.
    
    Parameters:
    
    keys - set of keys to be cleaned.
  - init
```
void init()
```
    Initializes record store.
  - close
```
void close(boolean onShutdown)
```
    Close is equivalent to below operations in the given order:
    - close resources.
    - unregister all listeners.
    Parameters:
    
    onShutdown - true if close is called during CacheService shutdown, false otherwise.
    
    See Also:
    
    clear(), destroy()
  - destroy
```
void destroy()
```
    Destroy is equivalent to below operations in the given order:
    - clear all.
    - close resources.
    - unregister all listeners.
    See Also:
    
    clear(), close(boolean)
  - destroyInternals
```
void destroyInternals()
```
    Like destroy() but does not touch state on other services like event journal service.
  - getConfig
```
CacheConfig getConfig()
```
    Gets the configuration of the cache that this store belongs to.
    
    Returns:
    
    CacheConfig
  - getName
```
String getName()
```
    Gets the name of the distributed object name of the cache.
    
    Returns:
    
    name.
  - getReadOnlyRecords
```
Map<Data,CacheRecord> getReadOnlyRecords()
```
    Returns a readonly map of the internal key value store.
    
    Returns:
    
    readonly map of the internal key value store.
  - isExpirable
```
boolean isExpirable()
```
  - getRecord
```
CacheRecord getRecord(Data key)
```
    Gets internal record of the store by key.
    
    Parameters:
    
    key - the key to the entry.
    
    Returns:
    
    CacheRecord instance mapped.
  - putRecord
```
void putRecord(Data key,
               CacheRecord record,
               boolean updateJournal)
```
    Associates the specified record with the specified key. This is simply a put operation on the internal map data without any CacheLoad. It also DOES trigger eviction!
    
    Parameters:
    
    key - the key to the entry.
    
    record - the value to be associated with the specified key.
    
    updateJournal - when true an event is appended to related event-journal
  - removeRecord
```
CacheRecord removeRecord(Data key)
```
    Removes the record for a key.
    
    Parameters:
    
    key - the key to the entry.
    
    Returns:
    
    the removed record if one exists.
  - fetchKeys
```
CacheKeyIterationResult fetchKeys(int tableIndex,
                                  int size)
```
    Starting from the provided table index, a set of keys are returned with a maximum size of size
    
    Parameters:
    
    tableIndex - initial table index.
    
    size - maximum key set size.
    
    Returns:
    
    CacheKeyIterationResult which wraps keys and last tableIndex.
  - fetchEntries
```
CacheEntryIterationResult fetchEntries(int tableIndex,
                                       int size)
```
    Starting from the provided table index, a set of entries are returned with a maximum size of size
    
    Parameters:
    
    tableIndex - initial table index.
    
    size - maximum entry set size.
    
    Returns:
    
    CacheEntryIterationResult which wraps entries and last tableIndex.
  - invoke
```
Object invoke(Data key,
              javax.cache.processor.EntryProcessor entryProcessor,
              Object[] arguments,
              int completionId)
```
    Invokes an EntryProcessor against the Cache.Entry specified by the provided key. If an Cache.Entry does not exist for the specified key, an attempt is made to load it (if a loader is configured) or a surrogate Cache.Entry, consisting of the key with a null value is used instead.
    
    Parameters:
    
    key - the key of the entry.
    
    entryProcessor - the EntryProcessor to be invoked.
    
    arguments - additional arguments to be passed to the EntryProcessor.
    
    Returns:
    
    the result of the processing, if any, defined by the EntryProcessor implementation.
  - loadAll
```
Set<Data> loadAll(Set<Data> keys,
                  boolean replaceExistingValues)
```
    Synchronously loads the specified entries into the cache using the configured CacheLoader for the given keys.
    If an entry for a key already exists in the cache, a value will be loaded if and only if replaceExistingValues is true. If no loader is configured for the cache, no objects will be loaded.
    
    Parameters:
    
    keys - the keys to be loaded.
    
    replaceExistingValues - when true, existing values in the cache will be replaced by those loaded from a CacheLoader.
    
    Returns:
    
    Set of keys which are successfully loaded.
  - getCacheStats
```
CacheStatisticsImpl getCacheStats()
```
    Gets the Cache statistics associated with this CacheService.
    
    Returns:
    
    CacheStatisticsImpl cache statistics.
  - evictIfRequired
```
boolean evictIfRequired()
```
    Evict cache record store if eviction is required.
    Eviction logic is handled as specified EvictionPolicy in CacheConfig for this record store
    
    Returns:
    
    true is an entry was evicted, otherwise false
  - sampleAndForceRemoveEntries
```
void sampleAndForceRemoveEntries(int count)
```
  - isWanReplicationEnabled
```
boolean isWanReplicationEnabled()
```
    Determines whether wan replication is enabled or not for this record store.
    
    Returns:
    
    true if wan replication is enabled for this record store, false otherwise
  - getObjectNamespace
```
ObjectNamespace getObjectNamespace()
```
    Returns ObjectNamespace associated with this record store.
    
    Returns:
    
    ObjectNamespace associated with this record store.
  - merge
```
CacheRecord merge(SplitBrainMergeTypes.CacheMergeTypes mergingEntry,
                  SplitBrainMergePolicy<Data,SplitBrainMergeTypes.CacheMergeTypes> mergePolicy,
                  CallerProvenance callerProvenance)
```
    Merges the given SplitBrainMergeTypes.CacheMergeTypes via the given SplitBrainMergePolicy.
    
    Parameters:
    
    mergingEntry - the SplitBrainMergeTypes.CacheMergeTypes instance to merge
    
    mergePolicy - the SplitBrainMergePolicy instance to apply
    
    callerProvenance -
    
    Returns:
    
    the used CacheRecord if merge is applied, otherwise null
  - merge
```
CacheRecord merge(CacheEntryView<Data,Data> cacheEntryView,
                  CacheMergePolicy mergePolicy,
                  String caller,
                  String origin,
                  int completionId,
                  CallerProvenance callerProvenance)
```
    Merges the given CacheEntryView via the given CacheMergePolicy.
    
    Parameters:
    
    cacheEntryView - the CacheEntryView instance to merge
    
    mergePolicy - the CacheMergePolicy instance to apply
    
    caller - the UUID of the caller
    
    origin - source of the call
    
    completionId - User generated id which shall be received as a field of the cache event upon completion of the request in the cluster.
    
    callerProvenance -
    
    Returns:
    
    the used CacheRecord if merge is applied, otherwise null
  - getPartitionId
```
int getPartitionId()
```
    Returns:
    
    partition ID of this store
  - evictExpiredEntries
```
void evictExpiredEntries(int percentage)
```
    Do expiration operations.
    
    Parameters:
    
    percentage - of max expirables according to the record store size.
  - getExpiredKeysQueue
```
InvalidationQueue<ExpiredKey> getExpiredKeysQueue()
```
  - disposeDeferredBlocks
```
void disposeDeferredBlocks()
```

Interface ICacheRecordStore

Method Summary

Method Detail

get

put

getAndPut

putIfAbsent

getAndRemove

remove

remove

remove

replace

replace

getAndReplace

setExpiryPolicy

getExpiryPolicy

contains

getAll

size

clear

reset

removeAll

init

close

destroy

destroyInternals

getConfig

getName

getReadOnlyRecords

isExpirable

getRecord

putRecord

removeRecord

fetchKeys

fetchEntries

invoke

loadAll

getCacheStats

evictIfRequired

sampleAndForceRemoveEntries

isWanReplicationEnabled

getObjectNamespace

merge

merge

getPartitionId

evictExpiredEntries

getExpiredKeysQueue

disposeDeferredBlocks