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

Class GridNearTransactionalCache<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.near.GridNearCacheAdapter<K,V>

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

All Implemented Interfaces:

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

public class GridNearTransactionalCache<K,V>
extends GridNearCacheAdapter<K,V>

Near cache for transactional cache.

See Also:

Serialized Form

Nested Class Summary

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

GridCacheAdapter.AsyncOp<T>, GridCacheAdapter.FutureHolder

Field Summary

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

Constructor and Description
GridNearTransactionalCache() Empty constructor required for Externalizable.
GridNearTransactionalCache(GridCacheContext<K,V> ctx)

Method Summary

Methods

Modifier and Type	Method and Description
void	clearLocks(UUID nodeId, GridDhtUnlockRequest<K,V> req)
void	dgc() Runs DGC procedure on demand using GridCacheConfiguration.getDgcSuspectLockTimeout() to identify suspect locks.
void	dgc(long suspectLockTimeout, boolean global, boolean rmvLocks) Runs DGC procedure on demand using provided parameter to identify suspect locks.
GridDhtCache<K,V>	dht()
void	dht(GridDhtCache<K,V> dht)
protected boolean	evictNearEntry(GridCacheEntryEx<K,V> e, GridCacheVersion obsoleteVer, long topVer)
GridFuture<Map<K,V>>	getAllAsync(Collection<? extends K> keys, boolean forcePrimary, boolean skipTx, GridCacheEntryEx<K,V> entry, UUID subjId, GridPredicate<GridCacheEntry<K,V>>[] filter)
protected boolean	isNearLocallyMapped(GridCacheEntryEx<K,V> e, long topVer)
protected GridFuture<Boolean>	lockAllAsync(Collection<? extends K> keys, long timeout, GridCacheTxLocalEx<K,V> tx, boolean isInvalidate, boolean isRead, boolean retval, GridCacheTxIsolation isolation, GridPredicate<GridCacheEntry<K,V>>[] filter)
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	removeLocks(GridCacheVersion ver, Collection<? extends K> keys) Removes locks regardless of whether they are owned or not for given version and keys.
void	start() Starts this cache.
GridNearTxRemote<K,V>	startRemoteTx(ClassLoader ldr, UUID nodeId, GridDhtTxPrepareRequest<K,V> req) Called while processing dht tx prepare request.
GridNearTxRemote<K,V>	startRemoteTx(UUID nodeId, GridDhtLockRequest<K,V> req)
GridNearTxRemote<K,V>	startRemoteTxForFinish(UUID nodeId, GridDhtTxFinishRequest<K,V> req)
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.near.GridNearCacheAdapter

afterPessimisticUnlock, afterPessimisticUnlock, beforePessimisticLock, beforePessimisticLock, clear0, clearAll0, compact, containsKey, drBackupQueueSize, drListStateTransfers, drPause, drPauseState, drResume, drStateTransfer, entry, entryEx, entryEx, entryExx, entrySet, entrySet, evict, evictAll, evictNearOnly, ggfsDataSpaceMax, ggfsDataSpaceUsed, init, isAllLockedNearOnly, isGgfsDataCache, isLocked, isLockedNearOnly, isMongoDataCache, isMongoMetaCache, isNear, keySet, loadAsync, loadCache, loadCacheAsync, nearEntries, nearKeySet, nearSize, offHeapAllocatedSize, offHeapEntriesCount, offHeapIterator, onGgfsDataSizeChanged, peek, peek, peekAll, peekExx, peekNearOnly, preloader, primaryEntrySet, primaryKeySet, primarySize, primaryValues, processGetResponse, promote, promoteAll, readThroughAllAsync, reload, reloadAll, reloadAll, reloadAllAsync, reloadAllAsync, reloadAllAsync, resetMetrics, size, splitClearAll, swapIterator, swapKeys, swapSize, values

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

lockAllAsync, removeVersionedEntry, txLockAsync

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

affinity, allEntries, asyncOp, asyncOpAcquire, asyncOpRelease, cache, checkJta, clear, clearAll, clearAll, compact, compactAll, compactAll, configuration, containsAllKeys, containsAllValues, containsAnyKeys, containsAnyValues, containsKey, containsValue, containsValue, context, dataStructures, entries, entryEx, entryExSafe, entrySet, entrySet, entrySetx, evict, evictAll, evictAll, flags, flagsOff, flagsOn, forAll, forceRepartition, forEach, forSubjectId, get, get, get, getAll, getAll, getAllAsync, getAllAsync, getAllAsync, getAllOutTx, getAllOutTxAsync, getAsync, getAsync, getForcePrimary, getForcePrimaryAsync, globalClearAll, gridProjection, isColocated, isDht, isDhtAtomic, isDrSystemCache, isEmpty, isLocal, isLockedByThread, iterator, keySet, lock, lockAll, lockAsync, log, map, metrics, metrics0, name, onKernalStart, onKernalStop, onUndeploy, overflowSize, peek, peek0, peek0, peek0, peekAll0, peekAll0, peekEx, predicate, primaryEntrySet, primaryKeySet, primaryValues, printMemoryStats, processCheckCommittedTxRequest, processCheckCommittedTxResponse, processCheckPreparedTxRequest, processCheckPreparedTxResponse, projection, projection, projection, put, put, putAll, putAllAsync, putAllDr, putAllDrAsync, putAsync, putAsync, putIfAbsent, putIfAbsentAsync, putx, putx, putxAsync, putxAsync, putxIfAbsent, putxIfAbsentAsync, queries, randomEntry, readExternal, readResolve, reload, reloadAll, reloadAll, reloadAll, 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, saveFuture, startInfo, stop, stopInfo, toMap, transform, transformAll, transformAll, transformAllAsync, transformAllAsync, transformAndCompute, transformAsync, transformAsync, tx, txStart, txStart, txStart, txStartAffinity, txStartPartition, txSynchronizations, txSynchronize, txUnsynchronize, unlock, 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

Constructor Detail

GridNearTransactionalCache

public GridNearTransactionalCache()

Empty constructor required for Externalizable.

GridNearTransactionalCache

public GridNearTransactionalCache(GridCacheContext<K,V> ctx)

Parameters:

ctx - Context.

Method Detail

start

public void start()
           throws GridException

Starts this cache. Child classes should override this method to provide custom start-up behavior.

Overrides:

start in class GridCacheAdapter<K,V>

Throws:

GridException - If start failed.

dgc

public void dgc()

Runs DGC procedure on demand using GridCacheConfiguration.getDgcSuspectLockTimeout() to identify suspect locks.

Method blocks current thread until locks are examined and all DGC requests are sent to remote nodes.

DGC does not remove locks if GridCacheConfiguration.isDgcRemoveLocks() is set to false.

Specified by:

dgc in interface GridCache<K,V>

Overrides:

dgc in class GridCacheAdapter<K,V>

dgc

public void dgc(long suspectLockTimeout,
       boolean global,
       boolean rmvLocks)

Runs DGC procedure on demand using provided parameter to identify suspect locks.

Method blocks current thread until locks are examined and all DGC requests are sent to remote nodes and (if global is true) all nodes running this cache will get signal to start GC procedure.

Specified by:

dgc in interface GridCache<K,V>

Overrides:

dgc in class GridCacheAdapter<K,V>

Parameters:

suspectLockTimeout - Custom suspect lock timeout (should be greater than or equal to 0).

global - If true then GC procedure will start on all nodes having this cache.

rmvLocks - If false then DGC does not remove locks, just report them to log.

dht

public void dht(GridDhtCache<K,V> dht)

Parameters:

dht - DHT cache.

dht

public GridDhtCache<K,V> dht()

Specified by:

dht in class GridNearCacheAdapter<K,V>

Returns:

DHT 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)

Overrides:

getAllAsync in class GridCacheAdapter<K,V>

clearLocks

public void clearLocks(UUID nodeId,
              GridDhtUnlockRequest<K,V> req)

Parameters:

nodeId - Node ID.

req - Request.

startRemoteTx

@Nullable
public GridNearTxRemote<K,V> startRemoteTx(ClassLoader ldr,
                                           UUID nodeId,
                                           GridDhtTxPrepareRequest<K,V> req)
                                    throws GridException

Called while processing dht tx prepare request.

Parameters:

ldr - Loader.

nodeId - Sender node ID.

req - Request.

Returns:

Remote transaction.

Throws:

GridException - If failed.

startRemoteTx

@Nullable
public GridNearTxRemote<K,V> startRemoteTx(UUID nodeId,
                                           GridDhtLockRequest<K,V> req)
                                    throws GridException,
                                           GridDistributedLockCancelledException

Parameters:

nodeId - Primary node ID.

req - Request.

Returns:

Remote transaction.

Throws:

GridException - If failed.

GridDistributedLockCancelledException - If lock has been cancelled.

startRemoteTxForFinish

@Nullable
public GridNearTxRemote<K,V> startRemoteTxForFinish(UUID nodeId,
                                                    GridDhtTxFinishRequest<K,V> req)
                                             throws GridException,
                                                    GridDistributedLockCancelledException

Parameters:

nodeId - Primary node ID.

req - Request.

Returns:

Remote transaction.

Throws:

GridException - If failed.

GridDistributedLockCancelledException - If lock has been cancelled.

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.

lockAllAsync

protected GridFuture<Boolean> lockAllAsync(Collection<? extends K> keys,
                               long timeout,
                               GridCacheTxLocalEx<K,V> tx,
                               boolean isInvalidate,
                               boolean isRead,
                               boolean retval,
                               GridCacheTxIsolation isolation,
                               GridPredicate<GridCacheEntry<K,V>>[] filter)

Specified by:

lockAllAsync in class GridDistributedCacheAdapter<K,V>

Parameters:

keys - Keys to lock.

timeout - Timeout.

tx - Transaction

isInvalidate - Invalidation flag.

isRead - Indicates whether value is read or written.

retval - Flag to return value.

isolation - Transaction isolation.

filter - Optional filter.

Returns:

Future for locks.

isNearLocallyMapped

protected boolean isNearLocallyMapped(GridCacheEntryEx<K,V> e,
                          long topVer)

Parameters:

e - Transaction entry.

Returns:

True if entry is locally mapped as a primary or back up node.

evictNearEntry

protected boolean evictNearEntry(GridCacheEntryEx<K,V> e,
                     GridCacheVersion obsoleteVer,
                     long topVer)

Parameters:

e - Entry to evict if it qualifies for eviction.

obsoleteVer - Obsolete version.

topVer - Topology version.

Returns:

True if attempt was made to evict the entry.

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.

removeLocks

public void removeLocks(GridCacheVersion ver,
               Collection<? extends K> keys)

Removes locks regardless of whether they are owned or not for given version and keys.

Parameters:

ver - Lock version.

keys - Keys.

onDeferredDelete

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

Specified by:

onDeferredDelete in class GridCacheAdapter<K,V>

Parameters:

entry - Entry.

ver - Version.

toString

public String toString()

Overrides:

toString in class GridNearCacheAdapter<K,V>