Package org.apache.ofbiz.entity.transaction

Class TransactionUtil

java.lang.Object

org.apache.ofbiz.entity.transaction.TransactionUtil

All Implemented Interfaces:

Status

public final class TransactionUtil
extends java.lang.Object
implements Status

Transaction Utility to help with some common transaction tasks

Provides a wrapper around the transaction objects to allow for changes in underlying implementations in the future.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TransactionUtil.InTransaction<V>
static class	TransactionUtil.NoTransaction<V>
static class	TransactionUtil.StampClearSync

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.Map<Xid,DebugXaResource>	debugResMap
static java.lang.String	module

Fields inherited from interface javax.transaction.Status

STATUS_ACTIVE, STATUS_COMMITTED, STATUS_COMMITTING, STATUS_MARKED_ROLLBACK, STATUS_NO_TRANSACTION, STATUS_PREPARED, STATUS_PREPARING, STATUS_ROLLEDBACK, STATUS_ROLLING_BACK, STATUS_UNKNOWN

Method Summary

Modifier and Type	Method	Description
static boolean	begin()	Begins a transaction in the current thread IF transactions are available; only tries if the current transaction status is ACTIVE, if not active it returns false.
static boolean	begin(int timeout)	Begins a transaction in the current thread IF transactions are available; only tries if the current transaction status is ACTIVE, if not active it returns false.
static int	cleanSuspendedTransactions()	BE VERY CAREFUL WHERE YOU CALL THIS!!
protected static void	clearTransactionStamps()
static void	commit()	Commits the transaction in the current thread IF transactions are available
static void	commit(boolean beganTransaction)	Commits the transaction in the current thread IF transactions are available AND if beganTransaction is true
static boolean	debugResources()
static <V> V	doNewTransaction(java.util.concurrent.Callable<V> callable, java.lang.String ifErrorMessage, int timeout, boolean printException)
static <V> V	doTransaction(java.util.concurrent.Callable<V> callable, java.lang.String ifErrorMessage, int timeout, boolean printException)
static java.sql.Connection	enlistConnection(javax.sql.XAConnection xacon)	Enlists the given XAConnection and if a transaction is active in the current thread, returns a plain JDBC Connection
static void	enlistResource(XAResource resource)
static java.util.Map<java.lang.Long,java.util.List<java.lang.Exception>>	getAllThreadsTransactionBeginStackSave()
static java.sql.Connection	getCursorConnection(GenericHelperInfo helperInfo, java.sql.Connection con)
static org.apache.ofbiz.entity.transaction.TransactionUtil.RollbackOnlyCause	getSetRollbackOnlyCause()
static int	getStatus()	Gets the status of the transaction in the current thread IF transactions are available, otherwise returns STATUS_NO_TRANSACTION
static java.lang.String	getStatusString()
static java.util.List<java.lang.Exception>	getSuspendedTxLocationsStack()
static java.util.List<Transaction>	getSuspendedTxStack()
static java.lang.Exception	getTransactionBeginStack()
static java.util.List<java.lang.Exception>	getTransactionBeginStackSave()
static int	getTransactionBeginStackSaveSize()
static java.sql.Timestamp	getTransactionStartStamp()
static java.lang.String	getTransactionStateString(int state)
static java.sql.Timestamp	getTransactionUniqueNowStamp()
protected static void	internalBegin(UserTransaction ut, int timeout)
static <V> TransactionUtil.InTransaction<V>	inTransaction(java.util.concurrent.Callable<V> callable, java.lang.String ifErrorMessage, int timeout, boolean printException)
static boolean	isTransactionInPlace()
static void	logRunningTx()
static <V> TransactionUtil.NoTransaction<V>	noTransaction(java.util.concurrent.Callable<V> callable)
protected static Transaction	popSuspendedTransaction()
static void	printAllThreadsTransactionBeginStacks()
protected static void	pushSuspendedTransaction(Transaction t)
static void	registerSynchronization(Synchronization sync)
protected static void	removeSuspendedTransaction(Transaction t)
static void	resume(Transaction parentTx)
static void	rollback()	Rolls back transaction in the current thread IF transactions are available
static void	rollback(boolean beganTransaction, java.lang.String causeMessage, java.lang.Throwable causeThrowable)	Rolls back transaction in the current thread IF transactions are available AND if beganTransaction is true; if beganTransaction is not true, setRollbackOnly is called to insure that the transaction will be rolled back
static void	rollback(java.lang.Throwable causeThrowable)	Rolls back transaction in the current thread IF transactions are available
static void	setRollbackOnly(java.lang.String causeMessage, java.lang.Throwable causeThrowable)	Makes a rollback the only possible outcome of the transaction in the current thread IF transactions are available
static void	setTransactionTimeout(int seconds)	Sets the timeout of the transaction in the current thread IF transactions are available
static Transaction	suspend()
static boolean	suspendedTransactionsHeld()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

module

public static final java.lang.String module

debugResMap

public static final java.util.Map<Xid,DebugXaResource> debugResMap

Method Detail

doNewTransaction

public static <V> V doNewTransaction(java.util.concurrent.Callable<V> callable,
                                     java.lang.String ifErrorMessage,
                                     int timeout,
                                     boolean printException)
                              throws GenericEntityException

Throws:

GenericEntityException

doTransaction

public static <V> V doTransaction(java.util.concurrent.Callable<V> callable,
                                  java.lang.String ifErrorMessage,
                                  int timeout,
                                  boolean printException)
                           throws GenericEntityException

Throws:

GenericEntityException

noTransaction

public static <V> TransactionUtil.NoTransaction<V> noTransaction(java.util.concurrent.Callable<V> callable)

inTransaction

public static <V> TransactionUtil.InTransaction<V> inTransaction(java.util.concurrent.Callable<V> callable,
                                                                 java.lang.String ifErrorMessage,
                                                                 int timeout,
                                                                 boolean printException)

begin

public static boolean begin()
                     throws GenericTransactionException

Begins a transaction in the current thread IF transactions are available; only tries if the current transaction status is ACTIVE, if not active it returns false. If and on only if it begins a transaction it will return true. In other words, if a transaction is already in place it will return false and do nothing.

Throws:

GenericTransactionException

begin

public static boolean begin(int timeout)
                     throws GenericTransactionException

Begins a transaction in the current thread IF transactions are available; only tries if the current transaction status is ACTIVE, if not active it returns false. If and on only if it begins a transaction it will return true. In other words, if a transaction is already in place it will return false and do nothing.

Throws:

GenericTransactionException

internalBegin

protected static void internalBegin(UserTransaction ut,
                                    int timeout)
                             throws SystemException,
                                    NotSupportedException

Throws:

SystemException

NotSupportedException

getStatus

public static int getStatus()
                     throws GenericTransactionException

Gets the status of the transaction in the current thread IF transactions are available, otherwise returns STATUS_NO_TRANSACTION

Throws:

GenericTransactionException

getStatusString

public static java.lang.String getStatusString()
                                        throws GenericTransactionException

Throws:

GenericTransactionException

isTransactionInPlace

public static boolean isTransactionInPlace()
                                    throws GenericTransactionException

Throws:

GenericTransactionException

commit

public static void commit(boolean beganTransaction)
                   throws GenericTransactionException

Commits the transaction in the current thread IF transactions are available AND if beganTransaction is true

Throws:

GenericTransactionException

commit

public static void commit()
                   throws GenericTransactionException

Commits the transaction in the current thread IF transactions are available

Throws:

GenericTransactionException

rollback

public static void rollback(boolean beganTransaction,
                            java.lang.String causeMessage,
                            java.lang.Throwable causeThrowable)
                     throws GenericTransactionException

Rolls back transaction in the current thread IF transactions are available AND if beganTransaction is true; if beganTransaction is not true, setRollbackOnly is called to insure that the transaction will be rolled back

Throws:

GenericTransactionException

rollback

public static void rollback()
                     throws GenericTransactionException

Rolls back transaction in the current thread IF transactions are available

Throws:

GenericTransactionException

rollback

public static void rollback(java.lang.Throwable causeThrowable)
                     throws GenericTransactionException

Rolls back transaction in the current thread IF transactions are available

Throws:

GenericTransactionException

setRollbackOnly

public static void setRollbackOnly(java.lang.String causeMessage,
                                   java.lang.Throwable causeThrowable)
                            throws GenericTransactionException

Makes a rollback the only possible outcome of the transaction in the current thread IF transactions are available

Throws:

GenericTransactionException

suspend

public static Transaction suspend()
                           throws GenericTransactionException

Throws:

GenericTransactionException

resume

public static void resume(Transaction parentTx)
                   throws GenericTransactionException

Throws:

GenericTransactionException

setTransactionTimeout

public static void setTransactionTimeout(int seconds)
                                  throws GenericTransactionException

Sets the timeout of the transaction in the current thread IF transactions are available

Throws:

GenericTransactionException

enlistConnection

public static java.sql.Connection enlistConnection(javax.sql.XAConnection xacon)
                                            throws GenericTransactionException

Enlists the given XAConnection and if a transaction is active in the current thread, returns a plain JDBC Connection

Throws:

GenericTransactionException

enlistResource

public static void enlistResource(XAResource resource)
                           throws GenericTransactionException

Throws:

GenericTransactionException

getTransactionStateString

public static java.lang.String getTransactionStateString(int state)

debugResources

public static boolean debugResources()

logRunningTx

public static void logRunningTx()

registerSynchronization

public static void registerSynchronization(Synchronization sync)
                                    throws GenericTransactionException

Throws:

GenericTransactionException

cleanSuspendedTransactions

public static int cleanSuspendedTransactions()
                                      throws GenericTransactionException

BE VERY CAREFUL WHERE YOU CALL THIS!!

Throws:

GenericTransactionException

suspendedTransactionsHeld

public static boolean suspendedTransactionsHeld()

getSuspendedTxStack

public static java.util.List<Transaction> getSuspendedTxStack()

getSuspendedTxLocationsStack

public static java.util.List<java.lang.Exception> getSuspendedTxLocationsStack()

pushSuspendedTransaction

protected static void pushSuspendedTransaction(Transaction t)

popSuspendedTransaction

protected static Transaction popSuspendedTransaction()

removeSuspendedTransaction

protected static void removeSuspendedTransaction(Transaction t)

getTransactionBeginStackSaveSize

public static int getTransactionBeginStackSaveSize()

getTransactionBeginStackSave

public static java.util.List<java.lang.Exception> getTransactionBeginStackSave()

getAllThreadsTransactionBeginStackSave

public static java.util.Map<java.lang.Long,java.util.List<java.lang.Exception>> getAllThreadsTransactionBeginStackSave()

printAllThreadsTransactionBeginStacks

public static void printAllThreadsTransactionBeginStacks()

getTransactionBeginStack

public static java.lang.Exception getTransactionBeginStack()

getSetRollbackOnlyCause

public static org.apache.ofbiz.entity.transaction.TransactionUtil.RollbackOnlyCause getSetRollbackOnlyCause()

getTransactionStartStamp

public static java.sql.Timestamp getTransactionStartStamp()

getTransactionUniqueNowStamp

public static java.sql.Timestamp getTransactionUniqueNowStamp()

clearTransactionStamps

protected static void clearTransactionStamps()

getCursorConnection

public static java.sql.Connection getCursorConnection(GenericHelperInfo helperInfo,
                                                      java.sql.Connection con)