org.everit.transaction.propagator

Interface TransactionPropagator

public interface TransactionPropagator

TransactionHelper OSGi service can be used to manipulate transactions on the current thread. The methods of this service can be used with normal Callback objects, anonymous classes or lambda expressions.

Method Summary

Modifier and Type	Method and Description
default void	mandatory(Runnable action) Support a current transaction, throw an exception if none exists.
<R> R	mandatory(java.util.function.Supplier<R> action) Support a current transaction, throw an exception if none exists.
default void	never(Runnable action) Execute non-transactionally, throw an exception if a transaction exists.
<R> R	never(java.util.function.Supplier<R> action) Execute non-transactionally, throw an exception if a transaction exists.
default void	notSupported(Runnable action) Execute non-transactionally, suspend the current transaction if one exists.
<R> R	notSupported(java.util.function.Supplier<R> action) Execute non-transactionally, suspend the current transaction if one exists.
default void	required(Runnable action) Support a current transaction, create a new one if none exists.
<R> R	required(java.util.function.Supplier<R> action) Support a current transaction, create a new one if none exists.
default void	requiresNew(Runnable action) Create a new transaction, suspend the current transaction if one exists.
<R> R	requiresNew(java.util.function.Supplier<R> action) Create a new transaction, suspend the current transaction if one exists.
default void	supports(Runnable action) Support a current transaction, execute it without a transaction if none exists.
<R> R	supports(java.util.function.Supplier<R> action) Support a current transaction, execute it without a transaction if none exists.

Method Detail

mandatory

default void mandatory(Runnable action)

Support a current transaction, throw an exception if none exists. In case there is an exception in the callback, the transaction status is set to MARKED_ROLLBACK.

Parameters:

action - The action instance will be called inside.

Throws:

IllegalStateException - if there is no active transaction.

mandatory

<R> R mandatory(java.util.function.Supplier<R> action)

Support a current transaction, throw an exception if none exists. In case there is an exception in the callback, the transaction status is set to MARKED_ROLLBACK.

Type Parameters:

R - Return type.

Parameters:

action - The action instance will be called inside.

Returns:

The result of the action execution.

Throws:

IllegalStateException - if there is no active transaction.

never

default void never(Runnable action)

Execute non-transactionally, throw an exception if a transaction exists.

Parameters:

action - The action instance will be called inside.

Throws:

IllegalStateException - if the status of the current thread is different from STATUS_NO_TRANSACTION.

never

<R> R never(java.util.function.Supplier<R> action)

Execute non-transactionally, throw an exception if a transaction exists.

Type Parameters:

R - Return type.

Parameters:

action - The action instance will be called inside.

Returns:

The result of the action execution.

Throws:

IllegalStateException - if the status of the current thread is different from STATUS_NO_TRANSACTION.

notSupported

default void notSupported(Runnable action)

Execute non-transactionally, suspend the current transaction if one exists.

Parameters:

action - The action instance will be called inside.

Throws:

IllegalStateException - if the transaction status at the time of calling this function is neither STATUS_ACTIVE nor STATUS_NO_TRANSACTION.

notSupported

<R> R notSupported(java.util.function.Supplier<R> action)

Execute non-transactionally, suspend the current transaction if one exists.

Type Parameters:

R - Return type.

Parameters:

action - The action instance will be called inside.

Returns:

The result of the action execution.

Throws:

IllegalStateException - if the transaction status at the time of calling this function is neither STATUS_ACTIVE nor STATUS_NO_TRANSACTION.

required

default void required(Runnable action)

Support a current transaction, create a new one if none exists. In case there is an exception in the callback and the function call created the transaction, the transaction will be rollbacked. In case there is an exception and there was already a transaction when the method was called, the transaction status is set to MARKED_ROLLBACK.

Parameters:

action - The action instance will be called inside.

Throws:

IllegalStateException - if the transaction status at the time of calling this function is neither STATUS_ACTIVE nor STATUS_NO_TRANSACTION.

required

<R> R required(java.util.function.Supplier<R> action)

Support a current transaction, create a new one if none exists. In case there is an exception in the callback and the function call created the transaction, the transaction will be rollbacked. In case there is an exception and there was already a transaction when the method was called, the transaction status is set to MARKED_ROLLBACK.

Type Parameters:

R - Return type.

Parameters:

action - The action instance will be called inside.

Returns:

The result of the action execution.

Throws:

IllegalStateException - if the transaction status at the time of calling this function is neither STATUS_ACTIVE nor STATUS_NO_TRANSACTION.

requiresNew

default void requiresNew(Runnable action)

Create a new transaction, suspend the current transaction if one exists. In case there is an exception, the newly created transaction will be rolled back.

Parameters:

action - The action instance will be called inside.

requiresNew

<R> R requiresNew(java.util.function.Supplier<R> action)

Create a new transaction, suspend the current transaction if one exists. In case there is an exception, the newly created transaction will be rolled back.

Type Parameters:

R - Return type.

Parameters:

action - The action instance will be called inside.

Returns:

The result of the action execution.

supports

default void supports(Runnable action)

Support a current transaction, execute it without a transaction if none exists. If there was an ACTIVE transaction at the time calling the function and the callback throws an exception, the transaction status will be MARKED_ROLLBACK.

Parameters:

action - The action instance will be called inside.

Throws:

IllegalStateException - if the transaction status at the time of calling this function is neither STATUS_ACTIVE nor STATUS_NO_TRANSACTION.

supports

<R> R supports(java.util.function.Supplier<R> action)

Support a current transaction, execute it without a transaction if none exists. If there was an ACTIVE transaction at the time calling the function and the callback throws an exception, the transaction status will be MARKED_ROLLBACK.

Type Parameters:

R - Return type.

Parameters:

action - The action instance will be called inside.

Returns:

The result of the action execution.

Throws:

IllegalStateException - if the transaction status at the time of calling this function is neither STATUS_ACTIVE nor STATUS_NO_TRANSACTION.