Package com.microsoft.azure.servicebus

Class TransactionContext

java.lang.Object

com.microsoft.azure.servicebus.TransactionContext

public class TransactionContext
extends Object

Represents an active servicebus transaction. A transaction is initiated by calling MessagingFactory.startTransactionAsync(). A transaction can result in commit or rollback. To commit, call MessagingFactory.endTransactionAsync(TransactionContext, boolean) with commit = true To rollback, call MessagingFactory.endTransactionAsync(TransactionContext, boolean) with commit = false

Field Summary

Fields

Modifier and Type	Field	Description
static TransactionContext	NULL_TXN

Constructor Summary

Constructors

Constructor	Description
TransactionContext(ByteBuffer txnId, MessagingFactory messagingFactory)

Method Summary

Modifier and Type	Method	Description
void	commit()	Commits the transaction
CompletableFuture<Void>	commitAsync()	Asynchronously commits the transaction
ByteBuffer	getTransactionId()	Represents the service-side transactionID
void	notifyTransactionCompletion(boolean commit)	This is not to be called by the user.
void	rollback()	Rollback the transaction
CompletableFuture<Void>	rollbackAsync()	Asynchronously rollback the transaction.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NULL_TXN

public static TransactionContext NULL_TXN

Constructor Detail

TransactionContext

public TransactionContext(ByteBuffer txnId,
                          MessagingFactory messagingFactory)

Method Detail

getTransactionId

public ByteBuffer getTransactionId()

Represents the service-side transactionID

Returns:

transaction ID

toString

public String toString()

Overrides:

toString in class Object

commit

public void commit()
            throws ServiceBusException,
                   InterruptedException

Commits the transaction

Throws:

ServiceBusException - if Commit failed

InterruptedException - if the current thread was interrupted while waiting

commitAsync

public CompletableFuture<Void> commitAsync()

Asynchronously commits the transaction

Returns:

a CompletableFuture for the commit operation

rollback

public void rollback()
              throws ServiceBusException,
                     InterruptedException

Rollback the transaction

Throws:

ServiceBusException - if rollback failed

InterruptedException - if the current thread was interrupted while waiting

rollbackAsync

public CompletableFuture<Void> rollbackAsync()

Asynchronously rollback the transaction.

Returns:

a CompletableFuture for the rollback operation

notifyTransactionCompletion

public void notifyTransactionCompletion(boolean commit)

This is not to be called by the user.

Parameters:

commit - true indicates success and false for rollback