org.onosproject.store.primitives.impl

Class DefaultTransactionContext

java.lang.Object

org.onosproject.store.primitives.impl.DefaultTransactionContext

All Implemented Interfaces:

DistributedPrimitive, TransactionContext

public class DefaultTransactionContext
extends Object
implements TransactionContext

Default implementation of transaction context.

Nested Class Summary

Nested classes/interfaces inherited from interface org.onosproject.store.service.DistributedPrimitive

DistributedPrimitive.Status, DistributedPrimitive.Type

Field Summary

Fields inherited from interface org.onosproject.store.service.DistributedPrimitive

DEFAULT_OPERTATION_TIMEOUT_MILLIS

Constructor Summary

Constructors

Constructor and Description
DefaultTransactionContext(TransactionId transactionId, TransactionCoordinator transactionCoordinator)

Method Summary

Modifier and Type	Method and Description
void	abort() Aborts any changes made in this transaction context and discarding all locally cached updates.
void	begin() Starts a new transaction.
CompletableFuture<CommitStatus>	commit() Commits a transaction that was previously started thereby making its changes permanent and externally visible.
<K,V> TransactionalMap<K,V>	getTransactionalMap(String mapName, Serializer serializer) Returns a transactional map data structure with the specified name.
boolean	isOpen() Returns if this transaction context is open.
String	name() Returns the name of this primitive.
String	toString()
TransactionId	transactionId() Returns the transaction identifier.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.store.service.TransactionContext

primitiveType

Methods inherited from interface org.onosproject.store.service.DistributedPrimitive

addStatusChangeListener, applicationId, destroy, removeStatusChangeListener, statusChangeListeners

Constructor Detail

DefaultTransactionContext

public DefaultTransactionContext(TransactionId transactionId,
                                 TransactionCoordinator transactionCoordinator)

Method Detail

name

public String name()

Description copied from interface: DistributedPrimitive

Returns the name of this primitive.

Specified by:

name in interface DistributedPrimitive

Returns:

name

transactionId

public TransactionId transactionId()

Description copied from interface: TransactionContext

Returns the transaction identifier.

Specified by:

transactionId in interface TransactionContext

Returns:

transaction id

isOpen

public boolean isOpen()

Description copied from interface: TransactionContext

Returns if this transaction context is open.

Specified by:

isOpen in interface TransactionContext

Returns:

true if open, false otherwise

begin

public void begin()

Description copied from interface: TransactionContext

Starts a new transaction.

Specified by:

begin in interface TransactionContext

commit

public CompletableFuture<CommitStatus> commit()

Description copied from interface: TransactionContext

Commits a transaction that was previously started thereby making its changes permanent and externally visible.

Specified by:

commit in interface TransactionContext

Returns:

A future that will be completed when the operation completes

abort

public void abort()

Description copied from interface: TransactionContext

Aborts any changes made in this transaction context and discarding all locally cached updates.

Specified by:

abort in interface TransactionContext

getTransactionalMap

public <K,V> TransactionalMap<K,V> getTransactionalMap(String mapName,
                                                       Serializer serializer)

Description copied from interface: TransactionContext

Returns a transactional map data structure with the specified name.

Specified by:

getTransactionalMap in interface TransactionContext

Type Parameters:

K - key type

V - value type

Parameters:

mapName - name of the transactional map

serializer - serializer to use for encoding/decoding keys and values of the map

Returns:

Transactional Map

toString

public String toString()

Overrides:

toString in class Object