TransactionTemplate

Class Overview

Template class that simplifies programmatic transaction demarcation and transaction exception handling.

The central method is execute(TransactionCallback), 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.

Summary

[Expand] Inherited Constants
From class org.springframework.transaction.support.DefaultTransactionDefinition String PREFIX_ISOLATION Prefix for the isolation constants defined in TransactionDefinition String PREFIX_PROPAGATION Prefix for the propagation constants defined in TransactionDefinition String PREFIX_TIMEOUT Prefix for transaction timeout values in description strings String READ_ONLY_MARKER Marker for read-only transactions in description strings
From interface org.springframework.transaction.TransactionDefinition int ISOLATION_DEFAULT Use the default isolation level of the underlying datastore. int ISOLATION_READ_COMMITTED Indicates that dirty reads are prevented; non-repeatable reads and phantom reads can occur. int ISOLATION_READ_UNCOMMITTED Indicates that dirty reads, non-repeatable reads and phantom reads can occur. int ISOLATION_REPEATABLE_READ Indicates that dirty reads and non-repeatable reads are prevented; phantom reads can occur. int ISOLATION_SERIALIZABLE Indicates that dirty reads, non-repeatable reads and phantom reads are prevented. int PROPAGATION_MANDATORY Support a current transaction; throw an exception if no current transaction exists. int PROPAGATION_NESTED Execute within a nested transaction if a current transaction exists, behave like PROPAGATION_REQUIRED else. int PROPAGATION_NEVER Do not support a current transaction; throw an exception if a current transaction exists. int PROPAGATION_NOT_SUPPORTED Do not support a current transaction; rather always execute non-transactionally. int PROPAGATION_REQUIRED Support a current transaction; create a new one if none exists. int PROPAGATION_REQUIRES_NEW Create a new transaction, suspending the current transaction if one exists. int PROPAGATION_SUPPORTS Support a current transaction; execute non-transactionally if none exists. int TIMEOUT_DEFAULT Use the default timeout of the underlying transaction system, or none if timeouts are not supported.

[Expand] Inherited Methods
From class org.springframework.transaction.support.DefaultTransactionDefinition boolean equals(Object other) This implementation compares the toString() results. final StringBuilder getDefinitionDescription() Return an identifying description for this transaction definition. final int getIsolationLevel() Return the isolation level. final String getName() Return the name of this transaction. final int getPropagationBehavior() Return the propagation behavior. final int getTimeout() Return the transaction timeout. int hashCode() This implementation returns toString()'s hash code. final boolean isReadOnly() Return whether to optimize as a read-only transaction. final void setIsolationLevel(int isolationLevel) Set the isolation level. final void setIsolationLevelName(String constantName) Set the isolation level by the name of the corresponding constant in TransactionDefinition, e.g. final void setName(String name) Set the name of this transaction. final void setPropagationBehavior(int propagationBehavior) Set the propagation behavior. final void setPropagationBehaviorName(String constantName) Set the propagation behavior by the name of the corresponding constant in TransactionDefinition, e.g. final void setReadOnly(boolean readOnly) Set whether to optimize as read-only transaction. final void setTimeout(int timeout) Set the timeout to apply, as number of seconds. String toString() Return an identifying description for this transaction definition.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.springframework.beans.factory.InitializingBean abstract void afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
From interface org.springframework.transaction.TransactionDefinition abstract int getIsolationLevel() Return the isolation level. abstract String getName() Return the name of this transaction. abstract int getPropagationBehavior() Return the propagation behavior. abstract int getTimeout() Return the transaction timeout. abstract boolean isReadOnly() Return whether to optimize as a read-only transaction.
From interface org.springframework.transaction.support.TransactionOperations abstract <T> T execute(TransactionCallback<T> action) Execute the action specified by the given callback object within a transaction.