WebSphereUowTransactionManager

Class Overview

WebSphere-specific PlatformTransactionManager implementation that delegates to a com.ibm.wsspi.uow.UOWManager instance, obtained from WebSphere's JNDI environment. This allows Spring to leverage the full power of the WebSphere transaction coordinator, including transaction suspension, in a manner that is perfectly compliant with officially supported WebSphere API.

The CallbackPreferringPlatformTransactionManager interface implemented by this class indicates that callers should preferably pass in a TransactionCallback through the execute(TransactionDefinition, TransactionCallback) method, which will be handled through the callback-based WebSphere UOWManager API instead of through standard JTA API (UserTransaction / TransactionManager). This avoids the use of the non-public javax.transaction.TransactionManager API on WebSphere, staying within supported WebSphere API boundaries.

This transaction manager implementation derives from Spring's standard JtaTransactionManager, inheriting the capability to support programmatic transaction demarcation via getTransaction / commit / rollback calls through a JTA UserTransaction handle, for callers that do not use the TransactionCallback-based execute(TransactionDefinition, TransactionCallback) method. However, transaction suspension is not supported in this getTransaction style (unless you explicitly specify a setTransactionManager(TransactionManager) reference, despite the official WebSphere recommendations). Use the execute(TransactionDefinition, TransactionCallback) style for any code that might require transaction suspension.

This transaction manager is compatible with WebSphere 6.1.0.9 and above. The default JNDI location for the UOWManager is "java:comp/websphere/UOWManager". If the location happens to differ according to your WebSphere documentation, simply specify the actual location through this transaction manager's "uowManagerName" bean property.

Summary

[Expand] Inherited Constants
From class org.springframework.transaction.jta.JtaTransactionManager String DEFAULT_TRANSACTION_SYNCHRONIZATION_REGISTRY_NAME Standard Java EE 5 JNDI location for the JTA TransactionSynchronizationRegistry. String DEFAULT_USER_TRANSACTION_NAME Default JNDI location for the JTA UserTransaction.
From class org.springframework.transaction.support.AbstractPlatformTransactionManager int SYNCHRONIZATION_ALWAYS Always activate transaction synchronization, even for "empty" transactions that result from PROPAGATION_SUPPORTS with no existing backend transaction. int SYNCHRONIZATION_NEVER Never active transaction synchronization, not even for actual transactions. int SYNCHRONIZATION_ON_ACTUAL_TRANSACTION Activate transaction synchronization only for actual transactions, that is, not for empty ones that result from PROPAGATION_SUPPORTS with no existing backend transaction.

[Expand] Inherited Fields
From class org.springframework.transaction.jta.JtaTransactionManager public static final String[] FALLBACK_TRANSACTION_MANAGER_NAMES Fallback JNDI locations for the JTA TransactionManager.
From class org.springframework.transaction.support.AbstractPlatformTransactionManager protected Log logger

[Expand] Inherited Methods
From class org.springframework.transaction.jta.JtaTransactionManager void afterPropertiesSet() Initialize the UserTransaction as well as the TransactionManager handle. void applyIsolationLevel(JtaTransactionObject txObject, int isolationLevel) Apply the given transaction isolation level. void applyTimeout(JtaTransactionObject txObject, int timeout) Apply the given transaction timeout. UserTransaction buildUserTransaction(TransactionManager transactionManager) Build a UserTransaction handle based on the given TransactionManager. void checkUserTransactionAndTransactionManager() Check the UserTransaction as well as the TransactionManager handle, assuming standard JTA requirements. Transaction createTransaction(String name, int timeout) Create an active Transaction object based on the given name and timeout. void doBegin(Object transaction, TransactionDefinition definition) Begin a new transaction with semantics according to the given transaction definition. void doCommit(DefaultTransactionStatus status) Perform an actual commit of the given transaction. JtaTransactionObject doGetJtaTransaction(UserTransaction ut) Get a JTA transaction object for the given current UserTransaction. Object doGetTransaction() This implementation returns a JtaTransactionObject instance for the JTA UserTransaction. void doJtaBegin(JtaTransactionObject txObject, TransactionDefinition definition) Perform a JTA begin on the JTA UserTransaction or TransactionManager. void doJtaResume(JtaTransactionObject txObject, Object suspendedTransaction) Perform a JTA resume on the JTA TransactionManager. Object doJtaSuspend(JtaTransactionObject txObject) Perform a JTA suspend on the JTA TransactionManager. void doRegisterAfterCompletionWithJtaTransaction(JtaTransactionObject txObject, List<TransactionSynchronization> synchronizations) Register a JTA synchronization on the JTA TransactionManager, for calling afterCompletion on the given Spring TransactionSynchronizations. void doResume(Object transaction, Object suspendedResources) Resume the resources of the current transaction. void doRollback(DefaultTransactionStatus status) Perform an actual rollback of the given transaction. void doSetRollbackOnly(DefaultTransactionStatus status) Set the given transaction rollback-only. Object doSuspend(Object transaction) Suspend the resources of the current transaction. TransactionManager findTransactionManager(UserTransaction ut) Find the JTA TransactionManager through autodetection: checking whether the UserTransaction object implements the TransactionManager, and checking the fallback JNDI locations. Object findTransactionSynchronizationRegistry(UserTransaction ut, TransactionManager tm) Find the JTA 1.1 TransactionSynchronizationRegistry through autodetection: checking whether the UserTransaction object or TransactionManager object implements it, and checking Java EE 5's standard JNDI location. UserTransaction findUserTransaction() Find the JTA UserTransaction through a default JNDI lookup: "java:comp/UserTransaction". Properties getJndiEnvironment() Return the JNDI environment to use for JNDI lookups. JndiTemplate getJndiTemplate() Return the JndiTemplate used for JNDI lookups. TransactionManager getTransactionManager() Return the JTA TransactionManager that this transaction manager uses. UserTransaction getUserTransaction() Return the JTA UserTransaction that this transaction manager uses. void initTransactionSynchronizationRegistry() Initialize the JTA 1.1 TransactionSynchronizationRegistry, if available. void initUserTransactionAndTransactionManager() Initialize the UserTransaction as well as the TransactionManager handle. boolean isExistingTransaction(Object transaction) Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started). TransactionManager lookupTransactionManager(String transactionManagerName) Look up the JTA TransactionManager in JNDI via the configured name. Object lookupTransactionSynchronizationRegistry(String registryName) Look up the JTA 1.1 TransactionSynchronizationRegistry in JNDI via the configured name. UserTransaction lookupUserTransaction(String userTransactionName) Look up the JTA UserTransaction in JNDI via the configured name. void registerAfterCompletionWithExistingTransaction(Object transaction, List<TransactionSynchronization> synchronizations) Register the given list of transaction synchronizations with the existing transaction. TransactionManager retrieveTransactionManager() Allows subclasses to retrieve the JTA TransactionManager in a vendor-specific manner. Object retrieveTransactionSynchronizationRegistry() Allows subclasses to retrieve the JTA 1.1 TransactionSynchronizationRegistry in a vendor-specific manner. UserTransaction retrieveUserTransaction() 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 setAutodetectUserTransaction(boolean autodetectUserTransaction) Set whether to autodetect the JTA UserTransaction at its default JNDI location "java:comp/UserTransaction", as specified by Java 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 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. boolean shouldCommitOnGlobalRollbackOnly() This implementation returns "true": a JTA commit will properly handle transactions that have been marked rollback-only at a global level. boolean supportsResourceAdapterManagedTransactions() Determine whether the underlying transaction manager supports XA transactions managed by a resource adapter (i.e. boolean useSavepointForNestedTransaction() This implementation returns false to cause a further invocation of doBegin despite an already existing transaction.
From class org.springframework.transaction.support.AbstractPlatformTransactionManager final void commit(TransactionStatus status) This implementation of commit handles participating in existing transactions and programmatic rollback requests. int determineTimeout(TransactionDefinition definition) Determine the actual timeout to use for the given definition. abstract void doBegin(Object transaction, TransactionDefinition definition) Begin a new transaction with semantics according to the given transaction definition. void doCleanupAfterCompletion(Object transaction) Cleanup resources after transaction completion. abstract void doCommit(DefaultTransactionStatus status) Perform an actual commit of the given transaction. abstract Object doGetTransaction() Return a transaction object for the current transaction state. void doResume(Object transaction, Object suspendedResources) Resume the resources of the current transaction. abstract void doRollback(DefaultTransactionStatus status) Perform an actual rollback of the given transaction. void doSetRollbackOnly(DefaultTransactionStatus status) Set the given transaction rollback-only. Object doSuspend(Object transaction) Suspend the resources of the current transaction. final int getDefaultTimeout() Return the default timeout that this transaction manager should apply if there is no timeout specified at the transaction level, in seconds. final TransactionStatus getTransaction(TransactionDefinition definition) This implementation handles propagation behavior. final int getTransactionSynchronization() Return if this transaction manager should activate the thread-bound transaction synchronization support. final void invokeAfterCompletion(List<TransactionSynchronization> synchronizations, int completionStatus) Actually invoke the afterCompletion methods of the given Spring TransactionSynchronization objects. boolean isExistingTransaction(Object transaction) Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started). final boolean isFailEarlyOnGlobalRollbackOnly() Return whether to fail early in case of the transaction being globally marked as rollback-only. final boolean isGlobalRollbackOnParticipationFailure() Return whether to globally mark an existing transaction as rollback-only after a participating transaction failed. final boolean isNestedTransactionAllowed() Return whether nested transactions are allowed. final boolean isRollbackOnCommitFailure() Return whether doRollback should be performed on failure of the doCommit call. final boolean isValidateExistingTransaction() Return whether existing transactions should be validated before participating in them. DefaultTransactionStatus newTransactionStatus(TransactionDefinition definition, Object transaction, boolean newTransaction, boolean newSynchronization, boolean debug, Object suspendedResources) Create a rae TransactionStatus instance for the given arguments. void prepareForCommit(DefaultTransactionStatus status) Make preparations for commit, to be performed before the beforeCommit synchronization callbacks occur. void prepareSynchronization(DefaultTransactionStatus status, TransactionDefinition definition) Initialize transaction synchronization as appropriate. final DefaultTransactionStatus prepareTransactionStatus(TransactionDefinition definition, Object transaction, boolean newTransaction, boolean newSynchronization, boolean debug, Object suspendedResources) Create a new TransactionStatus for the given arguments, also initializing transaction synchronization as appropriate. void registerAfterCompletionWithExistingTransaction(Object transaction, List<TransactionSynchronization> synchronizations) Register the given list of transaction synchronizations with the existing transaction. final void resume(Object transaction, AbstractPlatformTransactionManager.SuspendedResourcesHolder resourcesHolder) Resume the given transaction. final void rollback(TransactionStatus status) This implementation of rollback handles participating in existing transactions. final void setDefaultTimeout(int defaultTimeout) Specify the default timeout that this transaction manager should apply if there is no timeout specified at the transaction level, in seconds. final void setFailEarlyOnGlobalRollbackOnly(boolean failEarlyOnGlobalRollbackOnly) Set whether to fail early in case of the transaction being globally marked as rollback-only. final void setGlobalRollbackOnParticipationFailure(boolean globalRollbackOnParticipationFailure) Set whether to globally mark an existing transaction as rollback-only after a participating transaction failed. final void setNestedTransactionAllowed(boolean nestedTransactionAllowed) Set whether nested transactions are allowed. final void setRollbackOnCommitFailure(boolean rollbackOnCommitFailure) Set whether doRollback should be performed on failure of the doCommit call. final void setTransactionSynchronization(int transactionSynchronization) Set when this transaction manager should activate the thread-bound transaction synchronization support. final void setTransactionSynchronizationName(String constantName) Set the transaction synchronization by the name of the corresponding constant in this class, e.g. final void setValidateExistingTransaction(boolean validateExistingTransaction) Set whether existing transactions should be validated before participating in them. boolean shouldCommitOnGlobalRollbackOnly() Return whether to call doCommit on a transaction that has been marked as rollback-only in a global fashion. final AbstractPlatformTransactionManager.SuspendedResourcesHolder suspend(Object transaction) Suspend the given transaction. final void triggerBeforeCommit(DefaultTransactionStatus status) Trigger beforeCommit callbacks. final void triggerBeforeCompletion(DefaultTransactionStatus status) Trigger beforeCompletion callbacks. boolean useSavepointForNestedTransaction() Return whether to use a savepoint for a nested transaction.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.springframework.beans.factory.InitializingBean abstract void afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
From interface org.springframework.transaction.PlatformTransactionManager abstract void commit(TransactionStatus status) Commit the given transaction, with regard to its status. abstract TransactionStatus getTransaction(TransactionDefinition definition) Return a currently active transaction or create a new one, according to the specified propagation behavior. abstract void rollback(TransactionStatus status) Perform a rollback of the given transaction.
From interface org.springframework.transaction.jta.TransactionFactory abstract Transaction createTransaction(String name, int timeout) Create an active Transaction object based on the given name and timeout. abstract boolean supportsResourceAdapterManagedTransactions() Determine whether the underlying transaction manager supports XA transactions managed by a resource adapter (i.e.
From interface org.springframework.transaction.support.CallbackPreferringPlatformTransactionManager abstract <T> T execute(TransactionDefinition definition, TransactionCallback<T> callback) Execute the action specified by the given callback object within a transaction.