org.onosproject.store.primitives.impl

Class TransactionalMapParticipant<K,V>

java.lang.Object

org.onosproject.store.primitives.impl.TransactionalMapParticipant<K,V>

Type Parameters:

K - key type

V - value type.

All Implemented Interfaces:

TransactionParticipant, org.onosproject.store.service.TransactionalMap<K,V>

Direct Known Subclasses:

DefaultTransactionalMapParticipant

public abstract class TransactionalMapParticipant<K,V>
extends Object
implements org.onosproject.store.service.TransactionalMap<K,V>, TransactionParticipant

Base class for participants within a single TransactionalMap.

This class provides the basic functionality required by transactional map participants and provides methods for defining operations specific to individual isolation levels.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.onosproject.store.service.ConsistentMap<K,V>	backingMap
protected Set<K>	deleteSet
protected org.onosproject.store.service.Version	lock
protected Transaction<org.onosproject.store.primitives.MapUpdate<K,V>>	transaction
protected Map<K,V>	writeCache

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TransactionalMapParticipant(org.onosproject.store.service.ConsistentMap<K,V> backingMap, Transaction<org.onosproject.store.primitives.MapUpdate<K,V>> transaction)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	commit() Attempts to execute the commit phase for previously prepared transaction.
boolean	containsKey(K key)
V	get(K key)
protected List<org.onosproject.store.primitives.MapUpdate<K,V>>	log(org.onosproject.store.service.Version lockVersion) Returns a list of updates performed within this map partition.
CompletableFuture<Boolean>	prepare() Executes the prepare phase.
CompletableFuture<Boolean>	prepareAndCommit() Executes the prepare and commit phases atomically.
V	put(K key, V value)
V	putIfAbsent(K key, V value)
protected abstract V	read(K key) Executes a get operation based on the transaction isolation level.
protected abstract Stream<org.onosproject.store.primitives.MapUpdate<K,V>>	records(org.onosproject.store.service.Version lockVersion) Returns a stream of updates performed within this map partition.
V	remove(K key)
boolean	remove(K key, V value)
boolean	replace(K key, V oldValue, V newValue)
CompletableFuture<Void>	rollback() Attempts to execute the rollback phase for previously prepared transaction.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.store.primitives.impl.TransactionParticipant

hasPendingUpdates

Field Detail

backingMap

protected final org.onosproject.store.service.ConsistentMap<K,V> backingMap

transaction

protected final Transaction<org.onosproject.store.primitives.MapUpdate<K,V>> transaction

writeCache

protected final Map<K,V> writeCache

deleteSet

protected final Set<K> deleteSet

lock

protected volatile org.onosproject.store.service.Version lock

Constructor Detail

TransactionalMapParticipant

protected TransactionalMapParticipant(org.onosproject.store.service.ConsistentMap<K,V> backingMap,
                                      Transaction<org.onosproject.store.primitives.MapUpdate<K,V>> transaction)

Method Detail

get

public V get(K key)

Specified by:

get in interface org.onosproject.store.service.TransactionalMap<K,V>

read

protected abstract V read(K key)

Executes a get operation based on the transaction isolation level.

Parameters:

key - the key to look up

Returns:

the value

containsKey

public boolean containsKey(K key)

Specified by:

containsKey in interface org.onosproject.store.service.TransactionalMap<K,V>

put

public V put(K key,
             V value)

Specified by:

put in interface org.onosproject.store.service.TransactionalMap<K,V>

remove

public V remove(K key)

Specified by:

remove in interface org.onosproject.store.service.TransactionalMap<K,V>

remove

public boolean remove(K key,
                      V value)

Specified by:

remove in interface org.onosproject.store.service.TransactionalMap<K,V>

replace

public boolean replace(K key,
                       V oldValue,
                       V newValue)

Specified by:

replace in interface org.onosproject.store.service.TransactionalMap<K,V>

putIfAbsent

public V putIfAbsent(K key,
                     V value)

Specified by:

putIfAbsent in interface org.onosproject.store.service.TransactionalMap<K,V>

prepare

public CompletableFuture<Boolean> prepare()

Description copied from interface: TransactionParticipant

Executes the prepare phase.

Specified by:

prepare in interface TransactionParticipant

Returns:

true is successful; false otherwise

commit

public CompletableFuture<Void> commit()

Description copied from interface: TransactionParticipant

Attempts to execute the commit phase for previously prepared transaction.

Specified by:

commit in interface TransactionParticipant

Returns:

future that is completed when the operation completes

prepareAndCommit

public CompletableFuture<Boolean> prepareAndCommit()

Description copied from interface: TransactionParticipant

Executes the prepare and commit phases atomically.

Specified by:

prepareAndCommit in interface TransactionParticipant

Returns:

true is successful; false otherwise

rollback

public CompletableFuture<Void> rollback()

Description copied from interface: TransactionParticipant

Attempts to execute the rollback phase for previously prepared transaction.

Specified by:

rollback in interface TransactionParticipant

Returns:

future that is completed when the operation completes

log

protected List<org.onosproject.store.primitives.MapUpdate<K,V>> log(org.onosproject.store.service.Version lockVersion)

Returns a list of updates performed within this map partition.

Parameters:

lockVersion - the global transaction lock version

Returns:

a list of map updates

records

protected abstract Stream<org.onosproject.store.primitives.MapUpdate<K,V>> records(org.onosproject.store.service.Version lockVersion)

Returns a stream of updates performed within this map partition.

Parameters:

lockVersion - the global transaction lock version

Returns:

a stream of map updates

toString

public String toString()

Overrides:

toString in class Object