Package org.springframework.transaction.support

Class DefaultTransactionStatus

java.lang.Object

org.springframework.transaction.support.AbstractTransactionStatus

org.springframework.transaction.support.DefaultTransactionStatus

All Implemented Interfaces:

Flushable, SavepointManager, TransactionExecution, 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	Description
DefaultTransactionStatus(Object transaction, boolean newTransaction, boolean newSynchronization, boolean readOnly, boolean debug, Object suspendedResources)	Deprecated, for removal: This API element is subject to removal in a future version.
DefaultTransactionStatus(String transactionName, Object transaction, boolean newTransaction, boolean newSynchronization, boolean nested, boolean readOnly, boolean debug, Object suspendedResources)	Create a new DefaultTransactionStatus instance.

Method Summary

Modifier and Type	Method	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.
Object	getSuspendedResources()	Return the holder for resources that have been suspended for this transaction, if any.
Object	getTransaction()	Return the underlying transaction object.
String	getTransactionName()	Return the defined name of the transaction (possibly an empty String).
boolean	hasTransaction()	Return whether there is an actual transaction active: this is meant to cover a new transaction as well as participation in an existing transaction, only returning false when not running in an actual transaction at all.
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	isNested()	Return if this transaction executes in a nested fashion within another.
boolean	isNewSynchronization()	Return if a new transaction synchronization has been opened for this transaction.
boolean	isNewTransaction()	Return whether the transaction manager considers the present transaction as 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 Details

DefaultTransactionStatus

public DefaultTransactionStatus(@Nullable
 String transactionName,
 @Nullable
 Object transaction,
 boolean newTransaction,
 boolean newSynchronization,
 boolean nested,
 boolean readOnly,
 boolean debug,
 @Nullable
 Object suspendedResources)

Create a new DefaultTransactionStatus instance.

Parameters:

transactionName - the defined name of the transaction

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

Since:

6.1

DefaultTransactionStatus

@Deprecated(since="6.1",
            forRemoval=true)
public DefaultTransactionStatus(@Nullable
 Object transaction,
 boolean newTransaction,
 boolean newSynchronization,
 boolean readOnly,
 boolean debug,
 @Nullable
 Object suspendedResources)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

getTransactionName

public String getTransactionName()

Description copied from interface: TransactionExecution

Return the defined name of the transaction (possibly an empty String).

In case of Spring's declarative transactions, the exposed name will be the fully-qualified class name + "." + method name (by default).

The default implementation returns an empty String.

See Also:

• TransactionDefinition.getName()

getTransaction

public Object getTransaction()

Return the underlying transaction object.

Throws:

IllegalStateException - if no transaction is active

hasTransaction

public boolean hasTransaction()

Description copied from interface: TransactionExecution

Return whether there is an actual transaction active: this is meant to cover a new transaction as well as participation in an existing transaction, only returning false when not running in an actual transaction at all.

The default implementation returns true.

See Also:

• TransactionExecution.isNewTransaction()
• TransactionExecution.isNested()
• TransactionExecution.isReadOnly()

isNewTransaction

public boolean isNewTransaction()

Description copied from interface: TransactionExecution

Return whether the transaction manager considers the present transaction as new; otherwise participating in an existing transaction, or potentially not running in an actual transaction in the first place.

This is primarily here for transaction manager state handling. Prefer the use of TransactionExecution.hasTransaction() for application purposes since this is usually semantically appropriate.

The "new" status can be transaction manager specific, for example, returning true for an actual nested transaction but potentially false for a savepoint-based nested transaction scope if the savepoint management is explicitly exposed (such as on TransactionStatus). A combined check for any kind of nested execution is provided by TransactionExecution.isNested().

The default implementation returns true.

See Also:

• TransactionExecution.hasTransaction()
• TransactionExecution.isNested()
• TransactionStatus.hasSavepoint()

isNewSynchronization

public boolean isNewSynchronization()

Return if a new transaction synchronization has been opened for this transaction.

isNested

public boolean isNested()

Description copied from interface: TransactionExecution

Return if this transaction executes in a nested fashion within another.

The default implementation returns false.

See Also:

• TransactionExecution.hasTransaction()
• TransactionExecution.isNewTransaction()
• TransactionDefinition.PROPAGATION_NESTED

isReadOnly

public boolean isReadOnly()

Description copied from interface: TransactionExecution

Return if this transaction is defined as read-only transaction.

The default implementation returns false.

See Also:

• TransactionDefinition.isReadOnly()

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 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()

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()

flush

public void flush()

Delegate the flushing to the transaction object, provided that the latter implements the SmartTransactionObject interface.

See Also:

• SmartTransactionObject.flush()