GridCacheSharedContext (Ignite 2.9.0)

java.lang.Object
- org.apache.ignite.internal.processors.cache.GridCacheSharedContext<K,V>

@GridToStringExclude
public class GridCacheSharedContext<K,V>
extends Object

Shared context.

Constructor Summary

Constructors
Constructor and Description
GridCacheSharedContext(GridKernalContext kernalCtx, IgniteTxManager txMgr, GridCacheVersionManager verMgr, GridCacheMvccManager mvccMgr, @Nullable IgnitePageStoreManager pageStoreMgr, @Nullable IgniteWriteAheadLogManager walMgr, WalStateManager walStateMgr, IgniteCacheDatabaseSharedManager dbMgr, IgniteSnapshotManager snapshotMgr, IgniteCacheSnapshotManager snpMgr, GridCacheDeploymentManager<K,V> depMgr, GridCachePartitionExchangeManager<K,V> exchMgr, CacheAffinitySharedManager<K,V> affMgr, GridCacheIoManager ioMgr, GridCacheSharedTtlCleanupManager ttlMgr, PartitionsEvictManager evictMgr, CacheJtaManagerAdapter jtaMgr, Collection<CacheStoreSessionListener> storeSesLsnrs, MvccCachingManager mvccCachingMgr, DeadlockDetectionManager deadlockDetectionMgr, CacheDiagnosticManager diagnosticMgr)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activate()`
`void`	`addCacheContext(GridCacheContext cacheCtx)` Adds cache context to shared cache context.
`CacheAffinitySharedManager<K,V>`	`affinity()`
`IgniteLogger`	`atomicMessageLogger()`
`GridCacheProcessor`	`cache()`
`GridCacheContext<K,V>`	`cacheContext(int cacheId)` Gets cache context by cache ID.
`Collection<GridCacheContext>`	`cacheContexts()` Gets all cache contexts for local node.
`@Nullable CacheObjectContext`	`cacheObjectContext(int cacheId)` Returns cache object context if created or creates new and caches it until cache started.
`void`	`cleanup()` Nulling references to potentially leak-prone objects.
`boolean`	`closed(GridCacheContext ctx)` Checks if cache context is closed.
`IgniteInternalFuture<IgniteInternalTx>`	`commitTxAsync(GridNearTxLocal tx)`
`MvccProcessor`	`coordinators()`
`IgniteCacheDatabaseSharedManager`	`database()`
`byte`	`dataCenterId()`
`void`	`deactivate()`
`DeadlockDetectionManager`	`deadlockDetectionMgr()`
`GridCacheDeploymentManager<K,V>`	`deploy()`
`boolean`	`deploymentEnabled()`
`CacheDiagnosticManager`	`diagnostic()`
`GridDiscoveryManager`	`discovery()`
`void`	`endTx(GridNearTxLocal tx)`
`PartitionsEvictManager`	`evict()`
`GridCachePartitionExchangeManager<K,V>`	`exchange()`
`void`	`finishDhtAtomicUpdate(GridCacheVersion ver)`
`int`	`getLocalStoreCount()`
`IgniteConfiguration`	`gridConfig()`
`GridDeploymentManager`	`gridDeploy()`
`GridEventStorageManager`	`gridEvents()`
`GridIoManager`	`gridIO()`
`String`	`igniteInstanceName()`
`GridCacheIoManager`	`io()`
`boolean`	`isLazyMemoryAllocation(@Nullable DataRegion region)`
`boolean`	`isRebalanceEnabled()`
`CacheJtaManagerAdapter`	`jta()`
`GridKernalContext`	`kernalContext()`
`ClusterNode`	`localNode()`
`UUID`	`localNodeId()`
`boolean`	`localStorePrimaryOnly()` Indicating whether local store keeps primary only.
`@Nullable AffinityTopologyVersion`	`lockedTopologyVersion(IgniteInternalTx ignore)`
`IgniteLogger`	`logger(Class<?> cls)` Gets grid logger for given class.
`IgniteLogger`	`logger(String category)`
`List<GridCacheSharedManager<K,V>>`	`managers()`
`Marshaller`	`marshaller()`
`IgniteLogger`	`messageLogger()`
`GridCacheMvccManager`	`mvcc()`
`MvccCachingManager`	`mvccCaching()`
`IgniteInternalFuture<?>`	`nextAffinityReadyFuture(AffinityTopologyVersion curVer)` Gets ready future for the next affinity topology version (used in cases when a node leaves grid).
`@Nullable ClusterNode`	`node(UUID nodeId)`
`@Nullable IgnitePageStoreManager`	`pageStore()`
`IgniteInternalFuture<?>`	`partitionRecoveryFuture(AffinityTopologyVersion topVer, ClusterNode node, IgnitePredicate<IgniteInternalTx> filter)` Captures all prepared operations that we need to wait before we able to perform PME-free switch.
`IgniteInternalFuture<?>`	`partitionReleaseFuture(AffinityTopologyVersion topVer)` Captures all ongoing operations that we need to wait before we can proceed to the next topology version.
`long`	`preloadExchangeTimeout()`
`boolean`	`readOnlyMode()`
`void`	`readOnlyMode(boolean readOnlyMode)`
`void`	`rebalanceEnabled(boolean rebalanceEnabled)`
`void`	`resetTxMetrics()` Resets tx metrics.
`void`	`resumeTx(GridNearTxLocal tx)` Resume transaction if it was previously suspended.
`IgniteInternalFuture`	`rollbackTxAsync(GridNearTxLocal tx)`
`void`	`setTxManager(IgniteTxManager txMgr)` For test purposes.
`IgniteCacheSnapshotManager`	`snapshot()`
`IgniteSnapshotManager`	`snapshotMgr()`
`int`	`startDhtAtomicUpdate(GridCacheVersion ver)`
`@Nullable Collection<CacheStoreSessionListener>`	`storeSessionListeners()`
`void`	`suspendTx(GridNearTxLocal tx)` Suspends transaction.
`GridTimeoutProcessor`	`time()`
`IgniteTxManager`	`tm()`
`GridCacheSharedTtlCleanupManager`	`ttl()`
`TransactionConfiguration`	`txConfig()` Gets transactions configuration.
`void`	`txContextReset()` Reset thread-local context for transactional cache.
`IgniteLogger`	`txFinishMessageLogger()`
`IgniteLogger`	`txLockMessageLogger()`
`TransactionMetricsAdapter`	`txMetrics()`
`IgniteLogger`	`txPrepareMessageLogger()`
`IgniteLogger`	`txRecoveryMessageLogger()`
`@Nullable String`	`verifyTxCompatibility(IgniteInternalTx tx, GridIntList activeCacheIds, GridCacheContext<K,V> cacheCtx)`
`GridCacheVersionManager`	`versions()`
`IgniteWriteAheadLogManager`	`wal()`
`WalStateManager`	`walState()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GridCacheSharedContext

public GridCacheSharedContext(GridKernalContext kernalCtx,
                              IgniteTxManager txMgr,
                              GridCacheVersionManager verMgr,
                              GridCacheMvccManager mvccMgr,
                              @Nullable
                              @Nullable IgnitePageStoreManager pageStoreMgr,
                              @Nullable
                              @Nullable IgniteWriteAheadLogManager walMgr,
                              WalStateManager walStateMgr,
                              IgniteCacheDatabaseSharedManager dbMgr,
                              IgniteSnapshotManager snapshotMgr,
                              IgniteCacheSnapshotManager snpMgr,
                              GridCacheDeploymentManager<K,V> depMgr,
                              GridCachePartitionExchangeManager<K,V> exchMgr,
                              CacheAffinitySharedManager<K,V> affMgr,
                              GridCacheIoManager ioMgr,
                              GridCacheSharedTtlCleanupManager ttlMgr,
                              PartitionsEvictManager evictMgr,
                              CacheJtaManagerAdapter jtaMgr,
                              Collection<CacheStoreSessionListener> storeSesLsnrs,
                              MvccCachingManager mvccCachingMgr,
                              DeadlockDetectionManager deadlockDetectionMgr,
                              CacheDiagnosticManager diagnosticMgr)

Parameters:: kernalCtx - Context.; txMgr - Transaction manager.; verMgr - Version manager.; mvccMgr - MVCC manager.; pageStoreMgr - Page store manager. Null if persistence is not enabled.; walMgr - WAL manager. Null if persistence is not enabled.; walStateMgr - WAL state manager.; depMgr - Deployment manager.; dbMgr - Database manager.; snpMgr - Snapshot manager.; exchMgr - Exchange manager.; affMgr - Affinity manager.; ioMgr - IO manager.; ttlMgr - Ttl cleanup manager.; evictMgr - Partitons evict manager.; jtaMgr - JTA manager.; storeSesLsnrs - Store session listeners.; mvccCachingMgr - Mvcc caching manager.; deadlockDetectionMgr - Deadlock detection manager.

Method Detail
- activate
```
public void activate()
              throws IgniteCheckedException
```
  Throws:
  
  IgniteCheckedException - If failed.
- deactivate
```
public void deactivate()
```
- messageLogger
```
public IgniteLogger messageLogger()
```
  Returns:
  
  Logger.
- atomicMessageLogger
```
public IgniteLogger atomicMessageLogger()
```
  Returns:
  
  Logger.
- txPrepareMessageLogger
```
public IgniteLogger txPrepareMessageLogger()
```
  Returns:
  
  Logger.
- txFinishMessageLogger
```
public IgniteLogger txFinishMessageLogger()
```
  Returns:
  
  Logger.
- txLockMessageLogger
```
public IgniteLogger txLockMessageLogger()
```
  Returns:
  
  Logger.
- txRecoveryMessageLogger
```
public IgniteLogger txRecoveryMessageLogger()
```
  Returns:
  
  Logger.
- isRebalanceEnabled
```
public boolean isRebalanceEnabled()
```
  Returns:
  
  rebalance enabled flag.
- rebalanceEnabled
```
public void rebalanceEnabled(boolean rebalanceEnabled)
```
  Parameters:
  
  rebalanceEnabled - rebalance enabled flag.
- cacheContexts
```
public Collection<GridCacheContext> cacheContexts()
```
  Gets all cache contexts for local node.
  
  Returns:
  
  Collection of all cache contexts.
- cache
```
public GridCacheProcessor cache()
```
  Returns:
  
  Cache processor.
- addCacheContext
```
public void addCacheContext(GridCacheContext cacheCtx)
                     throws IgniteCheckedException
```
  Adds cache context to shared cache context.
  
  Parameters:
  
  cacheCtx - Cache context to add.
  
  Throws:
  
  IgniteCheckedException - If cache ID conflict detected.
- closed
```
public boolean closed(GridCacheContext ctx)
```
  Checks if cache context is closed.
  
  Parameters:
  
  ctx - Cache context to check.
  
  Returns:
  
  True if cache context is closed.
- managers
```
public List<GridCacheSharedManager<K,V>> managers()
```
  Returns:
  
  List of shared context managers in starting order.
- cacheContext
```
public GridCacheContext<K,V> cacheContext(int cacheId)
```
  Gets cache context by cache ID.
  
  Parameters:
  
  cacheId - Cache ID.
  
  Returns:
  
  Cache context.
- cacheObjectContext
```
@Nullable
public @Nullable CacheObjectContext cacheObjectContext(int cacheId)
                                                          throws IgniteCheckedException
```
  Returns cache object context if created or creates new and caches it until cache started.
  
  Parameters:
  
  cacheId - Cache id.
  
  Throws:
  
  IgniteCheckedException
- igniteInstanceName
```
public String igniteInstanceName()
```
  Returns:
  
  Ignite instance name.
- txConfig
```
public TransactionConfiguration txConfig()
```
  Gets transactions configuration.
  
  Returns:
  
  Transactions configuration.
- preloadExchangeTimeout
```
public long preloadExchangeTimeout()
```
  Returns:
  
  Timeout for initial map exchange before preloading. We make it 4 times bigger than network timeout by default.
- deploymentEnabled
```
public boolean deploymentEnabled()
```
  Returns:
  
  Deployment enabled flag.
- dataCenterId
```
public byte dataCenterId()
```
  Returns:
  
  Data center ID.
- txMetrics
```
public TransactionMetricsAdapter txMetrics()
```
  Returns:
  
  Transactional metrics adapter.
- resetTxMetrics
```
public void resetTxMetrics()
```
  Resets tx metrics.
- tm
```
public IgniteTxManager tm()
```
  Returns:
  
  Cache transaction manager.
- jta
```
public CacheJtaManagerAdapter jta()
```
  Returns:
  
  JTA manager.
- exchange
```
public GridCachePartitionExchangeManager<K,V> exchange()
```
  Returns:
  
  Exchange manager.
- affinity
```
public CacheAffinitySharedManager<K,V> affinity()
```
  Returns:
  
  Affinity manager.
- versions
```
public GridCacheVersionManager versions()
```
  Returns:
  
  Lock order manager.
- mvcc
```
public GridCacheMvccManager mvcc()
```
  Returns:
  
  Lock manager.
- database
```
public IgniteCacheDatabaseSharedManager database()
```
  Returns:
  
  Database manager.
- snapshot
```
public IgniteCacheSnapshotManager snapshot()
```
  Returns:
  
  Snapshot manager.
- pageStore
```
@Nullable
public @Nullable IgnitePageStoreManager pageStore()
```
  Returns:
  
  Page store manager. Null if persistence is not enabled.
- snapshotMgr
```
public IgniteSnapshotManager snapshotMgr()
```
  Returns:
  
  Page storage snapshot manager.
- wal
```
public IgniteWriteAheadLogManager wal()
```
  Returns:
  
  Write ahead log manager.
- walState
```
public WalStateManager walState()
```
  Returns:
  
  WAL state manager.
- io
```
public GridCacheIoManager io()
```
  Returns:
  
  IO manager.
- ttl
```
public GridCacheSharedTtlCleanupManager ttl()
```
  Returns:
  
  Ttl cleanup manager.
- deploy
```
public GridCacheDeploymentManager<K,V> deploy()
```
  Returns:
  
  Cache deployment manager.
- marshaller
```
public Marshaller marshaller()
```
  Returns:
  
  Marshaller.
- gridConfig
```
public IgniteConfiguration gridConfig()
```
  Returns:
  
  Grid configuration.
- kernalContext
```
public GridKernalContext kernalContext()
```
  Returns:
  
  Kernal context.
- gridIO
```
public GridIoManager gridIO()
```
  Returns:
  
  Grid IO manager.
- gridDeploy
```
public GridDeploymentManager gridDeploy()
```
  Returns:
  
  Grid deployment manager.
- gridEvents
```
public GridEventStorageManager gridEvents()
```
  Returns:
  
  Grid event storage manager.
- discovery
```
public GridDiscoveryManager discovery()
```
  Returns:
  
  Discovery manager.
- time
```
public GridTimeoutProcessor time()
```
  Returns:
  
  Timeout processor.
- coordinators
```
public MvccProcessor coordinators()
```
  Returns:
  
  Cache mvcc coordinator manager.
- evict
```
public PartitionsEvictManager evict()
```
  Returns:
  
  Partition evict manager.
- mvccCaching
```
public MvccCachingManager mvccCaching()
```
  Returns:
  
  Mvcc transaction enlist caching manager.
- diagnostic
```
public CacheDiagnosticManager diagnostic()
```
  Returns:
  
  Diagnostic manager.
- deadlockDetectionMgr
```
public DeadlockDetectionManager deadlockDetectionMgr()
```
  Returns:
  
  Deadlock detection manager.
- localNodeId
```
public UUID localNodeId()
```
  Returns:
  
  Node ID.
- localNode
```
public ClusterNode localNode()
```
  Returns:
  
  Local node.
- getLocalStoreCount
```
public int getLocalStoreCount()
```
  Returns:
  
  Count of caches with configured local stores.
- node
```
@Nullable
public @Nullable ClusterNode node(UUID nodeId)
```
  Parameters:
  
  nodeId - Node ID.
  
  Returns:
  
  Node or null.
- localStorePrimaryOnly
```
public boolean localStorePrimaryOnly()
```
  Indicating whether local store keeps primary only.
- logger
```
public IgniteLogger logger(Class<?> cls)
```
  Gets grid logger for given class.
  
  Parameters:
  
  cls - Class to get logger for.
  
  Returns:
  
  IgniteLogger instance.
- logger
```
public IgniteLogger logger(String category)
```
  Parameters:
  
  category - Category.
  
  Returns:
  
  Logger.
- partitionReleaseFuture
```
public IgniteInternalFuture<?> partitionReleaseFuture(AffinityTopologyVersion topVer)
```
  Captures all ongoing operations that we need to wait before we can proceed to the next topology version. This method must be called only after GridDhtPartitionTopology.updateTopologyVersion(org.apache.ignite.internal.processors.cache.distributed.dht.GridDhtTopologyFuture, org.apache.ignite.internal.managers.discovery.DiscoCache, long, boolean) method is called so that all new updates will wait to switch to the new version. This method will capture:
  - All non-released cache locks
  - All non-committed transactions (local and remote)
  - All pending atomic updates
  - All pending DataStreamer updates
  Captured updates are wrapped in a future that will be completed once pending objects are released.
  Parameters:
  
  topVer - Topology version.
  
  Returns:
  
  true if waiting was successful.
- partitionRecoveryFuture
```
public IgniteInternalFuture<?> partitionRecoveryFuture(AffinityTopologyVersion topVer,
                                                       ClusterNode node,
                                                       IgnitePredicate<IgniteInternalTx> filter)
```
  Captures all prepared operations that we need to wait before we able to perform PME-free switch. This method must be called only after GridDhtPartitionTopology.updateTopologyVersion(org.apache.ignite.internal.processors.cache.distributed.dht.GridDhtTopologyFuture, org.apache.ignite.internal.managers.discovery.DiscoCache, long, boolean) method is called so that all new updates will wait to switch to the new version. Captured updates are wrapped in a future that will be completed once pending objects are released.
  
  Parameters:
  
  topVer - Topology version.
  
  node - Failed node.
  
  filter - Recovery filter.
  
  Returns:
  
  true if waiting was successful.
- nextAffinityReadyFuture
```
public IgniteInternalFuture<?> nextAffinityReadyFuture(AffinityTopologyVersion curVer)
```
  Gets ready future for the next affinity topology version (used in cases when a node leaves grid).
  
  Parameters:
  
  curVer - Current topology version (before a node left grid).
  
  Returns:
  
  Ready future.
- verifyTxCompatibility
```
@Nullable
public @Nullable String verifyTxCompatibility(IgniteInternalTx tx,
                                                        GridIntList activeCacheIds,
                                                        GridCacheContext<K,V> cacheCtx)
```
  Parameters:
  
  tx - Transaction to check.
  
  activeCacheIds - Active cache IDs.
  
  cacheCtx - Cache context.
  
  Returns:
  
  Error message if transactions are incompatible.
- lockedTopologyVersion
```
@Nullable
public @Nullable AffinityTopologyVersion lockedTopologyVersion(IgniteInternalTx ignore)
```
  Parameters:
  
  ignore - Transaction to ignore.
  
  Returns:
  
  Not null topology version if current thread holds lock preventing topology change.
- cleanup
```
public void cleanup()
```
  Nulling references to potentially leak-prone objects.
- endTx
```
public void endTx(GridNearTxLocal tx)
           throws IgniteCheckedException
```
  Parameters:
  
  tx - Transaction to close.
  
  Throws:
  
  IgniteCheckedException - If failed.
- commitTxAsync
```
public IgniteInternalFuture<IgniteInternalTx> commitTxAsync(GridNearTxLocal tx)
```
  Parameters:
  
  tx - Transaction to commit.
  
  Returns:
  
  Commit future.
- rollbackTxAsync
```
public IgniteInternalFuture rollbackTxAsync(GridNearTxLocal tx)
```
  Parameters:
  
  tx - Transaction to rollback.
  
  Returns:
  
  Rollback future.
- suspendTx
```
public void suspendTx(GridNearTxLocal tx)
               throws IgniteCheckedException
```
  Suspends transaction. It could be resume later. Supported only for optimistic transactions.
  
  Parameters:
  
  tx - Transaction to suspend.
  
  Throws:
  
  IgniteCheckedException - If suspension failed.
- resumeTx
```
public void resumeTx(GridNearTxLocal tx)
              throws IgniteCheckedException
```
  Resume transaction if it was previously suspended.
  
  Parameters:
  
  tx - Transaction to resume.
  
  Throws:
  
  IgniteCheckedException - If resume failed.
- storeSessionListeners
```
@Nullable
public @Nullable Collection<CacheStoreSessionListener> storeSessionListeners()
```
  Returns:
  
  Store session listeners.
- txContextReset
```
public void txContextReset()
```
  Reset thread-local context for transactional cache.
- startDhtAtomicUpdate
```
public int startDhtAtomicUpdate(GridCacheVersion ver)
```
  Parameters:
  
  ver - DHT atomic update future version.
  
  Returns:
  
  Amount of active DHT atomic updates.
- finishDhtAtomicUpdate
```
public void finishDhtAtomicUpdate(GridCacheVersion ver)
```
  Parameters:
  
  ver - DHT atomic update future version.
- readOnlyMode
```
public boolean readOnlyMode()
```
  Returns:
  
  true if cluster is in read-only mode.
- readOnlyMode
```
public void readOnlyMode(boolean readOnlyMode)
```
  Parameters:
  
  readOnlyMode - Read-only flag.
- setTxManager
```
public void setTxManager(IgniteTxManager txMgr)
```
  For test purposes.
  
  Parameters:
  
  txMgr - Tx manager.
- isLazyMemoryAllocation
```
public boolean isLazyMemoryAllocation(@Nullable
                                      @Nullable DataRegion region)
```
  Returns:
  
  True if lazy memory allocation enabled. False otherwise.

Class GridCacheSharedContext<K,V>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GridCacheSharedContext

Method Detail

activate

deactivate

messageLogger

atomicMessageLogger

txPrepareMessageLogger

txFinishMessageLogger

txLockMessageLogger

txRecoveryMessageLogger

isRebalanceEnabled

rebalanceEnabled

cacheContexts

cache

addCacheContext

closed

managers

cacheContext

cacheObjectContext

igniteInstanceName

txConfig

preloadExchangeTimeout

deploymentEnabled

dataCenterId

txMetrics

resetTxMetrics

tm

jta

exchange

affinity

versions

mvcc

database

snapshot

pageStore

snapshotMgr

wal

walState

io

ttl

deploy

marshaller

gridConfig

kernalContext

gridIO

gridDeploy

gridEvents

discovery

time

coordinators

evict

mvccCaching

diagnostic

deadlockDetectionMgr

localNodeId

localNode

getLocalStoreCount

node

localStorePrimaryOnly

logger

logger

partitionReleaseFuture

partitionRecoveryFuture

nextAffinityReadyFuture

verifyTxCompatibility

lockedTopologyVersion

cleanup

endTx

commitTxAsync

rollbackTxAsync

suspendTx

resumeTx

storeSessionListeners

txContextReset

startDhtAtomicUpdate