Package org.springframework.transaction.support

Class TransactionTemplate

java.lang.Object
org.springframework.transaction.support.DefaultTransactionDefinition
org.springframework.transaction.support.TransactionTemplate
All Implemented Interfaces:
Serializable, org.springframework.beans.factory.InitializingBean, TransactionOperations, TransactionDefinition
public class TransactionTemplate extends DefaultTransactionDefinition implements TransactionOperations, org.springframework.beans.factory.InitializingBean
Template class that simplifies programmatic transaction demarcation and transaction exception handling.

The central method is execute(org.springframework.transaction.support.TransactionCallback<T>), supporting transactional code that implements the TransactionCallback interface. This template handles the transaction lifecycle and possible exceptions such that neither the TransactionCallback implementation nor the calling code needs to explicitly handle transactions.

Typical usage: Allows for writing low-level data access objects that use resources such as JDBC DataSources but are not transaction-aware themselves. Instead, they can implicitly participate in transactions handled by higher-level application services utilizing this class, making calls to the low-level services via an inner-class callback object.

Can be used within a service implementation via direct instantiation with a transaction manager reference, or get prepared in an application context and passed to services as bean reference. Note: The transaction manager should always be configured as bean in the application context: in the first case given to the service directly, in the second case given to the prepared template.

Supports setting the propagation behavior and the isolation level by name, for convenient configuration in context definitions.

Since:
17.03.2003
Author:
Juergen Hoeller
See Also:

  • Field Details

    • logger

      protected final org.apache.commons.logging.Log logger
      Logger available to subclasses.

  • Constructor Details

    • TransactionTemplate

      public TransactionTemplate()
      Construct a new TransactionTemplate for bean usage.

      Note: The PlatformTransactionManager needs to be set before any execute calls.

      See Also:

    • TransactionTemplate

      public TransactionTemplate(PlatformTransactionManager transactionManager)
      Construct a new TransactionTemplate using the given transaction manager.
      Parameters:
      transactionManager - the transaction management strategy to be used

    • TransactionTemplate

      public TransactionTemplate(PlatformTransactionManager transactionManager, TransactionDefinition transactionDefinition)
      Construct a new TransactionTemplate using the given transaction manager, taking its default settings from the given transaction definition.
      Parameters:
      transactionManager - the transaction management strategy to be used
      transactionDefinition - the transaction definition to copy the default settings from. Local properties can still be set to change values.

  • Method Details

    • setTransactionManager

      public void setTransactionManager(@Nullable PlatformTransactionManager transactionManager)
      Set the transaction management strategy to be used.

    • getTransactionManager

      @Nullable public PlatformTransactionManager getTransactionManager()
      Return the transaction management strategy to be used.

    • afterPropertiesSet

      public void afterPropertiesSet()
      Specified by:
      afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

    • execute

      @Nullable public <T> T execute(TransactionCallback<T> action) throws TransactionException
      Description copied from interface: TransactionOperations
      Execute the action specified by the given callback object within a transaction.

      Allows for returning a result object created within the transaction, that is, a domain object or a collection of domain objects. A RuntimeException thrown by the callback is treated as a fatal exception that enforces a rollback. Such an exception gets propagated to the caller of the template.

      Specified by:
      execute in interface TransactionOperations
      Parameters:
      action - the callback object that specifies the transactional action
      Returns:
      a result object returned by the callback, or null if none
      Throws:
      TransactionException - in case of initialization, rollback, or system errors
      See Also:

    • equals

      public boolean equals(@Nullable Object other)
      Description copied from class: DefaultTransactionDefinition
      This implementation compares the toString() results.
      Overrides:
      equals in class DefaultTransactionDefinition
      See Also: