Interface PlatformTransactionManager
- All Superinterfaces:
TransactionManager
- All Known Subinterfaces:
CallbackPreferringPlatformTransactionManager
,ResourceTransactionManager
- All Known Implementing Classes:
AbstractPlatformTransactionManager
,DataSourceTransactionManager
,HibernateTransactionManager
,JdbcTransactionManager
,JmsTransactionManager
,JpaTransactionManager
,JtaTransactionManager
For implementors, it is recommended to derive from the provided
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
JtaTransactionManager
. However,
in common single-resource scenarios, Spring's specific transaction managers
for e.g. JDBC, JPA, JMS are preferred choices.
- Since:
- 16.05.2003
- Author:
- Rod Johnson, Juergen Hoeller
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionvoid
commit
(TransactionStatus status) Commit the given transaction, with regard to its status.getTransaction
(TransactionDefinition definition) Return a currently active transaction or create a new one, according to the specified propagation behavior.void
rollback
(TransactionStatus status) Perform a rollback of the given transaction.
-
Method Details
-
getTransaction
TransactionStatus getTransaction(@Nullable 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
- the TransactionDefinition instance (can benull
for defaults), describing propagation behavior, isolation level, timeout etc.- Returns:
- transaction status object representing the new or current transaction
- Throws:
TransactionException
- in case of lookup, creation, or system errorsIllegalTransactionStateException
- 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:
-
commit
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 propagateDataAccessException
as well, either from before-commit flushes or from the actual commit step.- Parameters:
status
- object returned by thegetTransaction
method- Throws:
UnexpectedRollbackException
- in case of an unexpected rollback that the transaction coordinator initiatedHeuristicCompletionException
- in case of a transaction failure caused by a heuristic decision on the side of the transaction coordinatorTransactionSystemException
- 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)TransactionException
- See Also:
-
rollback
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 propagateDataAccessException
as well.- Parameters:
status
- object returned by thegetTransaction
method- Throws:
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)TransactionException
-