|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.transaction.support.AbstractPlatformTransactionManager org.springframework.orm.toplink.TopLinkTransactionManager
public class TopLinkTransactionManager
PlatformTransactionManager
implementation
for a single TopLink SessionFactory
. Binds a TopLink Session from the
specified factory to the thread, potentially allowing for one thread-bound Session
per factory. SessionFactoryUtils
and TopLinkTemplate
are aware
of thread-bound Sessions and participate in such transactions automatically.
Using either of those or going through Session.getActiveUnitOfWork()
is
required for TopLink access code supporting this transaction handling mechanism.
This transaction manager is appropriate for applications that use a single
TopLink SessionFactory for transactional data access. JTA (usually through
JtaTransactionManager
) is necessary
for accessing multiple transactional resources within the same transaction.
Note that you need to configure TopLink with an appropriate external transaction
controller in order to make it participate in JTA transactions.
This transaction manager also supports direct DataSource access within a transaction
(i.e. plain JDBC code working with the same DataSource), but only for transactions
that are not marked as read-only. This allows for mixing services which
access TopLink and services which use plain JDBC (without being aware of TopLink)!
Application code needs to stick to the same simple Connection lookup pattern as
with DataSourceTransactionManager
(i.e. DataSourceUtils.getConnection(javax.sql.DataSource)
or going through a
TransactionAwareDataSourceProxy
).
Note: To be able to register a DataSource's Connection for plain JDBC code,
this instance needs to be aware of the DataSource (setDataSource(javax.sql.DataSource)
).
The given DataSource should obviously match the one used by the given TopLink
SessionFactory.
On JDBC 3.0, this transaction manager supports nested transactions via JDBC 3.0
Savepoints. The AbstractPlatformTransactionManager.setNestedTransactionAllowed(boolean)
"nestedTransactionAllowed"}
flag defaults to "false", though, as nested transactions will just apply to the
JDBC Connection, not to the TopLink PersistenceManager and its cached objects.
You can manually set the flag to "true" if you want to use nested transactions
for JDBC access code which participates in TopLink transactions (provided that
your JDBC driver supports Savepoints). Note that TopLink itself does not
support nested transactions! Hence, do not expect TopLink access code to
semantically participate in a nested transaction.
Thanks to Slavik Markovich for implementing the initial TopLink support prototype!
setSessionFactory(org.springframework.orm.toplink.SessionFactory)
,
setDataSource(javax.sql.DataSource)
,
LocalSessionFactoryBean
,
SessionFactoryUtils.getSession(org.springframework.orm.toplink.SessionFactory, boolean)
,
SessionFactoryUtils.releaseSession(oracle.toplink.sessions.Session, org.springframework.orm.toplink.SessionFactory)
,
TopLinkTemplate
,
Session.getActiveUnitOfWork()
,
DataSourceUtils.getConnection(javax.sql.DataSource)
,
DataSourceUtils.applyTransactionTimeout(java.sql.Statement, javax.sql.DataSource)
,
DataSourceUtils.releaseConnection(java.sql.Connection, javax.sql.DataSource)
,
JdbcTemplate
,
DataSourceTransactionManager
,
JtaTransactionManager
,
Serialized FormNested Class Summary |
---|
Nested classes/interfaces inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager |
---|
AbstractPlatformTransactionManager.SuspendedResourcesHolder |
Field Summary |
---|
Fields inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager |
---|
logger, SYNCHRONIZATION_ALWAYS, SYNCHRONIZATION_NEVER, SYNCHRONIZATION_ON_ACTUAL_TRANSACTION |
Constructor Summary | |
---|---|
TopLinkTransactionManager()
Create a new TopLinkTransactionManager instance. |
|
TopLinkTransactionManager(SessionFactory sessionFactory)
Create a new TopLinkTransactionManager instance. |
Method Summary | |
---|---|
void |
afterPropertiesSet()
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware). |
protected DataAccessException |
convertTopLinkAccessException(oracle.toplink.exceptions.TopLinkException ex)
Convert the given TopLinkException to an appropriate exception from the org.springframework.dao hierarchy. |
protected void |
doBegin(Object transaction,
TransactionDefinition definition)
Begin a new transaction with semantics according to the given transaction definition. |
protected void |
doCleanupAfterCompletion(Object transaction)
Cleanup resources after transaction completion. |
protected void |
doCommit(DefaultTransactionStatus status)
Perform an actual commit of the given transaction. |
protected Object |
doGetTransaction()
Return a transaction object for the current transaction state. |
protected void |
doResume(Object transaction,
Object suspendedResources)
Resume the resources of the current transaction. |
protected void |
doRollback(DefaultTransactionStatus status)
Perform an actual rollback of the given transaction. |
protected void |
doSetRollbackOnly(DefaultTransactionStatus status)
Set the given transaction rollback-only. |
protected Object |
doSuspend(Object transaction)
Suspend the resources of the current transaction. |
DataSource |
getDataSource()
Return the JDBC DataSource that this instance manages transactions for. |
protected Connection |
getJdbcConnection(oracle.toplink.sessions.Session session)
Extract the underlying JDBC Connection from the given TopLink Session. |
SQLExceptionTranslator |
getJdbcExceptionTranslator()
Return the JDBC exception translator for this transaction manager, if any. |
Object |
getResourceFactory()
Return the resource factory that this transaction manager operates on, e.g. a JDBC DataSource or a JMS ConnectionFactory. |
SessionFactory |
getSessionFactory()
Return the SessionFactory that this instance should manage transactions for. |
protected boolean |
isExistingTransaction(Object transaction)
Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started). |
boolean |
isLazyDatabaseTransaction()
Return whether to lazily start a database transaction within a TopLink transaction. |
void |
setDataSource(DataSource dataSource)
Set the JDBC DataSource that this instance should manage transactions for. |
void |
setJdbcExceptionTranslator(SQLExceptionTranslator jdbcExceptionTranslator)
Set the JDBC exception translator for this transaction manager. |
void |
setLazyDatabaseTransaction(boolean lazyDatabaseTransaction)
Set whether to lazily start a database transaction within a TopLink transaction. |
void |
setSessionFactory(SessionFactory sessionFactory)
Set the the TopLink SessionFactory to manage transactions for. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.springframework.transaction.PlatformTransactionManager |
---|
commit, getTransaction, rollback |
Constructor Detail |
---|
public TopLinkTransactionManager()
public TopLinkTransactionManager(SessionFactory sessionFactory)
sessionFactory
- the TopLink SessionFactory to manage transactions forMethod Detail |
---|
public void setSessionFactory(SessionFactory sessionFactory)
The passed-in SessionFactory will be asked for a plain Session in case of a read-only transaction (where no active UnitOfWork is supposed to be available), and for a managed Session else (with an active UnitOfWork that will be committed by this transaction manager).
public SessionFactory getSessionFactory()
public void setDataSource(DataSource dataSource)
A transactional JDBC Connection for this DataSource will be provided to application code accessing this DataSource directly via DataSourceUtils or JdbcTemplate. The Connection will be taken from the TopLink Session. This will only happen for transactions that are not marked as read-only. TopLink does not support database transactions for pure read-only operations on a Session (that is, without a UnitOfWork).
Note that you need to use a TopLink Session with a DatabaseAccessor to allow for exposing TopLink transactions as JDBC transactions. This is the case of all standard TopLink configurations.
The DataSource specified here should be the target DataSource to manage transactions for, not a TransactionAwareDataSourceProxy. Only data access code may work with TransactionAwareDataSourceProxy, while the transaction manager needs to work on the underlying target DataSource. If there's nevertheless a TransactionAwareDataSourceProxy passed in, it will be unwrapped to extract its target DataSource.
public DataSource getDataSource()
public void setLazyDatabaseTransaction(boolean lazyDatabaseTransaction)
By default, database transactions are started early. This allows for reusing the same JDBC Connection throughout an entire transaction, including read operations, and also for exposing TopLink transactions to JDBC access code (working on the same DataSource).
It is only recommended to switch this flag to "true" when no JDBC access code is involved in any of the transactions, and when it is acceptable to perform read operations outside of the transactional JDBC Connection.
setDataSource(javax.sql.DataSource)
,
UnitOfWork.beginEarlyTransaction()
public boolean isLazyDatabaseTransaction()
public void setJdbcExceptionTranslator(SQLExceptionTranslator jdbcExceptionTranslator)
Applied to any SQLException root cause of a TopLink DatabaseException that is thrown on commit. The default is to rely on TopLink's native exception translation.
jdbcExceptionTranslator
- the exception translatorDatabaseException
,
SQLErrorCodeSQLExceptionTranslator
,
SQLStateSQLExceptionTranslator
,
setDataSource(javax.sql.DataSource)
public SQLExceptionTranslator getJdbcExceptionTranslator()
public void afterPropertiesSet()
InitializingBean
This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.
afterPropertiesSet
in interface InitializingBean
public Object getResourceFactory()
ResourceTransactionManager
This target resource factory is usually used as resource key for
TransactionSynchronizationManager
's resource bindings per thread.
getResourceFactory
in interface ResourceTransactionManager
null
)TransactionSynchronizationManager.bindResource(java.lang.Object, java.lang.Object)
,
TransactionSynchronizationManager.getResource(java.lang.Object)
protected Object doGetTransaction()
AbstractPlatformTransactionManager
The returned object will usually be specific to the concrete transaction manager implementation, carrying corresponding transaction state in a modifiable fashion. This object will be passed into the other template methods (e.g. doBegin and doCommit), either directly or as part of a DefaultTransactionStatus instance.
The returned object should contain information about any existing
transaction, that is, a transaction that has already started before the
current getTransaction
call on the transaction manager.
Consequently, a doGetTransaction
implementation will usually
look for an existing transaction and store corresponding state in the
returned transaction object.
doGetTransaction
in class AbstractPlatformTransactionManager
AbstractPlatformTransactionManager.doBegin(java.lang.Object, org.springframework.transaction.TransactionDefinition)
,
AbstractPlatformTransactionManager.doCommit(org.springframework.transaction.support.DefaultTransactionStatus)
,
AbstractPlatformTransactionManager.doRollback(org.springframework.transaction.support.DefaultTransactionStatus)
,
DefaultTransactionStatus.getTransaction()
protected boolean isExistingTransaction(Object transaction)
AbstractPlatformTransactionManager
The result will be evaluated according to the specified propagation behavior for the new transaction. An existing transaction might get suspended (in case of PROPAGATION_REQUIRES_NEW), or the new transaction might participate in the existing one (in case of PROPAGATION_REQUIRED).
The default implementation returns false
, assuming that
participating in existing transactions is generally not supported.
Subclasses are of course encouraged to provide such support.
isExistingTransaction
in class AbstractPlatformTransactionManager
transaction
- transaction object returned by doGetTransaction
AbstractPlatformTransactionManager.doGetTransaction()
protected void doBegin(Object transaction, TransactionDefinition definition)
AbstractPlatformTransactionManager
This method gets called when the transaction manager has decided to actually start a new transaction. Either there wasn't any transaction before, or the previous transaction has been suspended.
A special scenario is a nested transaction without savepoint: If
useSavepointForNestedTransaction()
returns "false", this method
will be called to start a nested transaction when necessary. In such a context,
there will be an active transaction: The implementation of this method has
to detect this and start an appropriate nested transaction.
doBegin
in class AbstractPlatformTransactionManager
transaction
- transaction object returned by doGetTransaction
definition
- TransactionDefinition instance, describing propagation
behavior, isolation level, read-only flag, timeout, and transaction nameprotected Connection getJdbcConnection(oracle.toplink.sessions.Session session)
Default implementation casts to oracle.toplink.publicinterface.Session
and fetches the Connection from the DatabaseAccessor exposed there.
session
- the current TopLink Session
null
if none foundSession.getAccessor()
,
DatabaseAccessor.getConnection()
protected Object doSuspend(Object transaction)
AbstractPlatformTransactionManager
The default implementation throws a TransactionSuspensionNotSupportedException, assuming that transaction suspension is generally not supported.
doSuspend
in class AbstractPlatformTransactionManager
transaction
- transaction object returned by doGetTransaction
AbstractPlatformTransactionManager.doResume(java.lang.Object, java.lang.Object)
protected void doResume(Object transaction, Object suspendedResources)
AbstractPlatformTransactionManager
The default implementation throws a TransactionSuspensionNotSupportedException, assuming that transaction suspension is generally not supported.
doResume
in class AbstractPlatformTransactionManager
transaction
- transaction object returned by doGetTransaction
suspendedResources
- the object that holds suspended resources,
as returned by doSuspendAbstractPlatformTransactionManager.doSuspend(java.lang.Object)
protected void doCommit(DefaultTransactionStatus status)
AbstractPlatformTransactionManager
An implementation does not need to check the "new transaction" flag or the rollback-only flag; this will already have been handled before. Usually, a straight commit will be performed on the transaction object contained in the passed-in status.
doCommit
in class AbstractPlatformTransactionManager
status
- the status representation of the transactionDefaultTransactionStatus.getTransaction()
protected void doRollback(DefaultTransactionStatus status)
AbstractPlatformTransactionManager
An implementation does not need to check the "new transaction" flag; this will already have been handled before. Usually, a straight rollback will be performed on the transaction object contained in the passed-in status.
doRollback
in class AbstractPlatformTransactionManager
status
- the status representation of the transactionDefaultTransactionStatus.getTransaction()
protected void doSetRollbackOnly(DefaultTransactionStatus status)
AbstractPlatformTransactionManager
The default implementation throws an IllegalTransactionStateException, assuming that participating in existing transactions is generally not supported. Subclasses are of course encouraged to provide such support.
doSetRollbackOnly
in class AbstractPlatformTransactionManager
status
- the status representation of the transactionprotected void doCleanupAfterCompletion(Object transaction)
AbstractPlatformTransactionManager
Called after doCommit
and doRollback
execution,
on any outcome. The default implementation does nothing.
Should not throw any exceptions but just issue warnings on errors.
doCleanupAfterCompletion
in class AbstractPlatformTransactionManager
transaction
- transaction object returned by doGetTransaction
protected DataAccessException convertTopLinkAccessException(oracle.toplink.exceptions.TopLinkException ex)
org.springframework.dao
hierarchy.
Will automatically apply a specified SQLExceptionTranslator to a TopLink DatabaseException, else rely on TopLink's default translation.
ex
- TopLinkException that occured
SessionFactoryUtils.convertTopLinkAccessException(oracle.toplink.exceptions.TopLinkException)
,
setJdbcExceptionTranslator(org.springframework.jdbc.support.SQLExceptionTranslator)
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |