org.onosproject.store.primitives.impl

Class DefaultTransactionalMap<K,V>

java.lang.Object

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

Type Parameters:

K - key type

V - value type.

All Implemented Interfaces:

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

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

Default Transactional Map implementation that provides a repeatable reads transaction isolation level.

Constructor Summary

Constructors

Constructor and Description
DefaultTransactionalMap(String name, org.onosproject.store.service.AsyncConsistentMap<K,V> backingMap, org.onosproject.store.service.TransactionContext txContext, org.onosproject.store.service.Serializer serializer)

Method Summary

Modifier and Type	Method and Description
protected void	abort() Discards all changes made to this transactional map.
CompletableFuture<Void>	commit() Attempts to execute the commit phase for previously prepared transaction.
boolean	containsKey(K key)
protected K	dK(String key)
V	get(K key)
boolean	hasPendingUpdates() Returns if this participant has updates that need to be committed.
CompletableFuture<Boolean>	prepare() Executes the prepare phase.
CompletableFuture<Boolean>	prepareAndCommit() Executes the prepare and commit steps in a single go.
V	put(K key, V value)
V	putIfAbsent(K key, V value)
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.
protected List<org.onosproject.store.primitives.MapUpdate<String,byte[]>>	toMapUpdates()
String	toString()
int	totalUpdates() Returns the number of updates that need to committed for this participant.
protected List<org.onosproject.store.primitives.MapUpdate<K,V>>	updates()
protected Stream<org.onosproject.store.primitives.MapUpdate<K,V>>	updatesStream()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultTransactionalMap

public DefaultTransactionalMap(String name,
                               org.onosproject.store.service.AsyncConsistentMap<K,V> backingMap,
                               org.onosproject.store.service.TransactionContext txContext,
                               org.onosproject.store.service.Serializer serializer)

Method Detail

dK

protected K dK(String key)

get

public V get(K key)

Specified by:

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

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

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

prepareAndCommit

public CompletableFuture<Boolean> prepareAndCommit()

Description copied from interface: TransactionParticipant

Executes the prepare and commit steps in a single go.

Specified by:

prepareAndCommit in interface TransactionParticipant

Returns:

true is successful i.e updates are committed; false otherwise

totalUpdates

public int totalUpdates()

Description copied from interface: TransactionParticipant

Returns the number of updates that need to committed for this participant.

Specified by:

totalUpdates in interface TransactionParticipant

Returns:

update count.

hasPendingUpdates

public boolean hasPendingUpdates()

Description copied from interface: TransactionParticipant

Returns if this participant has updates that need to be committed.

Specified by:

hasPendingUpdates in interface TransactionParticipant

Returns:

true if yes; false otherwise

updatesStream

protected Stream<org.onosproject.store.primitives.MapUpdate<K,V>> updatesStream()

updates

protected List<org.onosproject.store.primitives.MapUpdate<K,V>> updates()

toMapUpdates

protected List<org.onosproject.store.primitives.MapUpdate<String,byte[]>> toMapUpdates()

toString

public String toString()

Overrides:

toString in class Object

abort

protected void abort()

Discards all changes made to this transactional map.