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

Class GridDistributedTxRemoteAdapter<K,V>

java.lang.Object

org.gridgain.grid.util.lang.GridMetadataAwareAdapter

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

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

All Implemented Interfaces:

Externalizable, Serializable, AutoCloseable, GridCacheTx, GridMetadataAware, GridCacheTxEx<K,V>, GridCacheTxRemoteEx<K,V>, GridTimeoutObject

Direct Known Subclasses:

GridDhtTxRemote, GridNearTxRemote

public class GridDistributedTxRemoteAdapter<K,V>
extends GridCacheTxAdapter<K,V>
implements GridCacheTxRemoteEx<K,V>

Transaction created by system implicitly on remote nodes.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.gridgain.grid.kernal.processors.cache.GridCacheTxEx

GridCacheTxEx.FinalizationStatus

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<K,GridCacheTxEntry<K,V>>	readMap Read set.
protected Map<K,GridCacheTxEntry<K,V>>	writeMap Write map.

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

cctx, concurrency, endVer, grpLockKey, implicit, implicitSingle, internal, invalidate, isDone, isolation, loc, log, nodeId, onePhaseCommit, startTime, startVer, storeEnabled, subjId, swapOrOffheapEnabled, threadId, timeout, txSize, writeVer, xidVer

Constructor Summary

Constructors

Constructor and Description
GridDistributedTxRemoteAdapter() Empty constructor required for Externalizable.
GridDistributedTxRemoteAdapter(GridCacheContext<K,V> ctx, UUID nodeId, long rmtThreadId, GridCacheVersion xidVer, GridCacheVersion commitVer, GridCacheTxConcurrency concurrency, GridCacheTxIsolation isolation, boolean invalidate, long timeout, int txSize, Object grpLockKey, UUID subjId)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addExplicit(GridCacheTxEntry<K,V> e) Adds explicit version if there is one.
void	addLocalCandidates(K key, Collection<GridCacheMvccCandidate<K>> cands)
void	addRead(K key, byte[] keyBytes, GridCacheVersion drVer)
void	addRemoteCandidates(Map<K,Collection<GridCacheMvccCandidate<K>>> cands, Collection<GridCacheVersion> committedVers, Collection<GridCacheVersion> rolledbackVers) Adds remote candidates and completed versions to all involved entries.
void	addWrite(K key, byte[] keyBytes, GridCacheOperation op, V val, byte[] valBytes, GridCacheVersion drVer)
Collection<GridCacheTxEntry<K,V>>	allEntries()
Collection<GridCacheVersion>	alternateVersions()
void	clearEntry(K key) Clears entry from transaction as it never happened.
void	commit() Commits this transaction by initiating two-phase-commit process.
GridFuture<GridCacheTx>	commitAsync() Asynchronously commits this transaction by initiating two-phase-commit process.
void	doneRemote(GridCacheVersion baseVer, Collection<GridCacheVersion> committedVers, Collection<GridCacheVersion> rolledbackVers, Collection<GridCacheVersion> pendingVers)
boolean	empty()
GridCacheTxEntry<K,V>	entry(K key)
UUID	eventNodeId()
void	forceCommit() Forces commit for this tx.
void	groupLockKey(Object key) Adds group lock key to remote transaction.
boolean	hasReadKey(K key)
boolean	hasWriteKey(K key)
void	invalidate(boolean invalidate)
boolean	isStarted()
Map<K,Collection<GridCacheMvccCandidate<K>>>	localCandidates()
Collection<UUID>	masterNodeIds()
boolean	onOwnerChanged(GridCacheEntryEx<K,V> entry, GridCacheMvccCandidate<K> owner) Callback invoked whenever there is a lock that has been acquired by this transaction for any of the participating entries.
UUID	originatingNodeId() Gets node ID which directly started this transaction.
GridTuple<V>	peek(boolean failFast, K key, GridPredicate<GridCacheEntry<K,V>>[] filter)
void	prepare() Prepare phase.
GridFuture<GridCacheTxEx<K,V>>	prepareAsync() Prepare stage.
Collection<GridCacheTxEntry<K,V>>	readEntries()
Map<K,GridCacheTxEntry<K,V>>	readMap()
Set<K>	readSet()
long	remoteThreadId()
boolean	removed(K key) Checks whether given key has been removed within transaction.
void	rollback() Rolls back this transaction.
GridFuture<GridCacheTx>	rollbackAsync() TODO-gg-4004 Put rollback async on public API? Asynchronously rollback this transaction.
void	seal() Seals transaction for updates.
boolean	setWriteValue(GridCacheTxEntry<K,V> e)
String	toString()
Collection<GridCacheTxEntry<K,V>>	writeEntries()
Map<K,GridCacheTxEntry<K,V>>	writeMap()
Set<K>	writeSet()

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

addInvalidPartition, applyTransformClosures, awaitCompletion, awaitSignal, awaitSignal, checkInternal, close, colocated, commitVersion, commitVersion, completedVersions, concurrency, dht, done, drResolveConflict, endTime, endVersion, endVersion, enforceSerializable, equals, evictNearEntry, finalizationStatus, finishFuture, groupLock, groupLockEntry, groupLockKey, hashCode, implicit, implicitSingle, initCommitVersion, internal, invalidPartitions, isInvalidate, isNearLocallyMapped, isolation, isRollbackOnly, isSystemInvalidate, local, lock, lockTimeout, log, markFinalizing, markPreparing, near, nearXidVersion, needsCompletedVersions, nodeId, onePhaseCommit, onePhaseCommit, onTimeout, optimistic, optimisticLockEntries, otherNodeId, ownedVersion, ownsLock, ownsLockUnsafe, pessimistic, readCommitted, readExternal, readResolve, recoveryWrites, recoveryWrites, remainingTime, repeatableRead, replicated, serializable, setRollbackOnly, signalAll, size, startTime, startVersion, state, state, subjectId, syncCommit, syncRollback, systemInvalidate, threadId, timedOut, timeout, timeout, timeoutId, topologyVersion, topologyVersion, transactionNodes, unlock, updateNearCache, user, writeExternal, writeVersion, writeVersion, xid, xidVersion

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

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.gridgain.grid.kernal.processors.cache.GridCacheTxEx

addInvalidPartition, colocated, commitVersion, commitVersion, completedVersions, dht, done, endVersion, endVersion, enforceSerializable, finishFuture, groupLock, groupLockKey, implicitSingle, internal, invalidPartitions, isSystemInvalidate, local, markFinalizing, markPreparing, near, nearXidVersion, needsCompletedVersions, onePhaseCommit, optimistic, optimisticLockEntries, otherNodeId, ownedVersion, ownsLock, ownsLockUnsafe, pessimistic, readCommitted, recoveryWrites, remainingTime, repeatableRead, replicated, serializable, size, startVersion, state, subjectId, syncCommit, syncRollback, systemInvalidate, timedOut, topologyVersion, topologyVersion, transactionNodes, user, writeVersion, writeVersion, xidVersion

Methods inherited from interface org.gridgain.grid.cache.GridCacheTx

close, concurrency, implicit, isInvalidate, isolation, isRollbackOnly, nodeId, setRollbackOnly, startTime, state, threadId, timeout, timeout, xid

Methods inherited from interface org.gridgain.grid.GridMetadataAware

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

Methods inherited from interface org.gridgain.grid.kernal.processors.timeout.GridTimeoutObject

endTime, onTimeout, timeoutId

Field Detail

readMap

@GridToStringInclude
protected Map<K,GridCacheTxEntry<K,V>> readMap

Read set.

writeMap

@GridToStringInclude
protected Map<K,GridCacheTxEntry<K,V>> writeMap

Write map.

Constructor Detail

GridDistributedTxRemoteAdapter

public GridDistributedTxRemoteAdapter()

Empty constructor required for Externalizable.

GridDistributedTxRemoteAdapter

public GridDistributedTxRemoteAdapter(GridCacheContext<K,V> ctx,
                              UUID nodeId,
                              long rmtThreadId,
                              GridCacheVersion xidVer,
                              GridCacheVersion commitVer,
                              GridCacheTxConcurrency concurrency,
                              GridCacheTxIsolation isolation,
                              boolean invalidate,
                              long timeout,
                              int txSize,
                              @Nullable
                              Object grpLockKey,
                              @Nullable
                              UUID subjId)

Parameters:

ctx - Cache registry.

nodeId - Node ID.

rmtThreadId - Remote thread ID.

xidVer - XID version.

commitVer - Commit version.

concurrency - Concurrency level (should be pessimistic).

isolation - Transaction isolation.

invalidate - Invalidate flag.

timeout - Timeout.

txSize - Expected transaction size.

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

Method Detail

eventNodeId

public UUID eventNodeId()

Specified by:

eventNodeId in interface GridCacheTxEx<K,V>

Returns:

Event node ID.

masterNodeIds

public Collection<UUID> masterNodeIds()

Specified by:

masterNodeIds in interface GridCacheTxEx<K,V>

Returns:

Master node IDs.

originatingNodeId

public UUID originatingNodeId()

Gets node ID which directly started this transaction. In case of DHT local transaction it will be near node ID, in case of DHT remote transaction it will be primary node ID, in case of replicated remote transaction it will be starter node ID.

Specified by:

originatingNodeId in interface GridCacheTxEx<K,V>

Returns:

Originating node ID.

empty

public boolean empty()

Specified by:

empty in interface GridCacheTxEx<K,V>

Returns:

Checks if transaction has no entries.

removed

public boolean removed(K key)

Checks whether given key has been removed within transaction.

Specified by:

removed in interface GridCacheTxEx<K,V>

Parameters:

key - Key to check.

Returns:

True if key has been removed.

invalidate

public void invalidate(boolean invalidate)

Specified by:

invalidate in interface GridCacheTxEx<K,V>

Overrides:

invalidate in class GridCacheTxAdapter<K,V>

Parameters:

invalidate - Invalidate flag.

writeMap

public Map<K,GridCacheTxEntry<K,V>> writeMap()

Specified by:

writeMap in interface GridCacheTxEx<K,V>

Returns:

Transaction write map.

readMap

public Map<K,GridCacheTxEntry<K,V>> readMap()

Specified by:

readMap in interface GridCacheTxEx<K,V>

Returns:

Transaction read map.

seal

public void seal()

Seals transaction for updates.

Specified by:

seal in interface GridCacheTxEx<K,V>

groupLockKey

public void groupLockKey(Object key)

Adds group lock key to remote transaction.

Parameters:

key - Key.

peek

public GridTuple<V> peek(boolean failFast,
                K key,
                GridPredicate<GridCacheEntry<K,V>>[] filter)
                  throws GridCacheFilterFailedException

Specified by:

peek in interface GridCacheTxEx<K,V>

Parameters:

failFast - Fail-fast flag.

key - Key to look up.

filter - Filter to check.

Returns:

Current value for the key within transaction.

Throws:

GridCacheFilterFailedException - If filter failed and failFast is true.

entry

public GridCacheTxEntry<K,V> entry(K key)

Specified by:

entry in interface GridCacheTxEx<K,V>

Parameters:

key - Key for the entry.

Returns:

Entry for the key (either from write set or read set).

clearEntry

public void clearEntry(K key)

Clears entry from transaction as it never happened.

Parameters:

key - key to be removed.

addRemoteCandidates

public void addRemoteCandidates(Map<K,Collection<GridCacheMvccCandidate<K>>> cands,
                       Collection<GridCacheVersion> committedVers,
                       Collection<GridCacheVersion> rolledbackVers)

Adds remote candidates and completed versions to all involved entries.

Specified by:

addRemoteCandidates in interface GridCacheTxRemoteEx<K,V>

Parameters:

cands - Candidates.

committedVers - Committed versions.

rolledbackVers - Rolled back versions.

doneRemote

public void doneRemote(GridCacheVersion baseVer,
              Collection<GridCacheVersion> committedVers,
              Collection<GridCacheVersion> rolledbackVers,
              Collection<GridCacheVersion> pendingVers)

Specified by:

doneRemote in interface GridCacheTxRemoteEx<K,V>

Parameters:

baseVer - Base version.

committedVers - Committed versions.

rolledbackVers - Rolled back versions.

pendingVers - Pending versions.

onOwnerChanged

public boolean onOwnerChanged(GridCacheEntryEx<K,V> entry,
                     GridCacheMvccCandidate<K> owner)

Callback invoked whenever there is a lock that has been acquired by this transaction for any of the participating entries.

Specified by:

onOwnerChanged in interface GridCacheTxEx<K,V>

Parameters:

entry - Cache entry.

owner - Lock candidate that won ownership of the lock.

Returns:

True if transaction cared about notification.

isStarted

public boolean isStarted()

Specified by:

isStarted in class GridCacheTxAdapter<K,V>

Returns:

True if transaction has at least one key enlisted.

remoteThreadId

public long remoteThreadId()

Specified by:

remoteThreadId in interface GridCacheTxRemoteEx<K,V>

Returns:

Remote node thread ID.

addRead

public void addRead(K key,
           byte[] keyBytes,
           @Nullable
           GridCacheVersion drVer)

Parameters:

key - Key to add to read set.

keyBytes - Key bytes.

drVer - Data center replication version.

addWrite

public void addWrite(K key,
            byte[] keyBytes,
            GridCacheOperation op,
            V val,
            byte[] valBytes,
            @Nullable
            GridCacheVersion drVer)

Parameters:

key - Key to add to write set.

keyBytes - Key bytes.

op - Cache operation.

val - Write value.

valBytes - Write value bytes.

drVer - Data center replication version.

setWriteValue

public boolean setWriteValue(GridCacheTxEntry<K,V> e)

Specified by:

setWriteValue in interface GridCacheTxRemoteEx<K,V>

Parameters:

e - Transaction entry to set.

Returns:

True if value was set.

hasReadKey

public boolean hasReadKey(K key)

Specified by:

hasReadKey in interface GridCacheTxEx<K,V>

Parameters:

key - Key to check.

Returns:

True if key is present.

hasWriteKey

public boolean hasWriteKey(K key)

Specified by:

hasWriteKey in interface GridCacheTxEx<K,V>

Parameters:

key - Key to check.

Returns:

True if key is present.

prepareAsync

public GridFuture<GridCacheTxEx<K,V>> prepareAsync()

Prepare stage.

Specified by:

prepareAsync in interface GridCacheTxEx<K,V>

Returns:

Future for prepare step.

readSet

public Set<K> readSet()

Specified by:

readSet in interface GridCacheTxEx<K,V>

Returns:

Read set.

writeSet

public Set<K> writeSet()

Specified by:

writeSet in interface GridCacheTxEx<K,V>

Returns:

Write set.

allEntries

public Collection<GridCacheTxEntry<K,V>> allEntries()

Specified by:

allEntries in interface GridCacheTxEx<K,V>

Returns:

All transaction entries.

writeEntries

public Collection<GridCacheTxEntry<K,V>> writeEntries()

Specified by:

writeEntries in interface GridCacheTxEx<K,V>

Returns:

Write entries.

readEntries

public Collection<GridCacheTxEntry<K,V>> readEntries()

Specified by:

readEntries in interface GridCacheTxEx<K,V>

Returns:

Read entries.

prepare

public void prepare()
             throws GridException

Prepare phase.

Specified by:

prepare in interface GridCacheTxEx<K,V>

Throws:

GridException - If prepare failed.

commit

public void commit()
            throws GridException

Commits this transaction by initiating two-phase-commit process.

Specified by:

commit in interface GridCacheTx

Throws:

GridException - If commit failed.

forceCommit

public void forceCommit()
                 throws GridException

Forces commit for this tx.

Throws:

GridException - If commit failed.

commitAsync

public GridFuture<GridCacheTx> commitAsync()

Asynchronously commits this transaction by initiating two-phase-commit process.

Specified by:

commitAsync in interface GridCacheTx

Returns:

Future for commit operation.

rollback

public void rollback()

Rolls back this transaction.

Specified by:

rollback in interface GridCacheTx

rollbackAsync

public GridFuture<GridCacheTx> rollbackAsync()

TODO-gg-4004 Put rollback async on public API? Asynchronously rollback this transaction.

Specified by:

rollbackAsync in interface GridCacheTxEx<K,V>

Returns:

Rollback future.

addLocalCandidates

public void addLocalCandidates(K key,
                      Collection<GridCacheMvccCandidate<K>> cands)

Specified by:

addLocalCandidates in interface GridCacheTxEx<K,V>

Parameters:

key - Cache key.

cands - Collection of lock candidates for that key.

localCandidates

public Map<K,Collection<GridCacheMvccCandidate<K>>> localCandidates()

Specified by:

localCandidates in interface GridCacheTxEx<K,V>

Returns:

All lock candidates.

alternateVersions

public Collection<GridCacheVersion> alternateVersions()

Specified by:

alternateVersions in interface GridCacheTxEx<K,V>

Returns:

Alternate transaction versions.

addExplicit

protected void addExplicit(GridCacheTxEntry<K,V> e)

Adds explicit version if there is one.

Parameters:

e - Transaction entry.

toString

public String toString()

Overrides:

toString in class GridCacheTxAdapter<K,V>