DefaultTransactionStatus (Spring Framework 5.1.0.RELEASE API)

java.lang.Object
- org.springframework.transaction.support.AbstractTransactionStatus
- - org.springframework.transaction.support.DefaultTransactionStatus

All Implemented Interfaces:

java.io.Flushable, SavepointManager, TransactionStatus
```
public class DefaultTransactionStatus
extends AbstractTransactionStatus
```
Default implementation of the TransactionStatus interface, used by AbstractPlatformTransactionManager. Based on the concept of an underlying "transaction object".
Holds all status information that AbstractPlatformTransactionManager needs internally, including a generic transaction object determined by the concrete transaction manager implementation.
Supports delegating savepoint-related methods to a transaction object that implements the SavepointManager interface.
NOTE: This is not intended for use with other PlatformTransactionManager implementations, in particular not for mock transaction managers in testing environments. Use the alternative SimpleTransactionStatus class or a mock for the plain TransactionStatus interface instead.

Since:

19.01.2004

Author:

Juergen Hoeller

See Also:

AbstractPlatformTransactionManager, SavepointManager, getTransaction(), AbstractTransactionStatus.createSavepoint(), AbstractTransactionStatus.rollbackToSavepoint(java.lang.Object), AbstractTransactionStatus.releaseSavepoint(java.lang.Object), SimpleTransactionStatus

Constructor Summary

Constructors
Constructor and Description
`DefaultTransactionStatus(java.lang.Object transaction, boolean newTransaction, boolean newSynchronization, boolean readOnly, boolean debug, java.lang.Object suspendedResources)` Create a new `DefaultTransactionStatus` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`flush()` Delegate the flushing to the transaction object, provided that the latter implements the `SmartTransactionObject` interface.
`protected SavepointManager`	`getSavepointManager()` This implementation exposes the `SavepointManager` interface of the underlying transaction object, if any.
`java.lang.Object`	`getSuspendedResources()` Return the holder for resources that have been suspended for this transaction, if any.
`java.lang.Object`	`getTransaction()` Return the underlying transaction object.
`boolean`	`hasTransaction()` Return whether there is an actual transaction active.
`boolean`	`isDebug()` Return whether the progress of this transaction is debugged.
`boolean`	`isGlobalRollbackOnly()` Determine the rollback-only flag via checking the transaction object, provided that the latter implements the `SmartTransactionObject` interface.
`boolean`	`isNewSynchronization()` Return if a new transaction synchronization has been opened for this transaction.
`boolean`	`isNewTransaction()` Return whether the present transaction is new; otherwise participating in an existing transaction, or potentially not running in an actual transaction in the first place.
`boolean`	`isReadOnly()` Return if this transaction is defined as read-only transaction.
`boolean`	`isTransactionSavepointManager()` Return whether the underlying transaction implements the `SavepointManager` interface and therefore supports savepoints.

Methods inherited from class org.springframework.transaction.support.AbstractTransactionStatus
createAndHoldSavepoint, createSavepoint, getSavepoint, hasSavepoint, isCompleted, isLocalRollbackOnly, isRollbackOnly, releaseHeldSavepoint, releaseSavepoint, rollbackToHeldSavepoint, rollbackToSavepoint, setCompleted, setRollbackOnly, setSavepoint

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

- Constructor Detail
  - DefaultTransactionStatus
```
public DefaultTransactionStatus(@Nullable
                                java.lang.Object transaction,
                                boolean newTransaction,
                                boolean newSynchronization,
                                boolean readOnly,
                                boolean debug,
                                @Nullable
                                java.lang.Object suspendedResources)
```
    Create a new DefaultTransactionStatus instance.
    
    Parameters:
    
    transaction - underlying transaction object that can hold state for the internal transaction implementation
    
    newTransaction - if the transaction is new, otherwise participating in an existing transaction
    
    newSynchronization - if a new transaction synchronization has been opened for the given transaction
    
    readOnly - whether the transaction is marked as read-only
    
    debug - should debug logging be enabled for the handling of this transaction? Caching it in here can prevent repeated calls to ask the logging system whether debug logging should be enabled.
    
    suspendedResources - a holder for resources that have been suspended for this transaction, if any
- Method Detail
  - getTransaction
```
public java.lang.Object getTransaction()
```
    Return the underlying transaction object.
    
    Throws:
    
    java.lang.IllegalStateException - if no transaction is active
  - hasTransaction
```
public boolean hasTransaction()
```
    Return whether there is an actual transaction active.
  - isNewTransaction
```
public boolean isNewTransaction()
```
    Description copied from interface: TransactionStatus
    
    Return whether the present transaction is new; otherwise participating in an existing transaction, or potentially not running in an actual transaction in the first place.
  - isNewSynchronization
```
public boolean isNewSynchronization()
```
    Return if a new transaction synchronization has been opened for this transaction.
  - isReadOnly
```
public boolean isReadOnly()
```
    Return if this transaction is defined as read-only transaction.
  - isDebug
```
public boolean isDebug()
```
    Return whether the progress of this transaction is debugged. This is used by AbstractPlatformTransactionManager as an optimization, to prevent repeated calls to logger.isDebugEnabled(). Not really intended for client code.
  - getSuspendedResources
```
@Nullable
public java.lang.Object getSuspendedResources()
```
    Return the holder for resources that have been suspended for this transaction, if any.
  - isGlobalRollbackOnly
```
public boolean isGlobalRollbackOnly()
```
    Determine the rollback-only flag via checking the transaction object, provided that the latter implements the SmartTransactionObject interface.
    Will return true if the global transaction itself has been marked rollback-only by the transaction coordinator, for example in case of a timeout.
    
    Overrides:
    
    isGlobalRollbackOnly in class AbstractTransactionStatus
    
    See Also:
    
    SmartTransactionObject.isRollbackOnly()
  - flush
```
public void flush()
```
    Delegate the flushing to the transaction object, provided that the latter implements the SmartTransactionObject interface.
    
    Specified by:
    
    flush in interface java.io.Flushable
    
    Specified by:
    
    flush in interface TransactionStatus
    
    Overrides:
    
    flush in class AbstractTransactionStatus
    
    See Also:
    
    SmartTransactionObject.flush()
  - getSavepointManager
```
protected SavepointManager getSavepointManager()
```
    This implementation exposes the SavepointManager interface of the underlying transaction object, if any.
    
    Overrides:
    
    getSavepointManager in class AbstractTransactionStatus
    
    Throws:
    
    NestedTransactionNotSupportedException - if savepoints are not supported
    
    See Also:
    
    isTransactionSavepointManager()
  - isTransactionSavepointManager
```
public boolean isTransactionSavepointManager()
```
    Return whether the underlying transaction implements the SavepointManager interface and therefore supports savepoints.
    
    See Also:
    
    getTransaction(), getSavepointManager()

Class DefaultTransactionStatus

Constructor Summary

Method Summary

Methods inherited from class org.springframework.transaction.support.AbstractTransactionStatus

Methods inherited from class java.lang.Object

Constructor Detail

DefaultTransactionStatus

Method Detail

getTransaction

hasTransaction

isNewTransaction

isNewSynchronization

isReadOnly

isDebug

getSuspendedResources

isGlobalRollbackOnly

flush

getSavepointManager

isTransactionSavepointManager