org.everit.transaction.map

Interface TransactionalMap<K,V>

Type Parameters:

K - Type of keys.

V - Type of values.

All Superinterfaces:

Map<K,V>

public interface TransactionalMap<K,V>
extends Map<K,V>

Map that allows transactional operations. The Map should replay all modifications during commiting the transaction. In case the implementations wraps another Map, the following rules should be applied on the replay mechanism:

• If Map.clear() was called within the transaction, the same method should be replayed in the beginning of the commit
• If Map.clear() was not called within the transaction, Map.remove(Object) functions should be replayed for all keys even if that key was not in the original Map when the Map.remove(Object) was called or a new entry was inserted with the same key later. In other words, if a key was removed then reinserted, the TransactionalMap implementation should replay the remove and the last put method on the wrapped Map. This can be important for invalidation caches where calling the remove function generates a synchronization between nodes in a cluster.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
void	commitTransaction() Commits the currently associated transaction.
Object	getAssociatedTransaction() Gives back the currently associated transaction.
void	resumeTransaction(Object transaction) Resumes a previously suspended transaction.
void	rollbackTransaction() Calls a rollback on the currently associated transaction.
void	startTransaction(Object transaction) Starts a new transaction on the TransactionalMap.
void	suspendTransaction() Suspends the currently associated transaction.

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

commitTransaction

void commitTransaction()

Commits the currently associated transaction.

Throws:

IllegalStateException - if no transaction is associated currently to the TransactionalMap.

getAssociatedTransaction

Object getAssociatedTransaction()

Gives back the currently associated transaction.

Returns:

The currently associated transaction or null if no transaction is associated at the moment.

resumeTransaction

void resumeTransaction(Object transaction)

Resumes a previously suspended transaction.

Parameters:

transaction - The previously suspended transaction.

Throws:

IllegalStateException - if the provided transaction is not in suspended state or there is another active associated transaction.

rollbackTransaction

void rollbackTransaction()

Calls a rollback on the currently associated transaction.

Throws:

IllegalStateException - if no transaction is associated currently to the TransactionalMap.

startTransaction

void startTransaction(Object transaction)

Starts a new transaction on the TransactionalMap.

Parameters:

transaction - The transaction that will be associated to the TransactionalMap.

Throws:

IllegalStateException - if the TransactionalMap is already associated to the provided transaction (either in suspended or active state) or other transaction is currently associated to the TransactionalMap in active state.

suspendTransaction

void suspendTransaction()

Suspends the currently associated transaction.

Throws:

IllegalStateException - if no transaction is associated currently to the TransactionalMap.