Spring Framework 6.1.4 · org.springframework.transaction.support.DefaultTransactionStatus

Modifier and Type	Field and Description
private final boolean	debug
private final boolean	nested
private final boolean	newSynchronization
private final boolean	newTransaction
private final boolean	readOnly
private final Object	suspendedResources
private final Object	transaction
private final String	transactionName

Access	Constructor and Description
public	DefaultTransactionStatus(String the defined name of the transaction transactionName, Object underlying transaction object that can hold state for the internal transaction implementation transaction, boolean if the transaction is new, otherwise participating in an existing transaction newTransaction, boolean if a new transaction synchronization has been opened for the given transaction newSynchronization, boolean nested, boolean whether the transaction is marked as read-only readOnly, boolean 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. debug, Object a holder for resources that have been suspended for this transaction, if any suspendedResources) Create a new `DefaultTransactionStatus` instance.
public	DefaultTransactionStatus(Object transaction, boolean newTransaction, boolean newSynchronization, boolean readOnly, boolean debug, Object suspendedResources) Deprecated for removal since 6.1.

Method Summary

Modifier and Type	Method and Description
public void	flush() Overrides default org.springframework.transaction.TransactionStatus.flush. Delegate the flushing to the transaction object, provided that the latter implements the `SmartTransactionObject` interface.
protected SavepointManager	getSavepointManager() Overrides org.springframework.transaction.support.AbstractTransactionStatus.getSavepointManager. This implementation exposes the `SavepointManager` interface of the underlying transaction object, if any.
public Object	getSuspendedResources() Return the holder for resources that have been suspended for this transaction, if any.
public Object	getTransaction() Return the underlying transaction object.
public String	getTransactionName() Overrides default org.springframework.transaction.TransactionExecution.getTransactionName. Return the defined name of the transaction (possibly an empty String).
public boolean	hasTransaction() Overrides default org.springframework.transaction.TransactionExecution.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.
public boolean	isDebug() Return whether the progress of this transaction is debugged.
public boolean	isGlobalRollbackOnly() Overrides org.springframework.transaction.support.AbstractTransactionStatus.isGlobalRollbackOnly. Determine the rollback-only flag via checking the transaction object, provided that the latter implements the `SmartTransactionObject` interface.
public boolean	isNested() Overrides default org.springframework.transaction.TransactionExecution.isNested. Return if this transaction executes in a nested fashion within another.
public boolean	isNewSynchronization() Return if a new transaction synchronization has been opened for this transaction.
public boolean	isNewTransaction() Overrides default org.springframework.transaction.TransactionExecution.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.
public boolean	isReadOnly() Overrides default org.springframework.transaction.TransactionExecution.isReadOnly. Return if this transaction is defined as read-only transaction.
public boolean	isTransactionSavepointManager() Return whether the underlying transaction implements the `SavepointManager` interface and therefore supports savepoints.

Inherited from org.springframework.transaction.support.AbstractTransactionStatus:: createAndHoldSavepoint createSavepoint getSavepoint hasSavepoint isCompleted isLocalRollbackOnly isRollbackOnly releaseHeldSavepoint releaseSavepoint rollbackToHeldSavepoint rollbackToSavepoint setCompleted setRollbackOnly setSavepoint

Field Detail

debug	back to summary
private final boolean debug

nested	back to summary
private final boolean nested

newSynchronization	back to summary
private final boolean newSynchronization

newTransaction	back to summary
private final boolean newTransaction

readOnly	back to summary
private final boolean readOnly

suspendedResources	back to summary
private final Object suspendedResources Annotations @Nullable

transaction	back to summary
private final Object transaction Annotations @Nullable

transactionName	back to summary
private final String transactionName Annotations @Nullable

Constructor Detail

DefaultTransactionStatus back to summary

DefaultTransactionStatus	back to summary
public DefaultTransactionStatus(String transactionName, Object transaction, boolean newTransaction, boolean newSynchronization, boolean nested, boolean readOnly, boolean debug, Object suspendedResources) Create a new `DefaultTransactionStatus` instance. Parameters transactionName:String the defined name of the transaction transaction:Object underlying transaction object that can hold state for the internal transaction implementation newTransaction:boolean if the transaction is new, otherwise participating in an existing transaction newSynchronization:boolean if a new transaction synchronization has been opened for the given transaction readOnly:boolean whether the transaction is marked as read-only debug:boolean 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:Object a holder for resources that have been suspended for this transaction, if any Since 6.1

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

Create a new DefaultTransactionStatus instance.

Parameters

transactionName:String: the defined name of the transaction
transaction:Object: underlying transaction object that can hold state for the internal transaction implementation
newTransaction:boolean: if the transaction is new, otherwise participating in an existing transaction
newSynchronization:boolean: if a new transaction synchronization has been opened for the given transaction
readOnly:boolean: whether the transaction is marked as read-only
debug:boolean: 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:Object: a holder for resources that have been suspended for this transaction, if any

Since

6.1

DefaultTransactionStatus	back to summary
public DefaultTransactionStatus(Object transaction, boolean newTransaction, boolean newSynchronization, boolean readOnly, boolean debug, Object suspendedResources) Deprecated for removal since 6.1. Annotations @Deprecated since:6.1 forRemoval:true

Method Detail

flush back to summary

flush	back to summary
public void flush() Overrides default org.springframework.transaction.TransactionStatus.flush. Delegate the flushing to the transaction object, provided that the latter implements the `SmartTransactionObject` interface. Annotations @Override See Also `SmartTransactionObject#flush()`

public void flush()

Overrides default org.springframework.transaction.TransactionStatus.flush.

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

Annotations

@Override

See Also

SmartTransactionObject#flush()

getSavepointManager back to summary

getSavepointManager	back to summary
protected SavepointManager getSavepointManager() Overrides org.springframework.transaction.support.AbstractTransactionStatus.getSavepointManager. This implementation exposes the `SavepointManager` interface of the underlying transaction object, if any. Annotations @Override Exceptions NestedTransactionNotSupportedException: if savepoints are not supported See Also `isTransactionSavepointManager()`

protected SavepointManager getSavepointManager()

Overrides org.springframework.transaction.support.AbstractTransactionStatus.getSavepointManager.

This implementation exposes the SavepointManager interface of the underlying transaction object, if any.

Annotations

@Override

Exceptions

NestedTransactionNotSupportedException:: if savepoints are not supported

See Also

isTransactionSavepointManager()

getSuspendedResources	back to summary
public Object getSuspendedResources() Return the holder for resources that have been suspended for this transaction, if any. Annotations @Nullable

getSuspendedResources

back to summary

public Object getSuspendedResources()

Return the holder for resources that have been suspended for this transaction, if any.

Annotations

@Nullable

getTransaction	back to summary
public Object getTransaction() Return the underlying transaction object. Exceptions IllegalStateException: if no transaction is active

getTransaction

back to summary

public Object getTransaction()

Return the underlying transaction object.

Exceptions

IllegalStateException:: if no transaction is active

getTransactionName back to summary

getTransactionName	back to summary
public String getTransactionName() Overrides default org.springframework.transaction.TransactionExecution.getTransactionName. Doc from org.springframework.transaction.TransactionExecution.getTransactionName. 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. Annotations @Override

public String getTransactionName()

Overrides default org.springframework.transaction.TransactionExecution.getTransactionName.

Doc from org.springframework.transaction.TransactionExecution.getTransactionName.

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.

Annotations

@Override

hasTransaction back to summary

hasTransaction	back to summary
public boolean hasTransaction() Overrides default org.springframework.transaction.TransactionExecution.hasTransaction. Doc from org.springframework.transaction.TransactionExecution.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. The default implementation returns `true`. Annotations @Override

public boolean hasTransaction()

Overrides default org.springframework.transaction.TransactionExecution.hasTransaction.

Doc from org.springframework.transaction.TransactionExecution.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.

The default implementation returns true.

Annotations

@Override

isDebug	back to summary
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.

isGlobalRollbackOnly back to summary

isGlobalRollbackOnly	back to summary
public boolean isGlobalRollbackOnly() Overrides org.springframework.transaction.support.AbstractTransactionStatus.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. Annotations @Override See Also `SmartTransactionObject#isRollbackOnly()`

public boolean isGlobalRollbackOnly()

Overrides org.springframework.transaction.support.AbstractTransactionStatus.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.

Annotations

@Override

isNested back to summary

isNested	back to summary
public boolean isNested() Overrides default org.springframework.transaction.TransactionExecution.isNested. Doc from org.springframework.transaction.TransactionExecution.isNested. Return if this transaction executes in a nested fashion within another. The default implementation returns `false`. Annotations @Override

public boolean isNested()

Overrides default org.springframework.transaction.TransactionExecution.isNested.

Doc from org.springframework.transaction.TransactionExecution.isNested.

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

The default implementation returns false.

Annotations

@Override

isNewSynchronization	back to summary
public boolean isNewSynchronization() Return if a new transaction synchronization has been opened for this transaction.

isNewTransaction back to summary

isNewTransaction	back to summary
public boolean isNewTransaction() Overrides default org.springframework.transaction.TransactionExecution.isNewTransaction. Doc from org.springframework.transaction.TransactionExecution.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. This is primarily here for transaction manager state handling. Prefer the use of `hasTransaction()` for application purposes since this is usually semantically appropriate. The "new" status can be transaction manager specific, e.g. 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 `isNested()`. The default implementation returns `true`. Annotations @Override

public boolean isNewTransaction()

Overrides default org.springframework.transaction.TransactionExecution.isNewTransaction.

Doc from org.springframework.transaction.TransactionExecution.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.

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

The "new" status can be transaction manager specific, e.g. 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 isNested().

The default implementation returns true.

Annotations

@Override

isReadOnly back to summary

isReadOnly	back to summary
public boolean isReadOnly() Overrides default org.springframework.transaction.TransactionExecution.isReadOnly. Doc from org.springframework.transaction.TransactionExecution.isReadOnly. Return if this transaction is defined as read-only transaction. The default implementation returns `false`. Annotations @Override

public boolean isReadOnly()

Overrides default org.springframework.transaction.TransactionExecution.isReadOnly.

Doc from org.springframework.transaction.TransactionExecution.isReadOnly.

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

The default implementation returns false.

Annotations

@Override

isTransactionSavepointManager back to summary

isTransactionSavepointManager	back to summary
public boolean isTransactionSavepointManager() Return whether the underlying transaction implements the `SavepointManager` interface and therefore supports savepoints. See Also `getTransaction()`, `getSavepointManager()`

public boolean isTransactionSavepointManager()

Return whether the underlying transaction implements the SavepointManager interface and therefore supports savepoints.

See Also: getTransaction(), getSavepointManager()

public Class DefaultTransactionStatus

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail