net.sf.mmm.transaction.api

Interface TransactionExecutor

All Superinterfaces:

EventSource<TransactionEvent,TransactionEventListener>

All Known Implementing Classes:

AbstractTransactionExecutor, JpaTransactionExecutor, JtaTransactionExecutor, NoTransactionExecutor, SpringTransactionExecutor

@ComponentSpecification
public interface TransactionExecutor
extends EventSource<TransactionEvent,TransactionEventListener>

This is the interface for a component capable of executing your code within a transaction. It is a front-end to an underlying transaction-manager that makes your transactional code easy and less error-prone.
Additionally it allows you to add custom hooks to your transaction-management if you perform all transaction operations via this API.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CDI_NAME The CDI name.

Method Summary

Modifier and Type	Method and Description
<RESULT> RESULT	doInTransaction(Callable<RESULT> callable) This method executes the given callable in the context of a transaction.
<RESULT> RESULT	doInTransaction(Callable<RESULT> callable, TransactionSettings settings) This method executes the given callable in the context of a transaction.
<RESULT> RESULT	doInTransaction(TransactionCallable<RESULT> callable) This method executes the given callable in the context of a transaction.
<RESULT> RESULT	doInTransaction(TransactionCallable<RESULT> callable, TransactionSettings settings) This method executes the given callable in the context of a transaction.

Methods inherited from interface net.sf.mmm.util.event.api.EventSource

addListener, removeListener

Field Detail

CDI_NAME

static final String CDI_NAME

The CDI name.

See Also:

Constant Field Values

Method Detail

doInTransaction

<RESULT> RESULT doInTransaction(Callable<RESULT> callable)
                         throws Exception

This method executes the given callable in the context of a transaction.
Therefore this method opens a new transaction, invokes the callable in a surrounding try-statement so that the transaction is automatically committed if your callable succeeds while a rollback is performed in case it fails (throws anything).

Type Parameters:

RESULT - is the generic type returned from your callable.

Parameters:

callable - is the Callable to be executed within a transaction.

Returns:

the result of the callable.

Throws:

Exception - if the callable failed.

doInTransaction

<RESULT> RESULT doInTransaction(Callable<RESULT> callable,
                                TransactionSettings settings)
                         throws Exception

This method executes the given callable in the context of a transaction.
Therefore this method opens a new transaction, invokes the callable in a surrounding try-statement so that the transaction is automatically committed if your callable succeeds while a rollback is performed in case it fails (throws anything).

Type Parameters:

RESULT - is the generic type returned from your callable.

Parameters:

callable - is the Callable to be executed within a transaction.

settings - are the settings to configure transactions.

Returns:

the result of the callable.

Throws:

Exception - if the callable failed.

doInTransaction

<RESULT> RESULT doInTransaction(TransactionCallable<RESULT> callable)

This method executes the given callable in the context of a transaction.
Therefore this method opens a new transaction, invokes the callable in a surrounding try-statement so that the transaction is automatically committed if your callable succeeds while a rollback is performed in case it fails (throws anything).

Type Parameters:

RESULT - is the generic type returned from your callable.

Parameters:

callable - is the Callable to be executed within a transaction.

Returns:

the result of the callable.

doInTransaction

<RESULT> RESULT doInTransaction(TransactionCallable<RESULT> callable,
                                TransactionSettings settings)

This method executes the given callable in the context of a transaction.
Therefore this method opens a new transaction, invokes the callable in a surrounding try-statement so that the transaction is automatically committed if your callable succeeds while a rollback is performed in case it fails (throws anything).

Type Parameters:

RESULT - is the generic type returned from your callable.

Parameters:

callable - is the Callable to be executed within a transaction.

settings - are the settings to configure transactions.

Returns:

the result of the callable.