CacheTransaction (Red Hat JBoss Enterprise Application Platform 7.4.0.GA public API)

All Known Subinterfaces:

RecoveryAwareTransaction

All Known Implementing Classes:

AbstractCacheTransaction, LocalTransaction, LocalXaTransaction, RecoveryAwareLocalTransaction, RecoveryAwareRemoteTransaction, RemoteTransaction, SyncLocalTransaction
```
public interface CacheTransaction
```
Defines the state a infinispan transaction should have.

Since:

4.0

Author:

Mircea.Markus@jboss.com

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface CacheTransaction.TransactionCompletedListener

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`CacheTransaction.TransactionCompletedListener`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addBackupLockForKey(Object key)`
`void`	`addListener(CacheTransaction.TransactionCompletedListener listener)`
`void`	`addVersionRead(Object key, EntryVersion version)` Sets the version read for this key.
`void`	`cleanupBackupLocks()` It cleans up the backup locks for this transaction.
`void`	`clearLockedKeys()`
`void`	`clearLookedUpEntries()`
`void`	`forEachBackupLock(Consumer<Object> consumer)` Invokes the `Consumer` with each backup lock.
`void`	`forEachLock(Consumer<Object> consumer)` Invokes the `Consumer` with each lock.
`void`	`freezeModifications()` Prevent new modifications after prepare or commit started.
`List<WriteCommand>`	`getAllModifications()` Returns all the modifications visible within the current transaction, including those using Flag#CACHE_MODE_LOCAL.
`long`	`getCreationTime()`
`GlobalTransaction`	`getGlobalTransaction()` Returns the transaction identifier.
`Set<Object>`	`getLockedKeys()`
`Map<Object,CacheEntry>`	`getLookedUpEntries()`
`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.
`Map<Object,CompletableFuture<Void>>`	`getReleaseFutureForKeys(Collection<Object> keys)` Same as `getReleaseFutureForKey(Object)` but it returns a pair with the key and the future.
`int`	`getTopologyId()`
`Map<Object,IncrementableEntryVersion>`	`getUpdatedEntryVersions()`
`Map<Object,IncrementableEntryVersion>`	`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.
`boolean`	`isMarkedForRollback()`
`CacheEntry`	`lookupEntry(Object key)`
`void`	`markForRollback(boolean markForRollback)`
`void`	`notifyOnTransactionFinished()`
`boolean`	`ownsLock(Object key)`
`void`	`putLookedUpEntries(Map<Object,CacheEntry> entries)`
`void`	`putLookedUpEntry(Object key, CacheEntry e)`
`void`	`removeBackupLock(Object key)` It cleans up the backup for `key`.
`void`	`removeBackupLocks(Collection<?> keys)` It cleans up the backup lock for the `keys`.
`void`	`removeLookedUpEntry(Object key)`
`void`	`setUpdatedEntryVersions(Map<Object,IncrementableEntryVersion> updatedEntryVersions)`

- Method Detail
  - getGlobalTransaction
```
GlobalTransaction getGlobalTransaction()
```
    Returns the transaction identifier.
  - getModifications
```
List<WriteCommand> getModifications()
```
    Returns the modifications visible within the current transaction. Any modifications using Flag#CACHE_MODE_LOCAL are excluded. The returned list is never null.
  - getAllModifications
```
List<WriteCommand> getAllModifications()
```
    Returns all the modifications visible within the current transaction, including those using Flag#CACHE_MODE_LOCAL. The returned list is never null.
  - hasModification
```
boolean hasModification(Class<?> modificationClass)
```
    Checks if a modification of the given class (or subclass) is present in this transaction. Any modifications using Flag#CACHE_MODE_LOCAL are ignored.
    
    Parameters:
    
    modificationClass - the modification type to look for
    
    Returns:
    
    true if found, false otherwise
  - lookupEntry
```
CacheEntry lookupEntry(Object key)
```
  - getLookedUpEntries
```
Map<Object,CacheEntry> getLookedUpEntries()
```
  - putLookedUpEntry
```
void putLookedUpEntry(Object key,
                      CacheEntry e)
```
  - putLookedUpEntries
```
void putLookedUpEntries(Map<Object,CacheEntry> entries)
```
  - removeLookedUpEntry
```
void removeLookedUpEntry(Object key)
```
  - clearLookedUpEntries
```
void clearLookedUpEntries()
```
  - ownsLock
```
boolean ownsLock(Object key)
```
  - clearLockedKeys
```
void clearLockedKeys()
```
  - getLockedKeys
```
Set<Object> getLockedKeys()
```
  - getTopologyId
```
int getTopologyId()
```
  - addBackupLockForKey
```
void addBackupLockForKey(Object key)
```
  - notifyOnTransactionFinished
```
void notifyOnTransactionFinished()
```
    See Also:
    
    AbstractTxLockingInterceptor.checkPendingAndLockKey(TxInvocationContext, VisitableCommand, Object, long)
  - getUpdatedEntryVersions
```
Map<Object,IncrementableEntryVersion> getUpdatedEntryVersions()
```
  - setUpdatedEntryVersions
```
void setUpdatedEntryVersions(Map<Object,IncrementableEntryVersion> updatedEntryVersions)
```
  - isMarkedForRollback
```
boolean isMarkedForRollback()
```
  - markForRollback
```
void markForRollback(boolean markForRollback)
```
  - addVersionRead
```
void addVersionRead(Object key,
                    EntryVersion version)
```
    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.
  - getVersionsRead
```
Map<Object,IncrementableEntryVersion> getVersionsRead()
```
    Note: used in Repeatable Read + Write Skew + Clustering + Versioning.
    
    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.
  - getCreationTime
```
long getCreationTime()
```
  - addListener
```
void addListener(CacheTransaction.TransactionCompletedListener listener)
```
  - freezeModifications
```
void freezeModifications()
```
    Prevent new modifications after prepare or commit started.
  - getReleaseFutureForKey
```
CompletableFuture<Void> getReleaseFutureForKey(Object key)
```
    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.
    
    Parameters:
    
    key - the key.
    
    Returns:
    
    the CompletableFuture or null if the key is not locked by this transaction.
  - getReleaseFutureForKeys
```
Map<Object,CompletableFuture<Void>> getReleaseFutureForKeys(Collection<Object> keys)
```
    Same as getReleaseFutureForKey(Object) but it returns a pair with the key and the future.
  - cleanupBackupLocks
```
void cleanupBackupLocks()
```
    It cleans up the backup locks for this transaction.
  - removeBackupLocks
```
void removeBackupLocks(Collection<?> keys)
```
    It cleans up the backup lock for the keys.
    
    Parameters:
    
    keys - The keys to clean up the backup lock.
  - removeBackupLock
```
void removeBackupLock(Object key)
```
    It cleans up the backup for key.
    
    Parameters:
    
    key - The key to clean up the backup lock.
  - forEachLock
```
void forEachLock(Consumer<Object> consumer)
```
    Invokes the Consumer with each lock.
    
    Parameters:
    
    consumer - The backup lock Consumer
  - forEachBackupLock
```
void forEachBackupLock(Consumer<Object> consumer)
```
    Invokes the Consumer with each backup lock.
    
    Parameters:
    
    consumer - The backup lock Consumer

Interface CacheTransaction

Nested Class Summary

Method Summary

Method Detail

getGlobalTransaction

getModifications

getAllModifications

hasModification

lookupEntry

getLookedUpEntries

putLookedUpEntry

putLookedUpEntries

removeLookedUpEntry

clearLookedUpEntries

ownsLock

clearLockedKeys

getLockedKeys

getTopologyId

addBackupLockForKey

notifyOnTransactionFinished

getUpdatedEntryVersions

setUpdatedEntryVersions

isMarkedForRollback

markForRollback

addVersionRead

getVersionsRead

getCreationTime

addListener

freezeModifications

getReleaseFutureForKey

getReleaseFutureForKeys

cleanupBackupLocks

removeBackupLocks

removeBackupLock

forEachLock

forEachBackupLock