org.gridgain.grid.kernal.processors.cache.distributed.dht

Class GridDhtCacheAdapter<K,V>

java.lang.Object

org.gridgain.grid.util.lang.GridMetadataAwareAdapter

org.gridgain.grid.kernal.processors.cache.GridCacheAdapter<K,V>

org.gridgain.grid.kernal.processors.cache.distributed.GridDistributedCacheAdapter<K,V>

org.gridgain.grid.kernal.processors.cache.distributed.dht.GridDhtCacheAdapter<K,V>

All Implemented Interfaces:

Externalizable, Serializable, Iterable<GridCacheEntry<K,V>>, GridCache<K,V>, GridCacheProjection<K,V>, GridMetadataAware, GridCacheProjectionEx<K,V>

Direct Known Subclasses:

GridDhtAtomicCache, GridDhtTransactionalCacheAdapter

public abstract class GridDhtCacheAdapter<K,V>
extends GridDistributedCacheAdapter<K,V>

DHT cache adapter.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GridDhtCacheAdapter.GridSubjectIdAddedMessageConverter616 GridDhtAtomicUpdateRequest converter for version 6.1.2

Nested classes/interfaces inherited from class org.gridgain.grid.kernal.processors.cache.GridCacheAdapter

GridCacheAdapter.AsyncOp<T>, GridCacheAdapter.FutureHolder

Field Summary

Fields

Modifier and Type	Field and Description
protected GridCachePreloader<K,V>	preldr Preloader.
static GridProductVersion	SUBJECT_ID_EVENTS_SINCE_VER

Fields inherited from class org.gridgain.grid.kernal.processors.cache.GridCacheAdapter

afterPessimisticUnlock, beforePessimisticLock, cacheCfg, CLEAR_ALL_SPLIT_THRESHOLD, ctx, gridCfg, lastFut, locNodeId, log, map, metrics

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GridDhtCacheAdapter() Empty constructor required for Externalizable.
protected	GridDhtCacheAdapter(GridCacheContext<K,V> ctx)
protected	GridDhtCacheAdapter(GridCacheContext<K,V> ctx, GridCacheConcurrentMap<K,V> map) Constructor used for near-only cache.

Method Summary

Methods

Modifier and Type	Method and Description
long	beginMultiUpdate() Starts multi-update lock.
GridDhtPreloader<K,V>	dhtPreloader()
void	endMultiUpdate() Ends multi-update lock.
GridCacheEntry<K,V>	entry(K key) Gets entry from cache with the specified key.
GridCacheEntryEx<K,V>	entryEx(K key, boolean touch)
GridCacheEntryEx<K,V>	entryEx(K key, long topVer)
GridDhtCacheEntry<K,V>	entryExx(K key)
GridDhtCacheEntry<K,V>	entryExx(K key, long topVer)
GridCacheEntryEx<K,V>	entryExx(K key, long topVer, boolean allowDetached, boolean touch) Gets or creates entry for given key.
Set<GridCacheEntry<K,V>>	entrySet(int part) Gets set containing cache entries that belong to provided partition or null if partition not found locally.
GridFuture<Map<K,V>>	getAllAsync(Collection<? extends K> keys, boolean forcePrimary, boolean skipTx, GridCacheEntryEx<K,V> entry, UUID subjId, GridPredicate<GridCacheEntry<K,V>>[] filter) This method is used internally.
GridDhtFuture<Collection<GridCacheEntryInfo<K,V>>>	getDhtAsync(UUID reader, long msgId, LinkedHashMap<? extends K,Boolean> keys, boolean reload, long topVer, UUID subjId, GridPredicate<GridCacheEntry<K,V>>[] filter)
protected void	init() Post constructor initialization for subclasses.
void	loadCache(GridBiPredicate<K,V> p, long ttl, Object[] args) Delegates to GridCacheStore.loadCache(GridBiInClosure,Object...) method to load state from the underlying persistent storage.
GridFuture<?>	multiUpdateFinishFuture(long topVer) Creates multi update finish future.
GridDhtTopologyFuture	multiUpdateTopologyFuture()
abstract GridNearCacheAdapter<K,V>	near()
GridCacheTxLocalAdapter<K,V>	newTx(boolean implicit, boolean implicitSingle, GridCacheTxConcurrency concurrency, GridCacheTxIsolation isolation, long timeout, boolean invalidate, boolean syncCommit, boolean syncRollback, boolean swapOrOffheapEnabled, boolean storeEnabled, int txSize, Object grpLockKey, boolean partLock)
void	onDeferredDelete(GridCacheEntryEx<K,V> entry, GridCacheVersion ver)
void	onKernalStart() Kernal start callback.
void	onKernalStop() Kernal stop callback.
GridDhtCacheEntry<K,V>	peekExx(K key)
GridCachePreloader<K,V>	preloader()
int	primarySize() Gets size of all primary keys for this cache.
void	printMemoryStats() Prints memory stats.
protected void	processNearGetRequest(UUID nodeId, GridNearGetRequest<K,V> req)
V	reload(K key, GridPredicate<GridCacheEntry<K,V>>... filter)
List<GridCacheClearAllRunnable<K,V>>	splitClearAll() Split clear all task into multiple runnables.
void	stop() Stops this cache.
GridDhtPartitionTopology<K,V>	topology()
String	toString()
void	unlockAll(Collection<? extends K> keys, GridPredicate<GridCacheEntry<K,V>>[] filter) Unlocks given keys only if current thread owns the locks.

Methods inherited from class org.gridgain.grid.kernal.processors.cache.distributed.GridDistributedCacheAdapter

lockAllAsync, lockAllAsync, removeVersionedEntry, txLockAsync

Methods inherited from class org.gridgain.grid.kernal.processors.cache.GridCacheAdapter

affinity, afterPessimisticUnlock, afterPessimisticUnlock, allEntries, asyncOp, asyncOpAcquire, asyncOpRelease, beforePessimisticLock, beforePessimisticLock, cache, checkJta, clear, clear0, clearAll, clearAll, clearAll0, compact, compact, compactAll, compactAll, configuration, containsAllKeys, containsAllValues, containsAnyKeys, containsAnyValues, containsKey, containsKey, containsValue, containsValue, context, dataStructures, dgc, dgc, drBackupQueueSize, drListStateTransfers, drPause, drPauseState, drResume, drStateTransfer, entries, entryEx, entryExSafe, entrySet, entrySet, entrySet, entrySetx, evict, evict, evictAll, evictAll, evictAll, flags, flagsOff, flagsOn, forAll, forceRepartition, forEach, forSubjectId, get, get, get, getAll, getAll, getAllAsync, getAllAsync, getAllAsync, getAllOutTx, getAllOutTxAsync, getAsync, getAsync, getForcePrimary, getForcePrimaryAsync, ggfsDataSpaceMax, ggfsDataSpaceUsed, globalClearAll, gridProjection, isColocated, isDht, isDhtAtomic, isDrSystemCache, isEmpty, isGgfsDataCache, isLocal, isLocked, isLockedByThread, isMongoDataCache, isMongoMetaCache, isNear, iterator, keySet, keySet, loadCacheAsync, lock, lockAll, lockAsync, log, map, metrics, metrics0, name, nearSize, offHeapAllocatedSize, offHeapEntriesCount, offHeapIterator, onGgfsDataSizeChanged, onUndeploy, overflowSize, peek, peek, peek, peek0, peek0, peek0, peekAll, peekAll0, peekAll0, peekEx, predicate, primaryEntrySet, primaryEntrySet, primaryKeySet, primaryKeySet, primaryValues, primaryValues, processCheckCommittedTxRequest, processCheckCommittedTxResponse, processCheckPreparedTxRequest, processCheckPreparedTxResponse, projection, projection, projection, promote, promoteAll, put, put, putAll, putAllAsync, putAllDr, putAllDrAsync, putAsync, putAsync, putIfAbsent, putIfAbsentAsync, putx, putx, putxAsync, putxAsync, putxIfAbsent, putxIfAbsentAsync, queries, randomEntry, readExternal, readResolve, readThroughAllAsync, reload, reloadAll, reloadAll, reloadAll, reloadAll, reloadAll, reloadAllAsync, reloadAllAsync, reloadAllAsync, reloadAllAsync, reloadAllAsync, reloadAsync, reloadAsync, remove, remove, remove, removeAll, removeAll, removeAllAsync, removeAllAsync, removeAllDr, removeAllDrAsync, removeAsync, removeAsync, removeAsync, removeEntry, removeIfObsolete, removex, removex, removex, removexAsync, removexAsync, removexAsync, replace, replace, replaceAsync, replaceAsync, replacex, replacex, replacexAsync, replacexAsync, resetMetrics, saveFuture, size, start, startInfo, stopInfo, swapIterator, swapKeys, swapSize, toMap, transform, transformAll, transformAll, transformAllAsync, transformAllAsync, transformAndCompute, transformAsync, transformAsync, tx, txStart, txStart, txStart, txStartAffinity, txStartPartition, txSynchronizations, txSynchronize, txUnsynchronize, unlock, values, values, wrappers, writeExternal

Methods inherited from class org.gridgain.grid.util.lang.GridMetadataAwareAdapter

addMeta, addMetaIfAbsent, addMetaIfAbsent, allMeta, clone, copyMeta, copyMeta, hasMeta, hasMeta, meta, putMetaIfAbsent, putMetaIfAbsent, readExternalMeta, removeMeta, removeMeta, replaceMeta, writeExternalMeta

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gridgain.grid.GridMetadataAware

addMeta, addMetaIfAbsent, addMetaIfAbsent, allMeta, copyMeta, copyMeta, hasMeta, hasMeta, meta, putMetaIfAbsent, putMetaIfAbsent, removeMeta, removeMeta, replaceMeta

Field Detail

SUBJECT_ID_EVENTS_SINCE_VER

public static final GridProductVersion SUBJECT_ID_EVENTS_SINCE_VER

preldr

protected GridCachePreloader<K,V> preldr

Preloader.

Constructor Detail

GridDhtCacheAdapter

protected GridDhtCacheAdapter()

Empty constructor required for Externalizable.

GridDhtCacheAdapter

protected GridDhtCacheAdapter(GridCacheContext<K,V> ctx)

Parameters:

ctx - Context.

GridDhtCacheAdapter

protected GridDhtCacheAdapter(GridCacheContext<K,V> ctx,
                   GridCacheConcurrentMap<K,V> map)

Constructor used for near-only cache.

Parameters:

ctx - Cache context.

map - Cache map.

Method Detail

init

protected void init()

Post constructor initialization for subclasses.

Overrides:

init in class GridCacheAdapter<K,V>

stop

public void stop()

Stops this cache. Child classes should override this method to provide custom stop behavior.

Overrides:

stop in class GridCacheAdapter<K,V>

onKernalStart

public void onKernalStart()
                   throws GridException

Kernal start callback.

Overrides:

onKernalStart in class GridCacheAdapter<K,V>

Throws:

GridException - If callback failed.

onKernalStop

public void onKernalStop()

Kernal stop callback.

Overrides:

onKernalStop in class GridCacheAdapter<K,V>

printMemoryStats

public void printMemoryStats()

Prints memory stats.

Overrides:

printMemoryStats in class GridCacheAdapter<K,V>

near

public abstract GridNearCacheAdapter<K,V> near()

Returns:

Near cache.

topology

public GridDhtPartitionTopology<K,V> topology()

Returns:

Partition topology.

preloader

public GridCachePreloader<K,V> preloader()

Specified by:

preloader in class GridCacheAdapter<K,V>

Returns:

Preloader.

dhtPreloader

public GridDhtPreloader<K,V> dhtPreloader()

Returns:

DHT preloader.

multiUpdateTopologyFuture

@Nullable
public GridDhtTopologyFuture multiUpdateTopologyFuture()

Returns:

Topology version future registered for multi-update.

beginMultiUpdate

public long beginMultiUpdate()
                      throws GridException

Starts multi-update lock. Will wait for topology future is ready.

Returns:

Topology version.

Throws:

GridException - If failed.

endMultiUpdate

public void endMultiUpdate()
                    throws GridException

Ends multi-update lock.

Throws:

GridException - If failed.

multiUpdateFinishFuture

@Nullable
public GridFuture<?> multiUpdateFinishFuture(long topVer)

Creates multi update finish future. Will return null if no multi-update locks are found.

Parameters:

topVer - Topology version.

Returns:

Finish future.

peekExx

@Nullable
public GridDhtCacheEntry<K,V> peekExx(K key)

Parameters:

key - Key.

Returns:

DHT entry.

entry

public GridCacheEntry<K,V> entry(K key)
                          throws GridDhtInvalidPartitionException

Gets entry from cache with the specified key. The returned entry can be used even after entry key has been removed from cache. In that case, every operation on returned entry will result in creation of a new entry.

Note that this method can return null if projection is configured as pre-filtered and entry key and value don't pass key-value filter of the projection.

Specified by:

entry in interface GridCacheProjection<K,V>

Overrides:

entry in class GridCacheAdapter<K,V>

Parameters:

key - Entry key.

Returns:

Cache entry or null if projection pre-filtering was not passed.

Throws:

GridDhtInvalidPartitionException - If partition for the key is no longer valid.

entryEx

public GridCacheEntryEx<K,V> entryEx(K key,
                            boolean touch)
                              throws GridDhtInvalidPartitionException

Overrides:

entryEx in class GridCacheAdapter<K,V>

Parameters:

key - Entry key.

touch - Whether created entry should be touched.

Returns:

Entry (never null).

Throws:

GridDhtInvalidPartitionException - If partition for the key is no longer valid.

entryEx

public GridCacheEntryEx<K,V> entryEx(K key,
                            long topVer)
                              throws GridDhtInvalidPartitionException

Overrides:

entryEx in class GridCacheAdapter<K,V>

Parameters:

key - Entry key.

topVer - Topology version.

Returns:

Entry (never null).

Throws:

GridDhtInvalidPartitionException - If partition for the key is no longer valid.

entryExx

public GridDhtCacheEntry<K,V> entryExx(K key)
                                throws GridDhtInvalidPartitionException

Parameters:

key - Key.

Returns:

DHT entry.

Throws:

GridDhtInvalidPartitionException - If partition for the key is no longer valid.

entryExx

public GridDhtCacheEntry<K,V> entryExx(K key,
                              long topVer)
                                throws GridDhtInvalidPartitionException

Parameters:

key - Key.

topVer - Topology version.

Returns:

DHT entry.

Throws:

GridDhtInvalidPartitionException - If partition for the key is no longer valid.

entryExx

public GridCacheEntryEx<K,V> entryExx(K key,
                             long topVer,
                             boolean allowDetached,
                             boolean touch)

Gets or creates entry for given key. If key belongs to local node, dht entry will be returned, otherwise if allowDetached is true, detached entry will be returned, otherwise exception will be thrown.

Parameters:

key - Key for which entry should be returned.

allowDetached - Whether to allow detached entries.

touch - True if entry should be passed to eviction policy.

Returns:

Cache entry.

Throws:

GridDhtInvalidPartitionException - if entry does not belong to this node and allowDetached is false.

loadCache

public void loadCache(GridBiPredicate<K,V> p,
             long ttl,
             Object[] args)
               throws GridException

Delegates to GridCacheStore.loadCache(GridBiInClosure,Object...) method to load state from the underlying persistent storage. The loaded values will then be given to the optionally passed in predicate, and, if the predicate returns true, will be stored in cache. If predicate is null, then all loaded values will be stored in cache.

Note that this method does not receive keys as a parameter, so it is up to GridCacheStore implementation to provide all the data to be loaded.

This method is not transactional and may end up loading a stale value into cache if another thread has updated the value immediately after it has been loaded. It is mostly useful when pre-loading the cache from underlying data store before start, or for read-only caches.

Specified by:

loadCache in interface GridCache<K,V>

Overrides:

loadCache in class GridCacheAdapter<K,V>

Parameters:

p - Optional predicate (may be null). If provided, will be used to filter values to be put into cache.

ttl - Time to live for loaded entries (0 for infinity).

args - Optional user arguments to be passed into GridCacheStore.loadCache(GridBiInClosure, Object...) method.

Throws:

GridException - If loading failed.

primarySize

public int primarySize()

Gets size of all primary keys for this cache. For GridCacheMode.LOCAL mode, this method is identical to GridCacheProjection.size().

For GridCacheMode.PARTITIONED and GridCacheMode.REPLICATED modes, this method will return number of primary entries in the cache (excluding any backups). The complexity of this method is O(P), where P is the total number of partitions.

Specified by:

primarySize in interface GridCacheProjection<K,V>

Overrides:

primarySize in class GridCacheAdapter<K,V>

Returns:

Number of primary entries in cache.

getAllAsync

public GridFuture<Map<K,V>> getAllAsync(@Nullable
                               Collection<? extends K> keys,
                               boolean forcePrimary,
                               boolean skipTx,
                               @Nullable
                               GridCacheEntryEx<K,V> entry,
                               @Nullable
                               UUID subjId,
                               @Nullable
                               GridPredicate<GridCacheEntry<K,V>>[] filter)

This method is used internally. Use getDhtAsync(UUID, long, LinkedHashMap, boolean, long, UUID, GridPredicate[]) method instead to retrieve DHT value.

Overrides:

getAllAsync in class GridCacheAdapter<K,V>

Parameters:

keys -

forcePrimary -

skipTx -

filter -

Returns:

reload

public V reload(K key,
       @Nullable
       GridPredicate<GridCacheEntry<K,V>>... filter)
         throws GridException

Overrides:

reload in class GridCacheAdapter<K,V>

Parameters:

key - Key.

filter - Filter to evaluate.

Returns:

Reloaded value.

Throws:

GridException - If failed.

getDhtAsync

public GridDhtFuture<Collection<GridCacheEntryInfo<K,V>>> getDhtAsync(UUID reader,
                                                             long msgId,
                                                             LinkedHashMap<? extends K,Boolean> keys,
                                                             boolean reload,
                                                             long topVer,
                                                             @Nullable
                                                             UUID subjId,
                                                             GridPredicate<GridCacheEntry<K,V>>[] filter)

Parameters:

reader - Reader node ID.

msgId - Message ID.

keys - Keys to get.

reload - Reload flag.

topVer - Topology version.

filter - Optional filter.

Returns:

DHT future.

processNearGetRequest

protected void processNearGetRequest(UUID nodeId,
                         GridNearGetRequest<K,V> req)

Parameters:

nodeId - Node ID.

req - Get request.

newTx

public GridCacheTxLocalAdapter<K,V> newTx(boolean implicit,
                                 boolean implicitSingle,
                                 GridCacheTxConcurrency concurrency,
                                 GridCacheTxIsolation isolation,
                                 long timeout,
                                 boolean invalidate,
                                 boolean syncCommit,
                                 boolean syncRollback,
                                 boolean swapOrOffheapEnabled,
                                 boolean storeEnabled,
                                 int txSize,
                                 @Nullable
                                 Object grpLockKey,
                                 boolean partLock)

Specified by:

newTx in class GridCacheAdapter<K,V>

Parameters:

implicit - True if transaction is implicit.

implicitSingle - Implicit-with-single-key flag.

concurrency - Concurrency.

isolation - Isolation.

timeout - transaction timeout.

invalidate - Invalidation flag.

syncCommit - Synchronous commit flag.

syncRollback - Synchronous rollback flag.

swapOrOffheapEnabled - If true then swap storage will be used.

storeEnabled - if true then read/write through will be used.

txSize - Expected transaction size.

grpLockKey - Group lock key if this is a group-lock transaction.

partLock - True if partition is locked.

Returns:

New transaction.

unlockAll

public void unlockAll(Collection<? extends K> keys,
             GridPredicate<GridCacheEntry<K,V>>[] filter)

Unlocks given keys only if current thread owns the locks. Only the keys that have been locked by calling thread and pass through the filter (if any) will be unlocked. If none of the key locks is owned by current thread, then this method will do nothing.

Transactions

Locks are not transactional and should not be used from within transactions. If you do need explicit locking within transaction, then you should use GridCacheTxConcurrency.PESSIMISTIC concurrency control for transaction which will acquire explicit locks for relevant cache operations.

Cache Flags

This method is not available if any of the following flags are set on projection: GridCacheFlag.LOCAL, GridCacheFlag.READ.

Parameters:

keys - Keys to unlock.

filter - Optional filter which needs to pass for individual entries to be unlocked.

entrySet

public Set<GridCacheEntry<K,V>> entrySet(int part)

Gets set containing cache entries that belong to provided partition or null if partition not found locally.

Specified by:

entrySet in interface GridCacheProjection<K,V>

Overrides:

entrySet in class GridCacheAdapter<K,V>

Parameters:

part - Partition.

Returns:

Set containing partition's entries or null if partition not found locally.

toString

public String toString()

Overrides:

toString in class GridDistributedCacheAdapter<K,V>

splitClearAll

public List<GridCacheClearAllRunnable<K,V>> splitClearAll()

Split clear all task into multiple runnables.

Overrides:

splitClearAll in class GridCacheAdapter<K,V>

Returns:

Split runnables.

onDeferredDelete

public void onDeferredDelete(GridCacheEntryEx<K,V> entry,
                    GridCacheVersion ver)

Specified by:

onDeferredDelete in class GridCacheAdapter<K,V>

Parameters:

entry - Entry.

ver - Version.