Class JtaTransactionManager
- All Implemented Interfaces:
Serializable
,InitializingBean
,ConfigurableTransactionManager
,TransactionFactory
,PlatformTransactionManager
,TransactionManager
PlatformTransactionManager
implementation
for JTA, delegating to a backend JTA provider. This is typically used to delegate
to a Jakarta EE server's transaction coordinator, but may also be configured with a
local JTA provider which is embedded within the application.
This transaction manager is appropriate for handling distributed transactions, i.e. transactions that span multiple resources, and for controlling transactions on application server resources (e.g. JDBC DataSources available in JNDI) in general. For a single JDBC DataSource, DataSourceTransactionManager is perfectly sufficient, and for accessing a single resource with Hibernate (including transactional cache), HibernateTransactionManager is appropriate, for example.
For typical JTA transactions (REQUIRED, SUPPORTS, MANDATORY, NEVER), a plain JtaTransactionManager definition is all you need, portable across all Jakarta EE servers. This corresponds to the functionality of the JTA UserTransaction, for which Jakarta EE specifies a standard JNDI name ("java:comp/UserTransaction"). There is no need to configure a server-specific TransactionManager lookup for this kind of JTA usage.
Transaction suspension (REQUIRES_NEW, NOT_SUPPORTED) is just available with a JTA TransactionManager being registered. Common TransactionManager locations are autodetected by JtaTransactionManager, provided that the "autodetectTransactionManager" flag is set to "true" (which it is by default).
Note: Support for the JTA TransactionManager interface is not required by Jakarta EE. Almost all Jakarta EE servers expose it, but do so as extension to EE. There might be some issues with compatibility, despite the TransactionManager interface being part of JTA.
This pure JtaTransactionManager class supports timeouts but not per-transaction
isolation levels. Custom subclasses may override the doJtaBegin(org.springframework.transaction.jta.JtaTransactionObject, org.springframework.transaction.TransactionDefinition)
method for
specific JTA extensions in order to provide this functionality. Such adapters for
specific Jakarta EE transaction coordinators may also expose transaction names for
monitoring; with standard JTA, transaction names will simply be ignored.
JTA 1.1 adds the TransactionSynchronizationRegistry facility, as public Jakarta EE API in addition to the standard JTA UserTransaction handle. As of Spring 2.5, this JtaTransactionManager autodetects the TransactionSynchronizationRegistry and uses it for registering Spring-managed synchronizations when participating in an existing JTA transaction (e.g. controlled by EJB CMT). If no TransactionSynchronizationRegistry is available, then such synchronizations will be registered via the (non-EE) JTA TransactionManager handle.
This class is serializable. However, active synchronizations do not survive serialization.
- Since:
- 24.03.2003
- Author:
- Juergen Hoeller
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager
AbstractPlatformTransactionManager.SuspendedResourcesHolder
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Standard Jakarta EE JNDI location for the JTA TransactionSynchronizationRegistry.static final String
Default JNDI location for the JTA UserTransaction.static final String[]
Fallback JNDI locations for the JTA TransactionManager.Fields inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager
logger, SYNCHRONIZATION_ALWAYS, SYNCHRONIZATION_NEVER, SYNCHRONIZATION_ON_ACTUAL_TRANSACTION
-
Constructor Summary
ConstructorDescriptionCreate a new JtaTransactionManager instance, to be configured as bean.JtaTransactionManager
(TransactionManager transactionManager) Create a new JtaTransactionManager instance.JtaTransactionManager
(UserTransaction userTransaction) Create a new JtaTransactionManager instance.JtaTransactionManager
(UserTransaction userTransaction, TransactionManager transactionManager) Create a new JtaTransactionManager instance. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Initialize the UserTransaction as well as the TransactionManager handle.protected void
applyIsolationLevel
(JtaTransactionObject txObject, int isolationLevel) Apply the given transaction isolation level.protected void
applyTimeout
(JtaTransactionObject txObject, int timeout) Apply the given transaction timeout.protected UserTransaction
buildUserTransaction
(TransactionManager transactionManager) Build a UserTransaction handle based on the given TransactionManager.protected void
Check the UserTransaction as well as the TransactionManager handle, assuming standard JTA requirements.createTransaction
(String name, int timeout) Create an active Transaction object based on the given name and timeout.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 JtaTransactionObject
Get a JTA transaction object for the given current UserTransaction.protected Object
This implementation returns a JtaTransactionObject instance for the JTA UserTransaction.protected void
doJtaBegin
(JtaTransactionObject txObject, TransactionDefinition definition) Perform a JTA begin on the JTA UserTransaction or TransactionManager.protected void
doJtaResume
(JtaTransactionObject txObject, Object suspendedTransaction) Perform a JTA resume on the JTA TransactionManager.protected Object
doJtaSuspend
(JtaTransactionObject txObject) Perform a JTA suspend on the JTA TransactionManager.protected void
doRegisterAfterCompletionWithJtaTransaction
(JtaTransactionObject txObject, List<TransactionSynchronization> synchronizations) Register a JTA synchronization on the JTA TransactionManager, for callingafterCompletion
on the given Spring TransactionSynchronizations.protected void
Resume the resources of the current transaction.protected void
doRollback
(DefaultTransactionStatus status) Perform an actual rollback of the given transaction.protected void
Set the given transaction rollback-only.protected Object
Suspend the resources of the current transaction.protected TransactionManager
Find the JTA TransactionManager through autodetection: checking whether the UserTransaction object implements the TransactionManager, and checking the fallback JNDI locations.protected TransactionSynchronizationRegistry
Find the JTA 1.1 TransactionSynchronizationRegistry through autodetection: checking whether the UserTransaction object or TransactionManager object implements it, and checking Jakarta EE's standard JNDI location.protected UserTransaction
Find the JTA UserTransaction through a default JNDI lookup: "java:comp/UserTransaction".Return the JNDI environment to use for JNDI lookups.Return the JndiTemplate used for JNDI lookups.Return the JTA TransactionManager that this transaction manager uses, if any.Return the JTA 1.1 TransactionSynchronizationRegistry that this transaction manager uses, if any.Return the JTA UserTransaction that this transaction manager uses.protected void
Initialize the JTA 1.1 TransactionSynchronizationRegistry, if available.protected void
Initialize the UserTransaction as well as the TransactionManager handle.protected boolean
isExistingTransaction
(Object transaction) Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started).protected TransactionManager
lookupTransactionManager
(String transactionManagerName) Look up the JTA TransactionManager in JNDI via the configured name.protected TransactionSynchronizationRegistry
lookupTransactionSynchronizationRegistry
(String registryName) Look up the JTA 1.1 TransactionSynchronizationRegistry in JNDI via the configured name.protected UserTransaction
lookupUserTransaction
(String userTransactionName) Look up the JTA UserTransaction in JNDI via the configured name.protected void
registerAfterCompletionWithExistingTransaction
(Object transaction, List<TransactionSynchronization> synchronizations) Register the given list of transaction synchronizations with the existing transaction.protected TransactionManager
Allows subclasses to retrieve the JTA TransactionManager in a vendor-specific manner.protected TransactionSynchronizationRegistry
Allows subclasses to retrieve the JTA 1.1 TransactionSynchronizationRegistry in a vendor-specific manner.protected UserTransaction
Allows subclasses to retrieve the JTA UserTransaction in a vendor-specific manner.void
setAllowCustomIsolationLevels
(boolean allowCustomIsolationLevels) Set whether to allow custom isolation levels to be specified.void
setAutodetectTransactionManager
(boolean autodetectTransactionManager) Set whether to autodetect a JTA UserTransaction object that implements the JTA TransactionManager interface too (i.e.void
setAutodetectTransactionSynchronizationRegistry
(boolean autodetectTransactionSynchronizationRegistry) Set whether to autodetect a JTA 1.1 TransactionSynchronizationRegistry object at its default JDNI location ("java:comp/TransactionSynchronizationRegistry") if the UserTransaction has also been obtained from JNDI, and also whether to fall back to checking whether the JTA UserTransaction/TransactionManager object implements the JTA TransactionSynchronizationRegistry interface too.void
setAutodetectUserTransaction
(boolean autodetectUserTransaction) Set whether to autodetect the JTA UserTransaction at its default JNDI location "java:comp/UserTransaction", as specified by Jakarta EE.void
setCacheUserTransaction
(boolean cacheUserTransaction) Set whether to cache the JTA UserTransaction object fetched from JNDI.void
setJndiEnvironment
(Properties jndiEnvironment) Set the JNDI environment to use for JNDI lookups.void
setJndiTemplate
(JndiTemplate jndiTemplate) Set the JndiTemplate to use for JNDI lookups.void
setTransactionManager
(TransactionManager transactionManager) Set the JTA TransactionManager to use as direct reference.void
setTransactionManagerName
(String transactionManagerName) Set the JNDI name of the JTA TransactionManager.void
setTransactionSynchronizationRegistry
(TransactionSynchronizationRegistry transactionSynchronizationRegistry) Set the JTA 1.1 TransactionSynchronizationRegistry to use as direct reference.void
setTransactionSynchronizationRegistryName
(String transactionSynchronizationRegistryName) Set the JNDI name of the JTA 1.1 TransactionSynchronizationRegistry.void
setUserTransaction
(UserTransaction userTransaction) Set the JTA UserTransaction to use as direct reference.void
setUserTransactionName
(String userTransactionName) Set the JNDI name of the JTA UserTransaction.protected boolean
This implementation returns "true": a JTA commit will properly handle transactions that have been marked rollback-only at a global level.boolean
Determine whether the underlying transaction manager supports XA transactions managed by a resource adapter (i.e.protected boolean
This implementation returns false to cause a further invocation of doBegin despite an already existing transaction.Methods inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager
commit, determineTimeout, getDefaultTimeout, getTransaction, getTransactionExecutionListeners, getTransactionSynchronization, invokeAfterCompletion, isFailEarlyOnGlobalRollbackOnly, isGlobalRollbackOnParticipationFailure, isNestedTransactionAllowed, isRollbackOnCommitFailure, isValidateExistingTransaction, prepareForCommit, resume, rollback, setDefaultTimeout, setFailEarlyOnGlobalRollbackOnly, setGlobalRollbackOnParticipationFailure, setNestedTransactionAllowed, setRollbackOnCommitFailure, setTransactionExecutionListeners, setTransactionSynchronization, setTransactionSynchronizationName, setValidateExistingTransaction, suspend, triggerBeforeCommit, triggerBeforeCompletion
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.ConfigurableTransactionManager
addListener
-
Field Details
-
DEFAULT_USER_TRANSACTION_NAME
Default JNDI location for the JTA UserTransaction. Many Jakarta EE servers also provide support for the JTA TransactionManager interface there. -
FALLBACK_TRANSACTION_MANAGER_NAMES
Fallback JNDI locations for the JTA TransactionManager. Applied if the JTA UserTransaction does not implement the JTA TransactionManager interface, provided that the "autodetectTransactionManager" flag is "true". -
DEFAULT_TRANSACTION_SYNCHRONIZATION_REGISTRY_NAME
Standard Jakarta EE JNDI location for the JTA TransactionSynchronizationRegistry. Autodetected when available.- See Also:
-
-
Constructor Details
-
JtaTransactionManager
public JtaTransactionManager()Create a new JtaTransactionManager instance, to be configured as bean. InvokeafterPropertiesSet
to activate the configuration. -
JtaTransactionManager
Create a new JtaTransactionManager instance.- Parameters:
userTransaction
- the JTA UserTransaction to use as direct reference
-
JtaTransactionManager
public JtaTransactionManager(UserTransaction userTransaction, TransactionManager transactionManager) Create a new JtaTransactionManager instance.- Parameters:
userTransaction
- the JTA UserTransaction to use as direct referencetransactionManager
- the JTA TransactionManager to use as direct reference
-
JtaTransactionManager
Create a new JtaTransactionManager instance.- Parameters:
transactionManager
- the JTA TransactionManager to use as direct reference
-
-
Method Details
-
setJndiTemplate
Set the JndiTemplate to use for JNDI lookups. A default one is used if not set. -
getJndiTemplate
Return the JndiTemplate used for JNDI lookups. -
setJndiEnvironment
Set the JNDI environment to use for JNDI lookups. Creates a JndiTemplate with the given environment settings. -
getJndiEnvironment
Return the JNDI environment to use for JNDI lookups. -
setUserTransaction
Set the JTA UserTransaction to use as direct reference.Typically just used for local JTA setups; in a Jakarta EE environment, the UserTransaction will always be fetched from JNDI.
-
getUserTransaction
Return the JTA UserTransaction that this transaction manager uses. -
setUserTransactionName
Set the JNDI name of the JTA UserTransaction.Note that the UserTransaction will be autodetected at the Jakarta EE default location "java:comp/UserTransaction" if not specified explicitly.
-
setAutodetectUserTransaction
public void setAutodetectUserTransaction(boolean autodetectUserTransaction) Set whether to autodetect the JTA UserTransaction at its default JNDI location "java:comp/UserTransaction", as specified by Jakarta EE. Will proceed without UserTransaction if none found.Default is "true", autodetecting the UserTransaction unless it has been specified explicitly. Turn this flag off to allow for JtaTransactionManager operating against the TransactionManager only, despite a default UserTransaction being available.
- See Also:
-
setCacheUserTransaction
public void setCacheUserTransaction(boolean cacheUserTransaction) Set whether to cache the JTA UserTransaction object fetched from JNDI.Default is "true": UserTransaction lookup will only happen at startup, reusing the same UserTransaction handle for all transactions of all threads. This is the most efficient choice for all application servers that provide a shared UserTransaction object (the typical case).
Turn this flag off to enforce a fresh lookup of the UserTransaction for every transaction. This is only necessary for application servers that return a new UserTransaction for every transaction, keeping state tied to the UserTransaction object itself rather than the current thread.
- See Also:
-
setTransactionManager
Set the JTA TransactionManager to use as direct reference.A TransactionManager is necessary for suspending and resuming transactions, as this not supported by the UserTransaction interface.
Note that the TransactionManager will be autodetected if the JTA UserTransaction object implements the JTA TransactionManager interface too, as well as autodetected at various well-known fallback JNDI locations.
-
getTransactionManager
Return the JTA TransactionManager that this transaction manager uses, if any. -
setTransactionManagerName
Set the JNDI name of the JTA TransactionManager.A TransactionManager is necessary for suspending and resuming transactions, as this not supported by the UserTransaction interface.
Note that the TransactionManager will be autodetected if the JTA UserTransaction object implements the JTA TransactionManager interface too, as well as autodetected at various well-known fallback JNDI locations.
-
setAutodetectTransactionManager
public void setAutodetectTransactionManager(boolean autodetectTransactionManager) Set whether to autodetect a JTA UserTransaction object that implements the JTA TransactionManager interface too (i.e. the JNDI location for the TransactionManager is "java:comp/UserTransaction", same as for the UserTransaction). Also checks the fallback JNDI locations "java:comp/TransactionManager" and "java:/TransactionManager". Will proceed without TransactionManager if none found.Default is "true", autodetecting the TransactionManager unless it has been specified explicitly. Can be turned off to deliberately ignore an available TransactionManager, for example when there are known issues with suspend/resume and any attempt to use REQUIRES_NEW or NOT_SUPPORTED should fail fast.
- See Also:
-
setTransactionSynchronizationRegistry
public void setTransactionSynchronizationRegistry(@Nullable TransactionSynchronizationRegistry transactionSynchronizationRegistry) Set the JTA 1.1 TransactionSynchronizationRegistry to use as direct reference.A TransactionSynchronizationRegistry allows for interposed registration of transaction synchronizations, as an alternative to the regular registration methods on the JTA TransactionManager API. Also, it is an official part of the Jakarta EE platform, in contrast to the JTA TransactionManager itself.
Note that the TransactionSynchronizationRegistry will be autodetected in JNDI and also from the UserTransaction/TransactionManager object if implemented there as well.
-
getTransactionSynchronizationRegistry
Return the JTA 1.1 TransactionSynchronizationRegistry that this transaction manager uses, if any. -
setTransactionSynchronizationRegistryName
public void setTransactionSynchronizationRegistryName(String transactionSynchronizationRegistryName) Set the JNDI name of the JTA 1.1 TransactionSynchronizationRegistry.Note that the TransactionSynchronizationRegistry will be autodetected at the Jakarta EE default location "java:comp/TransactionSynchronizationRegistry" if not specified explicitly.
-
setAutodetectTransactionSynchronizationRegistry
public void setAutodetectTransactionSynchronizationRegistry(boolean autodetectTransactionSynchronizationRegistry) Set whether to autodetect a JTA 1.1 TransactionSynchronizationRegistry object at its default JDNI location ("java:comp/TransactionSynchronizationRegistry") if the UserTransaction has also been obtained from JNDI, and also whether to fall back to checking whether the JTA UserTransaction/TransactionManager object implements the JTA TransactionSynchronizationRegistry interface too.Default is "true", autodetecting the TransactionSynchronizationRegistry unless it has been specified explicitly. Can be turned off to delegate synchronization registration to the regular JTA TransactionManager API.
-
setAllowCustomIsolationLevels
public void setAllowCustomIsolationLevels(boolean allowCustomIsolationLevels) Set whether to allow custom isolation levels to be specified.Default is "false", throwing an exception if a non-default isolation level is specified for a transaction. Turn this flag on if affected resource adapters check the thread-bound transaction context and apply the specified isolation levels individually (e.g. through an IsolationLevelDataSourceAdapter).
-
afterPropertiesSet
Initialize the UserTransaction as well as the TransactionManager handle.- Specified by:
afterPropertiesSet
in interfaceInitializingBean
- Throws:
TransactionSystemException
- See Also:
-
initUserTransactionAndTransactionManager
Initialize the UserTransaction as well as the TransactionManager handle.- Throws:
TransactionSystemException
- if initialization failed
-
checkUserTransactionAndTransactionManager
Check the UserTransaction as well as the TransactionManager handle, assuming standard JTA requirements.- Throws:
IllegalStateException
- if no sufficient handles are available
-
initTransactionSynchronizationRegistry
protected void initTransactionSynchronizationRegistry()Initialize the JTA 1.1 TransactionSynchronizationRegistry, if available.To be called after
initUserTransactionAndTransactionManager()
, since it may check the UserTransaction and TransactionManager handles.- Throws:
TransactionSystemException
- if initialization failed
-
buildUserTransaction
Build a UserTransaction handle based on the given TransactionManager.- Parameters:
transactionManager
- the TransactionManager- Returns:
- a corresponding UserTransaction handle
-
lookupUserTransaction
protected UserTransaction lookupUserTransaction(String userTransactionName) throws TransactionSystemException Look up the JTA UserTransaction in JNDI via the configured name.Called by
afterPropertiesSet
if no direct UserTransaction reference was set. Can be overridden in subclasses to provide a different UserTransaction object.- Parameters:
userTransactionName
- the JNDI name of the UserTransaction- Returns:
- the UserTransaction object
- Throws:
TransactionSystemException
- if the JNDI lookup failed- See Also:
-
lookupTransactionManager
protected TransactionManager lookupTransactionManager(String transactionManagerName) throws TransactionSystemException Look up the JTA TransactionManager in JNDI via the configured name.Called by
afterPropertiesSet
if no direct TransactionManager reference was set. Can be overridden in subclasses to provide a different TransactionManager object.- Parameters:
transactionManagerName
- the JNDI name of the TransactionManager- Returns:
- the UserTransaction object
- Throws:
TransactionSystemException
- if the JNDI lookup failed- See Also:
-
lookupTransactionSynchronizationRegistry
protected TransactionSynchronizationRegistry lookupTransactionSynchronizationRegistry(String registryName) throws TransactionSystemException Look up the JTA 1.1 TransactionSynchronizationRegistry in JNDI via the configured name.Can be overridden in subclasses to provide a different TransactionManager object.
- Parameters:
registryName
- the JNDI name of the TransactionSynchronizationRegistry- Returns:
- the TransactionSynchronizationRegistry object
- Throws:
TransactionSystemException
- if the JNDI lookup failed- See Also:
-
retrieveUserTransaction
Allows subclasses to retrieve the JTA UserTransaction in a vendor-specific manner. Only called if no "userTransaction" or "userTransactionName" specified.The default implementation simply returns
null
.- Returns:
- the JTA UserTransaction handle to use, or
null
if none found - Throws:
TransactionSystemException
- in case of errors- See Also:
-
retrieveTransactionManager
@Nullable protected TransactionManager retrieveTransactionManager() throws TransactionSystemExceptionAllows subclasses to retrieve the JTA TransactionManager in a vendor-specific manner. Only called if no "transactionManager" or "transactionManagerName" specified.The default implementation simply returns
null
.- Returns:
- the JTA TransactionManager handle to use, or
null
if none found - Throws:
TransactionSystemException
- in case of errors- See Also:
-
retrieveTransactionSynchronizationRegistry
@Nullable protected TransactionSynchronizationRegistry retrieveTransactionSynchronizationRegistry() throws TransactionSystemExceptionAllows subclasses to retrieve the JTA 1.1 TransactionSynchronizationRegistry in a vendor-specific manner.The default implementation simply returns
null
.- Returns:
- the JTA TransactionSynchronizationRegistry handle to use,
or
null
if none found - Throws:
TransactionSystemException
- in case of errors
-
findUserTransaction
Find the JTA UserTransaction through a default JNDI lookup: "java:comp/UserTransaction".- Returns:
- the JTA UserTransaction reference, or
null
if not found - See Also:
-
findTransactionManager
Find the JTA TransactionManager through autodetection: checking whether the UserTransaction object implements the TransactionManager, and checking the fallback JNDI locations.- Parameters:
ut
- the JTA UserTransaction object- Returns:
- the JTA TransactionManager reference, or
null
if not found - See Also:
-
findTransactionSynchronizationRegistry
@Nullable protected TransactionSynchronizationRegistry findTransactionSynchronizationRegistry(@Nullable UserTransaction ut, @Nullable TransactionManager tm) throws TransactionSystemException Find the JTA 1.1 TransactionSynchronizationRegistry through autodetection: checking whether the UserTransaction object or TransactionManager object implements it, and checking Jakarta EE's standard JNDI location.The default implementation simply returns
null
.- Parameters:
ut
- the JTA UserTransaction objecttm
- the JTA TransactionManager object- Returns:
- the JTA TransactionSynchronizationRegistry handle to use,
or
null
if none found - Throws:
TransactionSystemException
- in case of errors
-
doGetTransaction
This implementation returns a JtaTransactionObject instance for the JTA UserTransaction.The UserTransaction object will either be looked up freshly for the current transaction, or the cached one looked up at startup will be used. The latter is the default: Most application servers use a shared singleton UserTransaction that can be cached. Turn off the "cacheUserTransaction" flag to enforce a fresh lookup for every transaction.
- Specified by:
doGetTransaction
in classAbstractPlatformTransactionManager
- Returns:
- the current transaction object
- See Also:
-
doGetJtaTransaction
Get a JTA transaction object for the given current UserTransaction.Subclasses can override this to provide a JtaTransactionObject subclass, for example holding some additional JTA handle needed.
- Parameters:
ut
- the UserTransaction handle to use for the current transaction- Returns:
- the JtaTransactionObject holding the UserTransaction
-
isExistingTransaction
Description copied from class:AbstractPlatformTransactionManager
Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started).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.- Overrides:
isExistingTransaction
in classAbstractPlatformTransactionManager
- Parameters:
transaction
- the transaction object returned by doGetTransaction- Returns:
- if there is an existing transaction
- See Also:
-
useSavepointForNestedTransaction
protected boolean useSavepointForNestedTransaction()This implementation returns false to cause a further invocation of doBegin despite an already existing transaction.JTA implementations might support nested transactions via further
UserTransaction.begin()
invocations, but never support savepoints. -
doBegin
Description copied from class:AbstractPlatformTransactionManager
Begin a new transaction with semantics according to the given transaction definition. Does not have to care about applying the propagation behavior, as this has already been handled by this abstract manager.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.- Specified by:
doBegin
in classAbstractPlatformTransactionManager
- Parameters:
transaction
- the transaction object returned bydoGetTransaction
definition
- a TransactionDefinition instance, describing propagation behavior, isolation level, read-only flag, timeout, and transaction name
-
doJtaBegin
protected void doJtaBegin(JtaTransactionObject txObject, TransactionDefinition definition) throws NotSupportedException, SystemException Perform a JTA begin on the JTA UserTransaction or TransactionManager.This implementation only supports standard JTA functionality: that is, no per-transaction isolation levels and no transaction names. Can be overridden in subclasses, for specific JTA implementations.
Calls
applyIsolationLevel
andapplyTimeout
before invoking the UserTransaction'sbegin
method.- Parameters:
txObject
- the JtaTransactionObject containing the UserTransactiondefinition
- the TransactionDefinition instance, describing propagation behavior, isolation level, read-only flag, timeout, and transaction name- Throws:
NotSupportedException
- if thrown by JTA methodsSystemException
- if thrown by JTA methods- See Also:
-
getUserTransaction()
getTransactionManager()
applyIsolationLevel(org.springframework.transaction.jta.JtaTransactionObject, int)
applyTimeout(org.springframework.transaction.jta.JtaTransactionObject, int)
JtaTransactionObject.getUserTransaction()
UserTransaction.setTransactionTimeout(int)
UserTransaction.begin()
-
applyIsolationLevel
protected void applyIsolationLevel(JtaTransactionObject txObject, int isolationLevel) throws InvalidIsolationLevelException, SystemException Apply the given transaction isolation level. The default implementation will throw an exception for any level other than ISOLATION_DEFAULT.To be overridden in subclasses for specific JTA implementations, as alternative to overriding the full
doJtaBegin(org.springframework.transaction.jta.JtaTransactionObject, org.springframework.transaction.TransactionDefinition)
method.- Parameters:
txObject
- the JtaTransactionObject containing the UserTransactionisolationLevel
- isolation level taken from transaction definition- Throws:
InvalidIsolationLevelException
- if the given isolation level cannot be appliedSystemException
- if thrown by the JTA implementation- See Also:
-
applyTimeout
Apply the given transaction timeout. The default implementation will callUserTransaction.setTransactionTimeout
for a non-default timeout value.- Parameters:
txObject
- the JtaTransactionObject containing the UserTransactiontimeout
- the timeout value taken from transaction definition- Throws:
SystemException
- if thrown by the JTA implementation- See Also:
-
doSuspend
Description copied from class:AbstractPlatformTransactionManager
Suspend the resources of the current transaction. Transaction synchronization will already have been suspended.The default implementation throws a TransactionSuspensionNotSupportedException, assuming that transaction suspension is generally not supported.
- Overrides:
doSuspend
in classAbstractPlatformTransactionManager
- Parameters:
transaction
- the transaction object returned bydoGetTransaction
- Returns:
- an object that holds suspended resources (will be kept unexamined for passing it into doResume)
- See Also:
-
doJtaSuspend
Perform a JTA suspend on the JTA TransactionManager.Can be overridden in subclasses, for specific JTA implementations.
- Parameters:
txObject
- the JtaTransactionObject containing the UserTransaction- Returns:
- the suspended JTA Transaction object
- Throws:
SystemException
- if thrown by JTA methods- See Also:
-
doResume
Description copied from class:AbstractPlatformTransactionManager
Resume the resources of the current transaction. Transaction synchronization will be resumed afterwards.The default implementation throws a TransactionSuspensionNotSupportedException, assuming that transaction suspension is generally not supported.
- Overrides:
doResume
in classAbstractPlatformTransactionManager
- Parameters:
transaction
- the transaction object returned bydoGetTransaction
suspendedResources
- the object that holds suspended resources, as returned by doSuspend- See Also:
-
doJtaResume
protected void doJtaResume(@Nullable JtaTransactionObject txObject, Object suspendedTransaction) throws InvalidTransactionException, SystemException Perform a JTA resume on the JTA TransactionManager.Can be overridden in subclasses, for specific JTA implementations.
- Parameters:
txObject
- the JtaTransactionObject containing the UserTransactionsuspendedTransaction
- the suspended JTA Transaction object- Throws:
InvalidTransactionException
- if thrown by JTA methodsSystemException
- if thrown by JTA methods- See Also:
-
shouldCommitOnGlobalRollbackOnly
protected boolean shouldCommitOnGlobalRollbackOnly()This implementation returns "true": a JTA commit will properly handle transactions that have been marked rollback-only at a global level.- Overrides:
shouldCommitOnGlobalRollbackOnly
in classAbstractPlatformTransactionManager
- See Also:
-
AbstractPlatformTransactionManager.doCommit(org.springframework.transaction.support.DefaultTransactionStatus)
DefaultTransactionStatus.isGlobalRollbackOnly()
AbstractTransactionStatus.isLocalRollbackOnly()
TransactionExecution.setRollbackOnly()
UnexpectedRollbackException
UserTransaction.commit()
RollbackException
-
doCommit
Description copied from class:AbstractPlatformTransactionManager
Perform an actual commit of the given transaction.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.
- Specified by:
doCommit
in classAbstractPlatformTransactionManager
- Parameters:
status
- the status representation of the transaction- See Also:
-
doRollback
Description copied from class:AbstractPlatformTransactionManager
Perform an actual rollback of the given transaction.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.
- Specified by:
doRollback
in classAbstractPlatformTransactionManager
- Parameters:
status
- the status representation of the transaction- See Also:
-
doSetRollbackOnly
Description copied from class:AbstractPlatformTransactionManager
Set the given transaction rollback-only. Only called on rollback if the current transaction participates in an existing one.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.
- Overrides:
doSetRollbackOnly
in classAbstractPlatformTransactionManager
- Parameters:
status
- the status representation of the transaction
-
registerAfterCompletionWithExistingTransaction
protected void registerAfterCompletionWithExistingTransaction(Object transaction, List<TransactionSynchronization> synchronizations) Description copied from class:AbstractPlatformTransactionManager
Register the given list of transaction synchronizations with the existing transaction.Invoked when the control of the Spring transaction manager and thus all Spring transaction synchronizations end, without the transaction being completed yet. This is for example the case when participating in an existing JTA or EJB CMT transaction.
The default implementation simply invokes the
afterCompletion
methods immediately, passing in "STATUS_UNKNOWN". This is the best we can do if there's no chance to determine the actual outcome of the outer transaction.- Overrides:
registerAfterCompletionWithExistingTransaction
in classAbstractPlatformTransactionManager
- Parameters:
transaction
- the transaction object returned bydoGetTransaction
synchronizations
- a List of TransactionSynchronization objects- See Also:
-
doRegisterAfterCompletionWithJtaTransaction
protected void doRegisterAfterCompletionWithJtaTransaction(JtaTransactionObject txObject, List<TransactionSynchronization> synchronizations) throws RollbackException, SystemException Register a JTA synchronization on the JTA TransactionManager, for callingafterCompletion
on the given Spring TransactionSynchronizations.The default implementation registers the synchronizations on the JTA 1.1 TransactionSynchronizationRegistry, if available, or on the JTA TransactionManager's current Transaction - again, if available. If none of the two is available, a warning will be logged.
Can be overridden in subclasses, for specific JTA implementations.
- Parameters:
txObject
- the current transaction objectsynchronizations
- a List of TransactionSynchronization objects- Throws:
RollbackException
- if thrown by JTA methodsSystemException
- if thrown by JTA methods- See Also:
-
doCleanupAfterCompletion
Description copied from class:AbstractPlatformTransactionManager
Cleanup resources after transaction completion.Called after
doCommit
anddoRollback
execution, on any outcome. The default implementation does nothing.Should not throw any exceptions but just issue warnings on errors.
- Overrides:
doCleanupAfterCompletion
in classAbstractPlatformTransactionManager
- Parameters:
transaction
- the transaction object returned bydoGetTransaction
-
createTransaction
public Transaction createTransaction(@Nullable String name, int timeout) throws NotSupportedException, SystemException Description copied from interface:TransactionFactory
Create an active Transaction object based on the given name and timeout.- Specified by:
createTransaction
in interfaceTransactionFactory
- Parameters:
name
- the transaction name (may benull
)timeout
- the transaction timeout (may be -1 for the default timeout)- Returns:
- the active Transaction object (never
null
) - Throws:
NotSupportedException
- if the transaction manager does not support a transaction of the specified typeSystemException
- if the transaction manager failed to create the transaction
-
supportsResourceAdapterManagedTransactions
public boolean supportsResourceAdapterManagedTransactions()Description copied from interface:TransactionFactory
Determine whether the underlying transaction manager supports XA transactions managed by a resource adapter (i.e. without explicit XA resource enlistment).Typically
false
. Checked byAbstractMessageEndpointFactory
in order to differentiate between invalid configuration and valid ResourceAdapter-managed transactions.
-