io.cdap.cdap.api

Class Transactionals

java.lang.Object

io.cdap.cdap.api.Transactionals

public final class Transactionals
extends Object

Helper class for interacting with Transactional

Method Summary

Modifier and Type	Method and Description
static <V> V	execute(Transactional transactional, int timeout, TxCallable<V> callable) Executes the given TxCallable using the given Transactional with a given timeout in seconds.
static <V> V	execute(Transactional transactional, TxCallable<V> callable) Executes the given TxCallable using the given Transactional.
static <V,X extends Throwable> V	execute(Transactional transactional, TxCallable<V> callable, Class<X> exception) Executes the given TxCallable using the given Transactional.
static <V,X1 extends Throwable,X2 extends Throwable> V	execute(Transactional transactional, TxCallable<V> callable, Class<X1> exception1, Class<X2> exception2) Executes the given TxCallable using the given Transactional.
static void	execute(Transactional transactional, TxRunnable runnable) Executes the given TxRunnable using the given Transactional.
static <X extends Throwable> void	execute(Transactional transactional, TxRunnable runnable, Class<X> exception) Executes the given TxRunnable using the given Transactional.
static <X1 extends Throwable,X2 extends Throwable> void	execute(Transactional transactional, TxRunnable runnable, Class<X1> exception1, Class<X2> exception2) Executes the given TxRunnable using the given Transactional.
static <X extends Throwable> X	propagate(org.apache.tephra.TransactionFailureException e, Class<X> propagateType) Propagates the given TransactionFailureException.
static <X1 extends Throwable,X2 extends Throwable> X1	propagate(org.apache.tephra.TransactionFailureException e, Class<X1> propagateType1, Class<X2> propagateType2) Propagates the given TransactionFailureException.

Methods inherited from class java.lang.Object

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

Method Detail

execute

public static void execute(Transactional transactional,
                           TxRunnable runnable)

Executes the given TxRunnable using the given Transactional.

Parameters:

transactional - the Transactional to use for transactional execution.

runnable - the TxRunnable to be executed inside a transaction

Throws:

RuntimeException - if failed to execute the given TxRunnable in a transaction. If the TransactionFailureException has a cause in it, the cause is propagated.

execute

public static <X extends Throwable> void execute(Transactional transactional,
                                                 TxRunnable runnable,
                                                 Class<X> exception)
                                          throws X extends Throwable

Executes the given TxRunnable using the given Transactional.

Type Parameters:

X - exception type of propagate type

Parameters:

transactional - the Transactional to use for transactional execution.

runnable - the TxRunnable to be executed inside a transaction

Throws:

X - if failed to execute the given TxRunnable in a transaction. If the TransactionFailureException has a cause in it, the cause is thrown as-is if it is an instance of X.

RuntimeException - if cause is not an instance of X. The cause is wrapped with RuntimeException if it is not already a RuntimeException.

X extends Throwable

execute

public static <X1 extends Throwable,X2 extends Throwable> void execute(Transactional transactional,
                                                                       TxRunnable runnable,
                                                                       Class<X1> exception1,
                                                                       Class<X2> exception2)
                                                                throws X1 extends Throwable,
                                                                       X2 extends Throwable

Executes the given TxRunnable using the given Transactional.

Type Parameters:

X1 - exception type of first propagate type

X2 - exception type of second propagate type

Parameters:

transactional - the Transactional to use for transactional execution.

runnable - the TxRunnable to be executed inside a transaction

Throws:

X1 - if failed to execute the given TxRunnable in a transaction. If the TransactionFailureException has a cause in it, the cause is thrown as-is if it is an instance of X1.

X2 - if failed to execute the given TxRunnable in a transaction. If the TransactionFailureException has a cause in it, the cause is thrown as-is if it is an instance of X2.

RuntimeException - if cause is not an instance of X1 or X2. The cause is wrapped with RuntimeException if it is not already a RuntimeException.

X1 extends Throwable

execute

public static <V> V execute(Transactional transactional,
                            TxCallable<V> callable)

Executes the given TxCallable using the given Transactional.

Type Parameters:

V - type of the result

Parameters:

transactional - the Transactional to use for transactional execution.

callable - the TxCallable to be executed inside a transaction

Returns:

value returned by the given TxCallable.

Throws:

RuntimeException - if failed to execute the given TxRunnable in a transaction. If the TransactionFailureException has a cause in it, the cause is propagated.

execute

public static <V> V execute(Transactional transactional,
                            int timeout,
                            TxCallable<V> callable)

Executes the given TxCallable using the given Transactional with a given timeout in seconds.

Type Parameters:

V - type of the result

Parameters:

transactional - the Transactional to use for transactional execution.

timeout - the timeout in seconds for transactional execution

callable - the TxCallable to be executed inside a transaction

Returns:

value returned by the given TxCallable.

Throws:

RuntimeException - if failed to execute the given TxRunnable in a transaction. If the TransactionFailureException has a cause in it, the cause is propagated.

execute

public static <V,X extends Throwable> V execute(Transactional transactional,
                                                TxCallable<V> callable,
                                                Class<X> exception)
                                         throws X extends Throwable

Executes the given TxCallable using the given Transactional.

Type Parameters:

V - type of the result

X - exception type of propagate type

Parameters:

transactional - the Transactional to use for transactional execution.

callable - the TxCallable to be executed inside a transaction

Returns:

value returned by the given TxCallable.

Throws:

X - if failed to execute the given TxRunnable in a transaction. If the TransactionFailureException has a cause in it, the cause is thrown as-is if it is an instance of X.

RuntimeException - if cause is not an instance of X. The cause is wrapped with RuntimeException if it is not already a RuntimeException.

X extends Throwable

execute

public static <V,X1 extends Throwable,X2 extends Throwable> V execute(Transactional transactional,
                                                                      TxCallable<V> callable,
                                                                      Class<X1> exception1,
                                                                      Class<X2> exception2)
                                                               throws X1 extends Throwable,
                                                                      X2 extends Throwable

Executes the given TxCallable using the given Transactional.

Type Parameters:

V - type of the result

X1 - exception type of first propagate type

X2 - exception type of second propagate type

Parameters:

transactional - the Transactional to use for transactional execution.

callable - the TxCallable to be executed inside a transaction

Returns:

value returned by the given TxCallable.

Throws:

X1 - if failed to execute the given TxRunnable in a transaction. If the TransactionFailureException has a cause in it, the cause is thrown as-is if it is an instance of X1.

X2 - if failed to execute the given TxRunnable in a transaction. If the TransactionFailureException has a cause in it, the cause is thrown as-is if it is an instance of X2.

RuntimeException - if cause is not an instance of X1 or X2. The cause is wrapped with RuntimeException if it is not already a RuntimeException.

X1 extends Throwable

propagate

public static <X extends Throwable> X propagate(org.apache.tephra.TransactionFailureException e,
                                                Class<X> propagateType)
                                         throws X extends Throwable

Propagates the given TransactionFailureException. If the Throwable.getCause() doesn't return null, the cause will be used instead for the propagation. This method will throw the failure exception as-is the given propagated type if the type matches or as RuntimeException. This method will always throw exception and the returned exception is for satisfying Java static analysis only.

Type Parameters:

X - exception type of propagate type

Parameters:

e - the TransactionFailureException to propagate

propagateType - if the exception is an instance of this type, it will be rethrown as is

Returns:

a exception of type X.

Throws:

X extends Throwable

propagate

public static <X1 extends Throwable,X2 extends Throwable> X1 propagate(org.apache.tephra.TransactionFailureException e,
                                                                       Class<X1> propagateType1,
                                                                       Class<X2> propagateType2)
                                                                throws X1 extends Throwable,
                                                                       X2 extends Throwable

Propagates the given TransactionFailureException. If the Throwable.getCause() doesn't return null, the cause will be used instead for the propagation. This method will throw the failure exception as-is the given propagated types if the type matches or as RuntimeException. This method will always throw and the returned exception is for satisfying Java static analysis only.

Type Parameters:

X1 - exception type of first propagate type

X2 - exception type of second propagate type

Parameters:

e - the TransactionFailureException to propagate

propagateType1 - if the exception is an instance of this type, it will be rethrown as is

propagateType2 - if the exception is an instance of this type, it will be rethrown as is

Returns:

a exception of type X1,X2.

Throws:

X1 extends Throwable