Top Description Methods
org.springframework.transaction

public Interface PlatformTransactionManager

extends TransactionManager
Known Direct Subinterfaces
org.springframework.transaction.support.CallbackPreferringPlatformTransactionManager, org.springframework.transaction.support.ResourceTransactionManager
Known Direct Implementers
org.springframework.transaction.support.AbstractPlatformTransactionManager
Imports
org.springframework.lang.Nullable
This is the central interface in Spring's imperative transaction infrastructure. Applications can use this directly, but it is not primarily meant as an API: Typically, applications will work with either TransactionTemplate or declarative transaction demarcation through AOP.

For implementors, it is recommended to derive from the provided org.springframework.transaction.support.AbstractPlatformTransactionManager class, which pre-implements the defined propagation behavior and takes care of transaction synchronization handling. Subclasses have to implement template methods for specific states of the underlying transaction, for example: begin, suspend, resume, commit.

A classic implementation of this strategy interface is org.springframework.transaction.jta.JtaTransactionManager. However, in common single-resource scenarios, Spring's specific transaction managers for e.g. JDBC, JPA, JMS are preferred choices.

Authors
Rod Johnson, Juergen Hoeller
Since
16.05.2003
See Also
org.springframework.transaction.support.TransactionTemplate, org.springframework.transaction.interceptor.TransactionInterceptor, org.springframework.transaction.ReactiveTransactionManager, ConfigurableTransactionManager

Method Summary

Modifier and TypeMethod and Description
public void
commit(TransactionStatus
object returned by the getTransaction method
status)

Commit the given transaction, with regard to its status.

public TransactionStatus

Returns:

transaction status object representing the new or current transaction
getTransaction(TransactionDefinition
the TransactionDefinition instance (can be null for defaults), describing propagation behavior, isolation level, timeout etc.
definition)

Return a currently active transaction or create a new one, according to the specified propagation behavior.

public void
rollback(TransactionStatus
object returned by the getTransaction method
status)

Perform a rollback of the given transaction.

Method Detail

commitback to summary
public void commit(TransactionStatus status) throws TransactionException

Commit the given transaction, with regard to its status. If the transaction has been marked rollback-only programmatically, perform a rollback.

If the transaction wasn't a new one, omit the commit for proper participation in the surrounding transaction. If a previous transaction has been suspended to be able to create a new one, resume the previous transaction after committing the new one.

Note that when the commit call completes, no matter if normally or throwing an exception, the transaction must be fully completed and cleaned up. No rollback call should be expected in such a case.

Depending on the concrete transaction manager setup, commit may propagate org.springframework.dao.DataAccessException as well, either from before-commit flushes or from the actual commit step.

Parameters
status:TransactionStatus

object returned by the getTransaction method

Exceptions
UnexpectedRollbackException:
in case of an unexpected rollback that the transaction coordinator initiated
HeuristicCompletionException:
in case of a transaction failure caused by a heuristic decision on the side of the transaction coordinator
TransactionSystemException:
in case of commit or system errors (typically caused by fundamental resource failures)
IllegalTransactionStateException:
if the given transaction is already completed (that is, committed or rolled back)
See Also
TransactionStatus#setRollbackOnly
getTransactionback to summary
public TransactionStatus getTransaction(TransactionDefinition definition) throws TransactionException

Return a currently active transaction or create a new one, according to the specified propagation behavior.

Note that parameters like isolation level or timeout will only be applied to new transactions, and thus be ignored when participating in active ones.

Furthermore, not all transaction definition settings will be supported by every transaction manager: A proper transaction manager implementation should throw an exception when unsupported settings are encountered.

An exception to the above rule is the read-only flag, which should be ignored if no explicit read-only mode is supported. Essentially, the read-only flag is just a hint for potential optimization.

Parameters
definition:TransactionDefinition

the TransactionDefinition instance (can be null for defaults), describing propagation behavior, isolation level, timeout etc.

Returns:TransactionStatus

transaction status object representing the new or current transaction

Exceptions
TransactionException:
in case of lookup, creation, or system errors
IllegalTransactionStateException:
if the given transaction definition cannot be executed (for example, if a currently active transaction is in conflict with the specified propagation behavior)
See Also
TransactionDefinition#getPropagationBehavior, TransactionDefinition#getIsolationLevel, TransactionDefinition#getTimeout, TransactionDefinition#isReadOnly
rollbackback to summary
public void rollback(TransactionStatus status) throws TransactionException

Perform a rollback of the given transaction.

If the transaction wasn't a new one, just set it rollback-only for proper participation in the surrounding transaction. If a previous transaction has been suspended to be able to create a new one, resume the previous transaction after rolling back the new one.

Do not call rollback on a transaction if commit threw an exception. The transaction will already have been completed and cleaned up when commit returns, even in case of a commit exception. Consequently, a rollback call after commit failure will lead to an IllegalTransactionStateException.

Depending on the concrete transaction manager setup, rollback may propagate org.springframework.dao.DataAccessException as well.

Parameters
status:TransactionStatus

object returned by the getTransaction method

Exceptions
TransactionSystemException:
in case of rollback or system errors (typically caused by fundamental resource failures)
IllegalTransactionStateException:
if the given transaction is already completed (that is, committed or rolled back)