net.sf.mmm.transaction.base

Class AbstractTransactionExecutor

java.lang.Object

net.sf.mmm.util.component.base.AbstractComponent

net.sf.mmm.util.component.base.AbstractLoggableComponent

net.sf.mmm.util.event.base.AbstractEventSource<TransactionEvent,TransactionEventListener>

net.sf.mmm.transaction.base.AbstractTransactionExecutor

All Implemented Interfaces:

TransactionExecutor, EventSource<TransactionEvent,TransactionEventListener>

Direct Known Subclasses:

JpaTransactionExecutor, JtaTransactionExecutor, NoTransactionExecutor, SpringTransactionExecutor

public abstract class AbstractTransactionExecutor
extends AbstractEventSource<TransactionEvent,TransactionEventListener>
implements TransactionExecutor

This is the abstract base implementation of the TransactionExecutor interface.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractTransactionExecutor.AbstractTransactionAdapter<TRANSACTION> This is the abstract base implementation of the TransactionAdapter interface.

Field Summary

Fields

Modifier and Type	Field and Description
private TransactionSettings	defaultSettings

Fields inherited from interface net.sf.mmm.transaction.api.TransactionExecutor

CDI_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractTransactionExecutor() The constructor.

Method Summary

Modifier and Type	Method and Description
protected TransactionContext	createTransactionContext() This method create the TransactionContext instances.
protected void	doInitialize() This method performs the actual initialization.
<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.
protected TransactionSettings	getDefaultSettings() This method gets the default used if no TransactionSettings are specified explicitly on a call of doInTransaction.
protected abstract AbstractTransactionExecutor.AbstractTransactionAdapter<?>	openTransactionAdapter(TransactionSettings settings) This method opens a new TransactionAdapter.
void	setDefaultSettings(TransactionSettings settings) This method sets the default settings.

Methods inherited from class net.sf.mmm.util.event.base.AbstractEventSource

addListener, fireEvent, fireEvent, handleListenerError, removeListener

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableComponent

createLogger, getLogger

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent

doInitialized, getInitializationState, initialize

Methods inherited from class java.lang.Object

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

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

addListener, removeListener

Field Detail

defaultSettings

private TransactionSettings defaultSettings

See Also:

getDefaultSettings()

Constructor Detail

AbstractTransactionExecutor

public AbstractTransactionExecutor()

The constructor.

Method Detail

getDefaultSettings

protected TransactionSettings getDefaultSettings()

This method gets the default used if no TransactionSettings are specified explicitly on a call of doInTransaction.

Returns:

the default settings.

setDefaultSettings

public void setDefaultSettings(TransactionSettings settings)

This method sets the default settings.

Parameters:

settings - are the settings to set.

doInitialize

protected void doInitialize()

This method performs the actual initialization. It is called when AbstractComponent.initialize() is invoked for the first time.
ATTENTION:
When you override this method from a sub-class you need to do a super.AbstractComponent.doInitialize().

Overrides:

doInitialize in class AbstractLoggableComponent

openTransactionAdapter

protected abstract AbstractTransactionExecutor.AbstractTransactionAdapter<?> openTransactionAdapter(TransactionSettings settings)

This method opens a new TransactionAdapter.

Parameters:

settings - are the according TransactionSettings.

Returns:

the new TransactionAdapter.

createTransactionContext

protected TransactionContext createTransactionContext()

This method create the TransactionContext instances. Override to change fabrication.

Returns:

a new TransactionContext instance.

doInTransaction

public <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).

Specified by:

doInTransaction in interface TransactionExecutor

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

public <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).

Specified by:

doInTransaction in interface TransactionExecutor

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

public <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).

Specified by:

doInTransaction in interface TransactionExecutor

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

public <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).

Specified by:

doInTransaction in interface TransactionExecutor

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.