org.infinispan.transaction.impl

Class AbstractCacheTransaction

java.lang.Object

org.infinispan.transaction.impl.AbstractCacheTransaction

All Implemented Interfaces:

CacheTransaction

Direct Known Subclasses:

LocalTransaction, RemoteTransaction

public abstract class AbstractCacheTransaction
extends Object
implements CacheTransaction

Base class for local and remote transaction. Impl note: The aggregated modification list and lookedUpEntries are not instantiated here but in subclasses. This is done in order to take advantage of the fact that, for remote transactions we already know the size of the modifications list at creation time.

Since:

4.2

Author:

Mircea.Markus@jboss.com, Galder Zamarreño

Nested Class Summary

Nested classes/interfaces inherited from interface org.infinispan.transaction.xa.CacheTransaction

CacheTransaction.TransactionCompletedListener

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<Object>	affectedKeys Holds all the locked keys that were acquired by the transaction allover the cluster.
protected boolean	hasLocalOnlyModifications
protected Equivalence<Object>	keyEquivalence Equivalence function to compare keys that are stored in temporary collections used in the cache transaction to keep track of locked keys, looked up keys...etc.
protected Map<Object,CacheEntry>	lookedUpEntries
protected List<WriteCommand>	modifications
protected int	topologyId
protected GlobalTransaction	tx

Constructor Summary

Constructors

Constructor and Description
AbstractCacheTransaction(GlobalTransaction tx, int topologyId, Equivalence<Object> keyEquivalence, long txCreationTime)

Method Summary

Modifier and Type	Method and Description
void	addAffectedKey(Object key)
void	addAllAffectedKeys(Collection<?> keys)
void	addBackupLockForKey(Object key)
void	addListener(CacheTransaction.TransactionCompletedListener listener)
void	addReadKey(Object key)
void	addVersionRead(Object key, EntryVersion version) Sets the version read for this key.
boolean	areLocksReleased()
void	cleanupBackupLocks() It cleans up the backup locks for this transaction.
void	clearLockedKeys()
void	clearLookedUpEntries()
boolean	containsLockOrBackupLock(Object key)
Object	findAnyLockedOrBackupLocked(Collection<Object> keys)
void	freezeModifications() Prevent new modifications after prepare or commit started.
Set<Object>	getAffectedKeys()
List<WriteCommand>	getAllModifications() Returns all the modifications visible within the current transaction, including those using Flag#CACHE_MODE_LOCAL.
Set<Object>	getBackupLockedKeys()
long	getCreationTime()
GlobalTransaction	getGlobalTransaction() Returns the transaction identifier.
Set<Object>	getLockedKeys()
Map<Object,CacheEntry>	getLookedUpEntries()
EntryVersion	getLookedUpRemoteVersion(Object key)
List<WriteCommand>	getModifications() Returns the modifications visible within the current transaction.
CompletableFuture<Void>	getReleaseFutureForKey(Object key) It returns a CompletableFuture that completes when the lock for the key is released.
KeyValuePair<Object,CompletableFuture<Void>>	getReleaseFutureForKeys(Collection<Object> keys) Same as CacheTransaction.getReleaseFutureForKey(Object) but it returns a pair with the key and the future.
Flag	getStateTransferFlag()
int	getTopologyId()
EntryVersionsMap	getUpdatedEntryVersions()
EntryVersionsMap	getVersionsRead() Note: used in Repeatable Read + Write Skew + Clustering + Versioning.
boolean	hasModification(Class<?> modificationClass) Checks if a modification of the given class (or subclass) is present in this transaction.
protected void	internalSetStateTransferFlag(Flag stateTransferFlag)
boolean	isFromStateTransfer()
boolean	isMarkedForRollback()
boolean	keyRead(Object key)
CacheEntry	lookupEntry(Object key)
void	markForRollback(boolean markForRollback)
void	notifyOnTransactionFinished()
boolean	ownsLock(Object key)
void	putLookedUpRemoteVersion(Object key, EntryVersion version)
void	registerLockedKey(Object key)
void	removeLookedUpEntry(Object key)
void	replaceVersionRead(Object key, EntryVersion version) Sets the version read fr this key, replacing the old version if it exists, i.e each invocation updates the version of the key.
void	setModifications(List<WriteCommand> modifications)
abstract void	setStateTransferFlag(Flag stateTransferFlag)
void	setUpdatedEntryVersions(EntryVersionsMap updatedEntryVersions)
boolean	waitForLockRelease(long lockAcquisitionTimeout) Checks if this transaction holds a lock on the given key and then waits until the transaction completes or until the timeout expires and returns true if the transaction is complete or false otherwise.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.transaction.xa.CacheTransaction

putLookedUpEntries, putLookedUpEntry

Field Detail

tx

protected final GlobalTransaction tx

hasLocalOnlyModifications

protected volatile boolean hasLocalOnlyModifications

modifications

protected volatile List<WriteCommand> modifications

lookedUpEntries

protected Map<Object,CacheEntry> lookedUpEntries

affectedKeys

protected Set<Object> affectedKeys

Holds all the locked keys that were acquired by the transaction allover the cluster.

topologyId

protected final int topologyId

keyEquivalence

protected final Equivalence<Object> keyEquivalence

Equivalence function to compare keys that are stored in temporary collections used in the cache transaction to keep track of locked keys, looked up keys...etc.

Constructor Detail

AbstractCacheTransaction

public AbstractCacheTransaction(GlobalTransaction tx,
                                int topologyId,
                                Equivalence<Object> keyEquivalence,
                                long txCreationTime)

Method Detail

isMarkedForRollback

public final boolean isMarkedForRollback()

Specified by:

isMarkedForRollback in interface CacheTransaction

markForRollback

public void markForRollback(boolean markForRollback)

Specified by:

markForRollback in interface CacheTransaction

getGlobalTransaction

public GlobalTransaction getGlobalTransaction()

Description copied from interface: CacheTransaction

Returns the transaction identifier.

Specified by:

getGlobalTransaction in interface CacheTransaction

getModifications

public final List<WriteCommand> getModifications()

Description copied from interface: CacheTransaction

Returns the modifications visible within the current transaction. Any modifications using Flag#CACHE_MODE_LOCAL are excluded. The returned list is never null.

Specified by:

getModifications in interface CacheTransaction

getAllModifications

public final List<WriteCommand> getAllModifications()

Description copied from interface: CacheTransaction

Returns all the modifications visible within the current transaction, including those using Flag#CACHE_MODE_LOCAL. The returned list is never null.

Specified by:

getAllModifications in interface CacheTransaction

setModifications

public final void setModifications(List<WriteCommand> modifications)

hasModification

public final boolean hasModification(Class<?> modificationClass)

Description copied from interface: CacheTransaction

Checks if a modification of the given class (or subclass) is present in this transaction. Any modifications using Flag#CACHE_MODE_LOCAL are ignored.

Specified by:

hasModification in interface CacheTransaction

Parameters:

modificationClass - the modification type to look for

Returns:

true if found, false otherwise

freezeModifications

public void freezeModifications()

Description copied from interface: CacheTransaction

Prevent new modifications after prepare or commit started.

Specified by:

freezeModifications in interface CacheTransaction

getLookedUpEntries

public Map<Object,CacheEntry> getLookedUpEntries()

Specified by:

getLookedUpEntries in interface CacheTransaction

lookupEntry

public CacheEntry lookupEntry(Object key)

Specified by:

lookupEntry in interface CacheTransaction

removeLookedUpEntry

public void removeLookedUpEntry(Object key)

Specified by:

removeLookedUpEntry in interface CacheTransaction

clearLookedUpEntries

public void clearLookedUpEntries()

Specified by:

clearLookedUpEntries in interface CacheTransaction

ownsLock

public boolean ownsLock(Object key)

Specified by:

ownsLock in interface CacheTransaction

notifyOnTransactionFinished

public void notifyOnTransactionFinished()

Specified by:

notifyOnTransactionFinished in interface CacheTransaction

See Also:

AbstractTxLockingInterceptor.checkPendingAndLockKey(InvocationContext, Object, long)

waitForLockRelease

public final boolean waitForLockRelease(long lockAcquisitionTimeout)
                                 throws InterruptedException

Description copied from interface: CacheTransaction

Checks if this transaction holds a lock on the given key and then waits until the transaction completes or until the timeout expires and returns true if the transaction is complete or false otherwise. If the key is not locked or if the transaction is already completed it returns true immediately.

This method is subject to spurious returns in a way similar to Object.wait(). It can sometimes return before the specified time has elapsed and without guaranteeing that this transaction is complete. The caller is responsible to call the method again if transaction completion was not reached and the time budget was not spent.

Specified by:

waitForLockRelease in interface CacheTransaction

Throws:

InterruptedException

See Also:

AbstractTxLockingInterceptor.checkPendingAndLockKey(InvocationContext, Object, long)

getTopologyId

public int getTopologyId()

Specified by:

getTopologyId in interface CacheTransaction

addBackupLockForKey

public void addBackupLockForKey(Object key)

Specified by:

addBackupLockForKey in interface CacheTransaction

registerLockedKey

public void registerLockedKey(Object key)

getLockedKeys

public Set<Object> getLockedKeys()

Specified by:

getLockedKeys in interface CacheTransaction

getBackupLockedKeys

public Set<Object> getBackupLockedKeys()

Specified by:

getBackupLockedKeys in interface CacheTransaction

clearLockedKeys

public void clearLockedKeys()

Specified by:

clearLockedKeys in interface CacheTransaction

containsLockOrBackupLock

public boolean containsLockOrBackupLock(Object key)

Specified by:

containsLockOrBackupLock in interface CacheTransaction

findAnyLockedOrBackupLocked

public Object findAnyLockedOrBackupLocked(Collection<Object> keys)

Specified by:

findAnyLockedOrBackupLocked in interface CacheTransaction

areLocksReleased

public boolean areLocksReleased()

Specified by:

areLocksReleased in interface CacheTransaction

getAffectedKeys

public Set<Object> getAffectedKeys()

addAffectedKey

public void addAffectedKey(Object key)

addAllAffectedKeys

public void addAllAffectedKeys(Collection<?> keys)

getUpdatedEntryVersions

public EntryVersionsMap getUpdatedEntryVersions()

Specified by:

getUpdatedEntryVersions in interface CacheTransaction

setUpdatedEntryVersions

public void setUpdatedEntryVersions(EntryVersionsMap updatedEntryVersions)

Specified by:

setUpdatedEntryVersions in interface CacheTransaction

getLookedUpRemoteVersion

public EntryVersion getLookedUpRemoteVersion(Object key)

Specified by:

getLookedUpRemoteVersion in interface CacheTransaction

putLookedUpRemoteVersion

public void putLookedUpRemoteVersion(Object key,
                                     EntryVersion version)

Specified by:

putLookedUpRemoteVersion in interface CacheTransaction

addReadKey

public void addReadKey(Object key)

Specified by:

addReadKey in interface CacheTransaction

keyRead

public boolean keyRead(Object key)

Specified by:

keyRead in interface CacheTransaction

addVersionRead

public void addVersionRead(Object key,
                           EntryVersion version)

Description copied from interface: CacheTransaction

Sets the version read for this key. The version is only set at the first time, i.e. multiple invocation of this method will not change the state.

Note: used in Repeatable Read + Write Skew + Clustering + Versioning.

Specified by:

addVersionRead in interface CacheTransaction

replaceVersionRead

public void replaceVersionRead(Object key,
                               EntryVersion version)

Description copied from interface: CacheTransaction

Sets the version read fr this key, replacing the old version if it exists, i.e each invocation updates the version of the key. This method is used when a remote get is performed for the key.

Note: used in Repeatable Read + Write Skew + Clustering + Versioning.

Specified by:

replaceVersionRead in interface CacheTransaction

getVersionsRead

public EntryVersionsMap getVersionsRead()

Description copied from interface: CacheTransaction

Note: used in Repeatable Read + Write Skew + Clustering + Versioning.

Specified by:

getVersionsRead in interface CacheTransaction

Returns:

a non-null map between key and version. The map represents the version read for that key. If no version exists, the key has not been read.

isFromStateTransfer

public final boolean isFromStateTransfer()

getStateTransferFlag

public final Flag getStateTransferFlag()

setStateTransferFlag

public abstract void setStateTransferFlag(Flag stateTransferFlag)

internalSetStateTransferFlag

protected final void internalSetStateTransferFlag(Flag stateTransferFlag)

getCreationTime

public long getCreationTime()

Specified by:

getCreationTime in interface CacheTransaction

addListener

public final void addListener(CacheTransaction.TransactionCompletedListener listener)

Specified by:

addListener in interface CacheTransaction

getReleaseFutureForKey

public CompletableFuture<Void> getReleaseFutureForKey(Object key)

Description copied from interface: CacheTransaction

It returns a CompletableFuture that completes when the lock for the key is released. If the key is not locked by this transaction, it returns null.

Specified by:

getReleaseFutureForKey in interface CacheTransaction

Parameters:

key - the key.

Returns:

the CompletableFuture or null if the key is not locked by this transaction.

getReleaseFutureForKeys

public KeyValuePair<Object,CompletableFuture<Void>> getReleaseFutureForKeys(Collection<Object> keys)

Description copied from interface: CacheTransaction

Same as CacheTransaction.getReleaseFutureForKey(Object) but it returns a pair with the key and the future.

Specified by:

getReleaseFutureForKeys in interface CacheTransaction

cleanupBackupLocks

public void cleanupBackupLocks()

Description copied from interface: CacheTransaction

It cleans up the backup locks for this transaction.

Specified by:

cleanupBackupLocks in interface CacheTransaction