TransactionHelper (Nuxeo ECM Projects 7.2 API)

java.lang.Object
- org.nuxeo.runtime.transaction.TransactionHelper

public class TransactionHelper
extends Object

Utilities to work with transactions.

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`commitOrRollbackTransaction()` Commits or rolls back the User Transaction depending on the transaction status.
`static List<Exception>`	`getSuppressedExceptions()` Gets the suppressed exceptions, and stops remembering.
`static String`	`getUserTransactionJNDIName()` Returns the UserTransaction JNDI binding name.
`static boolean`	`isNoTransaction()` Checks if there is no transaction
`static boolean`	`isTransactionActive()` Checks if the current User Transaction is active.
`static boolean`	`isTransactionActiveOrMarkedRollback()` Checks if the current User Transaction is active or marked rollback only.
`static boolean`	`isTransactionMarkedRollback()` Checks if the current User Transaction is marked rollback only.
`static boolean`	`isTransactionTimedOut()` Checks if the current User Transaction has already timed out, i.e., whether a commit would immediately abort with a timeout exception.
`static TransactionSynchronizationRegistry`	`lookupSynchronizationRegistry()` Looks up the TransactionSynchronizationRegistry in JNDI.
`static TransactionManager`	`lookupTransactionManager()` Looks up the TransactionManager in JNDI.
`static UserTransaction`	`lookupUserTransaction()` Looks up the User Transaction in JNDI.
`static void`	`noteSuppressedException(Exception e)` If activated by , remembers the exception.
`static void`	`noteSuppressedExceptions()` After this, some exceptions during transaction commit may be suppressed and remembered.
`static void`	`registerSynchronization(Synchronization handler)`
`static Transaction`	`requireNewTransaction()` Suspend the current transaction if active and start a new transaction
`static void`	`resumeTransaction(Transaction tx)` Commit the current transaction if active and resume the principal transaction
`static boolean`	`setTransactionRollbackOnly()` Sets the current User Transaction as rollback only.
`static boolean`	`setTransactionRollbackOnlyIfTimedOut()` Sets the current User Transaction as rollback only if it has timed out.
`static boolean`	`startTransaction()` Starts a new User Transaction.
`static boolean`	`startTransaction(int timeout)` Starts a new User Transaction with the specified timeout.
`static Transaction`	`suspendTransaction()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - lookupUserTransaction
```
public static UserTransaction lookupUserTransaction()
                                             throws NamingException
```
    Looks up the User Transaction in JNDI.
    
    Returns:
    the User Transaction
    
    Throws:
    
    NamingException - if not found
  - getUserTransactionJNDIName
```
public static String getUserTransactionJNDIName()
```
    Returns the UserTransaction JNDI binding name.
    Assumes lookupUserTransaction() has been called once before.
  - lookupTransactionManager
```
public static TransactionManager lookupTransactionManager()
                                                   throws NamingException
```
    Looks up the TransactionManager in JNDI.
    
    Returns:
    the TransactionManager
    
    Throws:
    
    NamingException - if not found
  - lookupSynchronizationRegistry
```
public static TransactionSynchronizationRegistry lookupSynchronizationRegistry()
                                                                        throws NamingException
```
    Looks up the TransactionSynchronizationRegistry in JNDI.
    
    Returns:
    the TransactionSynchronizationRegistry
    
    Throws:
    
    NamingException - if not found
  - isNoTransaction
```
public static boolean isNoTransaction()
```
    Checks if there is no transaction
  - isTransactionActive
```
public static boolean isTransactionActive()
```
    Checks if the current User Transaction is active.
  - isTransactionMarkedRollback
```
public static boolean isTransactionMarkedRollback()
```
    Checks if the current User Transaction is marked rollback only.
  - isTransactionActiveOrMarkedRollback
```
public static boolean isTransactionActiveOrMarkedRollback()
```
    Checks if the current User Transaction is active or marked rollback only.
  - isTransactionTimedOut
```
public static boolean isTransactionTimedOut()
```
    Checks if the current User Transaction has already timed out, i.e., whether a commit would immediately abort with a timeout exception.
    
    Returns:
    true if there is a current transaction that has timed out, false otherwise
    Since:
    
    7.1
  - startTransaction
```
public static boolean startTransaction()
```
    Starts a new User Transaction.
    
    Returns:
    true if the transaction was successfully started, false otherwise
  - requireNewTransaction
```
public static Transaction requireNewTransaction()
```
    Suspend the current transaction if active and start a new transaction
    
    Returns:
    the suspended transaction or null
    
    Throws:
    
    TransactionRuntimeException
    Since:
    
    5.6
  - suspendTransaction
```
public static Transaction suspendTransaction()
```
  - resumeTransaction
```
public static void resumeTransaction(Transaction tx)
```
    Commit the current transaction if active and resume the principal transaction
    
    Parameters:
    tx -
  - startTransaction
```
public static boolean startTransaction(int timeout)
```
    Starts a new User Transaction with the specified timeout.
    
    Parameters:
    timeout - the timeout in seconds, <= 0 for the default
    
    Returns:
    true if the transaction was successfully started, false otherwise
    Since:
    
    5.6
  - commitOrRollbackTransaction
```
public static void commitOrRollbackTransaction()
```
    Commits or rolls back the User Transaction depending on the transaction status.
  - noteSuppressedExceptions
```
public static void noteSuppressedExceptions()
```
    After this, some exceptions during transaction commit may be suppressed and remembered.
    
    Since:
    
    5.9.4
  - noteSuppressedException
```
public static void noteSuppressedException(Exception e)
```
    If activated by , remembers the exception.
    
    Since:
    
    5.9.4
  - getSuppressedExceptions
```
public static List<Exception> getSuppressedExceptions()
```
    Gets the suppressed exceptions, and stops remembering.
    
    Since:
    
    5.9.4
  - setTransactionRollbackOnly
```
public static boolean setTransactionRollbackOnly()
```
    Sets the current User Transaction as rollback only.
    
    Returns:
    true if the transaction was successfully marked rollback only, false otherwise
  - setTransactionRollbackOnlyIfTimedOut
```
public static boolean setTransactionRollbackOnlyIfTimedOut()
```
    Sets the current User Transaction as rollback only if it has timed out.
    
    Returns:
    true if the transaction was successfully marked rollback only, false otherwise
    Since:
    
    7.1
  - registerSynchronization
```
public static void registerSynchronization(Synchronization handler)
```

Class TransactionHelper

Method Summary

Methods inherited from class java.lang.Object

Method Detail

lookupUserTransaction

getUserTransactionJNDIName

lookupTransactionManager

lookupSynchronizationRegistry

isNoTransaction

isTransactionActive

isTransactionMarkedRollback

isTransactionActiveOrMarkedRollback

isTransactionTimedOut

startTransaction

requireNewTransaction

suspendTransaction

resumeTransaction

startTransaction

commitOrRollbackTransaction

noteSuppressedExceptions

noteSuppressedException

getSuppressedExceptions

setTransactionRollbackOnly

setTransactionRollbackOnlyIfTimedOut

registerSynchronization