co.cask.tephra

Class DefaultTransactionExecutor

java.lang.Object

co.cask.tephra.AbstractTransactionExecutor

co.cask.tephra.DefaultTransactionExecutor

All Implemented Interfaces:

TransactionExecutor

public class DefaultTransactionExecutor
extends AbstractTransactionExecutor

Utility class that encapsulates the transaction life cycle over a given set of transaction-aware datasets. The executor can be reused across multiple invocations of the execute() method. However, it is not thread-safe for concurrent execution.

Transaction execution will be retries according to specified in constructor RetryStrategy. By default RetryOnConflictStrategy is used with max 20 retries and 100 ms between retries.

Nested Class Summary

Nested classes/interfaces inherited from interface co.cask.tephra.TransactionExecutor

TransactionExecutor.Function<I,O>, TransactionExecutor.Procedure<I>, TransactionExecutor.Subroutine

Constructor Summary

Constructors

Constructor and Description
DefaultTransactionExecutor(TransactionSystemClient txClient, Iterable<TransactionAware> txAwares) Constructor for a transaction executor.
DefaultTransactionExecutor(TransactionSystemClient txClient, Iterable<TransactionAware> txAwares, RetryStrategy retryStrategy)
DefaultTransactionExecutor(TransactionSystemClient txClient, TransactionAware... txAwares) Convenience constructor, has same affect as DefaultTransactionExecutor(TransactionSystemClient, Iterable)

Method Summary

Methods

Modifier and Type	Method and Description
<O> O	execute(Callable<O> callable) Like TransactionExecutor.execute(Function, Object) but the callable has no argument.
<I,O> O	execute(TransactionExecutor.Function<I,O> function, I input) Execute a function under transactional semantics.
<I> void	execute(TransactionExecutor.Procedure<I> procedure, I input) Like TransactionExecutor.execute(Function, Object) but without a return value.
void	execute(TransactionExecutor.Subroutine subroutine) Like TransactionExecutor.execute(Function, Object) but without argument or return value.

Methods inherited from class co.cask.tephra.AbstractTransactionExecutor

executeUnchecked, executeUnchecked, executeUnchecked, executeUnchecked, submit, submit, submit, submit

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultTransactionExecutor

public DefaultTransactionExecutor(TransactionSystemClient txClient,
                          TransactionAware... txAwares)

Convenience constructor, has same affect as DefaultTransactionExecutor(TransactionSystemClient, Iterable)

DefaultTransactionExecutor

public DefaultTransactionExecutor(TransactionSystemClient txClient,
                          Iterable<TransactionAware> txAwares,
                          RetryStrategy retryStrategy)

DefaultTransactionExecutor

@Inject
public DefaultTransactionExecutor(TransactionSystemClient txClient,
                                 Iterable<TransactionAware> txAwares)

Constructor for a transaction executor.

Method Detail

execute

public <I,O> O execute(TransactionExecutor.Function<I,O> function,
              I input)
          throws TransactionFailureException,
                 InterruptedException

Description copied from interface: TransactionExecutor

Execute a function under transactional semantics. A transaction is started and all datasets are initialized with the transaction. Then the passed function is executed, the transaction is committed, and the function return value is returned as the return value of this method. If any exception is caught, the transaction is aborted and the original exception is rethrown, wrapped into a TransactionFailureException. If the transaction fails due to a write conflict, a TransactionConflictException is thrown.

Type Parameters:

I - the input type of the function

O - the result type of the function

Parameters:

function - the function to execute

input - the input parameter for the function

Returns:

the function's return value

Throws:

TransactionConflictException - if there is a write conflict with another transaction.

TransactionFailureException - if any exception is caught, be it from the function or from the datasets.

InterruptedException

execute

public <I> void execute(TransactionExecutor.Procedure<I> procedure,
               I input)
             throws TransactionFailureException,
                    InterruptedException

Description copied from interface: TransactionExecutor

Like TransactionExecutor.execute(Function, Object) but without a return value.

Throws:

TransactionFailureException

InterruptedException

execute

public <O> O execute(Callable<O> callable)
          throws TransactionFailureException,
                 InterruptedException

Description copied from interface: TransactionExecutor

Like TransactionExecutor.execute(Function, Object) but the callable has no argument.

Throws:

TransactionFailureException

InterruptedException

execute

public void execute(TransactionExecutor.Subroutine subroutine)
             throws TransactionFailureException,
                    InterruptedException

Description copied from interface: TransactionExecutor

Like TransactionExecutor.execute(Function, Object) but without argument or return value.

Throws:

TransactionFailureException

InterruptedException