Home » Spring-Framework-090522 » org.springframework » transaction » [javadoc | source]
public interface: PlatformTransactionManager [javadoc | source]

All Known Implementing Classes:
    AbstractPlatformTransactionManager, JmsTransactionManager102, DataSourceTransactionManager, WebLogicJtaTransactionManager, TopLinkTransactionManager, OC4JJtaTransactionManager, CciLocalTransactionManager, JtaTransactionManager, ResourceTransactionManager, JmsTransactionManager, WebSphereUowTransactionManager, HibernateTransactionManager, JpaTransactionManager, PersistenceBrokerTransactionManager, HibernateTransactionManager, CallbackPreferringPlatformTransactionManager, JdoTransactionManager

This is the central interface in Spring's transaction infrastructure. Applications can use this directly, but it is not primarily meant as 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.

The default implementations of this strategy interface are org.springframework.transaction.jta.JtaTransactionManager and org.springframework.jdbc.datasource.DataSourceTransactionManager , which can serve as an implementation guide for other transaction strategies.

Method from org.springframework.transaction.PlatformTransactionManager Summary:
commit,   getTransaction,   rollback
Method from org.springframework.transaction.PlatformTransactionManager Detail:
 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.

    If this method throws an exception other than a TransactionException, then some before-commit error caused the commit attempt to fail. For example, an O/R Mapping tool might have tried to flush changes to the database right before commit, with the resulting DataAccessException causing the transaction to fail. The original exception will be propagated to the caller of this commit method in such a case.

 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.

 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.