DbTransaction (Tentackle Persistence 2.0.7 API)

java.lang.Object
- org.tentackle.persist.DbTransaction

All Implemented Interfaces:

Serializable
```
public class DbTransaction
extends Object
implements Serializable
```
Holder for transaction local data.

Author:

harald

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

DbTransaction(Db db, String txName, boolean fromRemote)
Creates a transaction.

Constructors
Constructor and Description
`DbTransaction(Db db, String txName, boolean fromRemote)` Creates a transaction.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addToUpdateCount(int count)` Add to updateCount.
`int`	`decrementTxLevel()` Decrements the transaction level.
`Collection<CommitTxRunnable>`	`getCommitTxRunnables()` Gets the currently registered commit runnables.
`long`	`getCreationTime()` Gets the epochal creation time in ms.
`Collection<PersistenceVisitor>`	`getPersistenceVisitors()` Gets the currently registered persistence visitors.
`Collection<RollbackTxRunnable>`	`getRollbackTxRunnables()` Gets the currently registered rollback runnables.
`Db`	`getSession()` Gets the db.
`int`	`getTxLevel()` Gets the nesting level.
`String`	`getTxName()` Gets the transaction name.
`long`	`getTxNumber()` Gets the transaction number.
`AbstractDbObject<?>`	`getTxObject()` Gets the optional transaction object.
`long`	`getTxVoucher()` Gets the transaction voucher.
`int`	`getUpdateCount()` Gets the number of objects modified since the last begin().
`int`	`incrementTxLevel()` Increments the transaction level.
`void`	`invalidateTxLevel()` Marks the txLevel invalid.
`void`	`invokeCommitTxRunnables()` Executes all commit runnables and removes them.
`void`	`invokeRollbackTxRunnables()` Executes all rollback runnables and removes them.
`boolean`	`isPersistenceOperationAllowed(AbstractDbObject<?> object, char modType)` Checks whether a persistence operation is allowed. This is determined by consulting the `PersistenceVisitor`s.
`boolean`	`isTxLevelValid()` Returns whether the txLevel is valid.
`DbTransactionHandle`	`registerCommitTxRunnable(CommitTxRunnable commitRunnable)` Registers a `CommitTxRunnable` to be invoked just before committing a transaction.
`DbTransactionHandle`	`registerPersistenceVisitor(PersistenceVisitor visitor)` Registers a `PersistenceVisitor` to be invoked just before performing a persistence operation.
`DbTransactionHandle`	`registerRollbackTxRunnable(RollbackTxRunnable rollbackRunnable)` Registers a `RollbackTxRunnable` to be invoked just before rolling back a transaction.
`void`	`setSession(Db db)` Sets the db.
`void`	`setTxObject(AbstractDbObject<?> txObject)` Sets the optional transaction object. By default, whenever a transaction is initiated by a persistence operation of a PDO, that object becomes the "parent" of the transaction. The `txObject` is mainly used for logging and enhanced auditing (partial history) during transactions.
`String`	`toString()`
`CommitTxRunnable`	`unregisterCommitTxRunnable(DbTransactionHandle handle)` Unregisters a `CommitTxRunnable`.
`PersistenceVisitor`	`unregisterPersistenceVisitor(DbTransactionHandle handle)` Unegisters a `PersistenceVisitor`.
`RollbackTxRunnable`	`unregisterRollbackTxRunnable(DbTransactionHandle handle)` Unregisters a `RollbackTxRunnable`.

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

- Constructor Detail
  - DbTransaction
```
public DbTransaction(Db db,
                     String txName,
                     boolean fromRemote)
```
    Creates a transaction.
    
    Parameters:
    
    db - the db
    
    txName - the transaction name
    
    fromRemote - true if initiated from remote client
- Method Detail
  - setSession
```
public void setSession(Db db)
```
    Sets the db.
    Used after transferring from server to client.
    
    Parameters:
    
    db - the new db
  - getSession
```
public Db getSession()
```
    Gets the db.
    
    Returns:
    
    the db
  - getCreationTime
```
public long getCreationTime()
```
    Gets the epochal creation time in ms.
    
    Returns:
    
    the milliseconds since 1970-01-01
  - getUpdateCount
```
public int getUpdateCount()
```
    Gets the number of objects modified since the last begin(). The method is provided to check whether objects have been modified at all.
    
    Returns:
    
    the number of modified objects
  - addToUpdateCount
```
public void addToUpdateCount(int count)
```
    Add to updateCount.
    
    Parameters:
    
    count - the number of updates to add
  - getTxName
```
public String getTxName()
```
    Gets the transaction name.
    
    Returns:
    
    the name
  - getTxNumber
```
public long getTxNumber()
```
    Gets the transaction number.
    
    Returns:
    
    the tx number
  - getTxLevel
```
public int getTxLevel()
```
    Gets the nesting level.
    
    Returns:
    
    the tx level
  - invalidateTxLevel
```
public void invalidateTxLevel()
```
    Marks the txLevel invalid.
    Will suppress any checks and warnings.
  - isTxLevelValid
```
public boolean isTxLevelValid()
```
    Returns whether the txLevel is valid.
    
    Returns:
    
    true if valid
  - incrementTxLevel
```
public int incrementTxLevel()
```
    Increments the transaction level.
    
    Returns:
    
    the new tx level
  - decrementTxLevel
```
public int decrementTxLevel()
```
    Decrements the transaction level.
    
    Returns:
    
    the new tx level
  - getTxVoucher
```
public long getTxVoucher()
```
    Gets the transaction voucher.
    
    Returns:
    
    the voucher
  - setTxObject
```
public void setTxObject(AbstractDbObject<?> txObject)
```
    Sets the optional transaction object.
    By default, whenever a transaction is initiated by a persistence operation of a PDO, that object becomes the "parent" of the transaction.
    The txObject is mainly used for logging and enhanced auditing (partial history) during transactions. The txObject is cleared at the end of the transaction.
    
    Parameters:
    
    txObject - the transaction object, null to clear
  - getTxObject
```
public AbstractDbObject<?> getTxObject()
```
    Gets the optional transaction object.
    
    Returns:
    
    the transaction object, null if none
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - registerPersistenceVisitor
```
public DbTransactionHandle registerPersistenceVisitor(PersistenceVisitor visitor)
```
    Registers a PersistenceVisitor to be invoked just before performing a persistence operation.
    
    Parameters:
    
    visitor - the visitor to register
    
    Returns:
    
    the handle for the visitor
  - unregisterPersistenceVisitor
```
public PersistenceVisitor unregisterPersistenceVisitor(DbTransactionHandle handle)
```
    Unegisters a PersistenceVisitor.
    
    Parameters:
    
    handle - the visitor's handle to unregister
    
    Returns:
    
    the removed visitor, null if not registered
  - getPersistenceVisitors
```
public Collection<PersistenceVisitor> getPersistenceVisitors()
```
    Gets the currently registered persistence visitors.
    
    Returns:
    
    the visitors, null or empty if none
  - registerCommitTxRunnable
```
public DbTransactionHandle registerCommitTxRunnable(CommitTxRunnable commitRunnable)
```
    Registers a CommitTxRunnable to be invoked just before committing a transaction.
    
    Parameters:
    
    commitRunnable - the runnable to register
    
    Returns:
    
    the handle for the runnable
  - unregisterCommitTxRunnable
```
public CommitTxRunnable unregisterCommitTxRunnable(DbTransactionHandle handle)
```
    Unregisters a CommitTxRunnable.
    
    Parameters:
    
    handle - the runnable's handle to unregister
    
    Returns:
    
    true if removed, else not registered
  - getCommitTxRunnables
```
public Collection<CommitTxRunnable> getCommitTxRunnables()
```
    Gets the currently registered commit runnables.
    
    Returns:
    
    the runnables, null or empty if none
  - registerRollbackTxRunnable
```
public DbTransactionHandle registerRollbackTxRunnable(RollbackTxRunnable rollbackRunnable)
```
    Registers a RollbackTxRunnable to be invoked just before rolling back a transaction.
    
    Parameters:
    
    rollbackRunnable - the runnable to register
    
    Returns:
    
    the handle for the runnable
  - unregisterRollbackTxRunnable
```
public RollbackTxRunnable unregisterRollbackTxRunnable(DbTransactionHandle handle)
```
    Unregisters a RollbackTxRunnable.
    
    Parameters:
    
    handle - the runnable's handle to unregister
    
    Returns:
    
    true if removed, else not registered
  - getRollbackTxRunnables
```
public Collection<RollbackTxRunnable> getRollbackTxRunnables()
```
    Gets the currently registered rollback runnables.
    
    Returns:
    
    the runnables, null or empty if none
  - invokeCommitTxRunnables
```
public void invokeCommitTxRunnables()
```
    Executes all commit runnables and removes them.
  - invokeRollbackTxRunnables
```
public void invokeRollbackTxRunnables()
```
    Executes all rollback runnables and removes them.
  - isPersistenceOperationAllowed
```
public boolean isPersistenceOperationAllowed(AbstractDbObject<?> object,
                                             char modType)
```
    Checks whether a persistence operation is allowed.
    This is determined by consulting the PersistenceVisitors.
    
    Parameters:
    
    object - the persistence object
    
    modType - the modification type
    
    Returns:
    
    true if allowed
    
    See Also:
    
    registerPersistenceVisitor(org.tentackle.persist.PersistenceVisitor)

Class DbTransaction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DbTransaction

Method Detail

setSession

getSession

getCreationTime

getUpdateCount

addToUpdateCount

getTxName

getTxNumber

getTxLevel

invalidateTxLevel

isTxLevelValid

incrementTxLevel

decrementTxLevel

getTxVoucher

setTxObject

getTxObject

toString

registerPersistenceVisitor

unregisterPersistenceVisitor

getPersistenceVisitors

registerCommitTxRunnable

unregisterCommitTxRunnable

getCommitTxRunnables

registerRollbackTxRunnable

unregisterRollbackTxRunnable

getRollbackTxRunnables

invokeCommitTxRunnables

invokeRollbackTxRunnables

isPersistenceOperationAllowed