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

Modifier and Type	Field and Description
private boolean	completed
private boolean	rollbackOnly
private Object	savepoint

Access	Constructor and Description
public	AbstractTransactionStatus()

Method Summary

Modifier and Type	Method and Description
public void	createAndHoldSavepoint() Create a savepoint and hold it for the transaction.
public Object	createSavepoint() Implements org.springframework.transaction.SavepointManager.createSavepoint. This implementation delegates to a SavepointManager for the underlying transaction, if possible.
protected Object	getSavepoint() Get the savepoint for this transaction, if any.
protected SavepointManager	getSavepointManager() Return a SavepointManager for the underlying transaction, if possible.
public boolean	hasSavepoint() Overrides default org.springframework.transaction.TransactionStatus.hasSavepoint. Return whether this transaction internally carries a savepoint, that is, has been created as nested transaction based on a savepoint.
public boolean	isCompleted() Overrides default org.springframework.transaction.TransactionExecution.isCompleted. Return whether this transaction is completed, that is, whether it has already been committed or rolled back.
public boolean	isGlobalRollbackOnly() Template method for determining the global rollback-only flag of the underlying transaction, if any.
public boolean	isLocalRollbackOnly() Determine the rollback-only flag via checking this TransactionStatus.
public boolean	isRollbackOnly() Overrides default org.springframework.transaction.TransactionExecution.isRollbackOnly. Determine the rollback-only flag via checking both the local rollback-only flag of this TransactionStatus and the global rollback-only flag of the underlying transaction, if any.
public void	releaseHeldSavepoint() Release the savepoint that is held for the transaction.
public void	releaseSavepoint(Object the savepoint to release savepoint) Implements org.springframework.transaction.SavepointManager.releaseSavepoint. This implementation delegates to a SavepointManager for the underlying transaction, if possible.
public void	rollbackToHeldSavepoint() Roll back to the savepoint that is held for the transaction and release the savepoint right afterwards.
public void	rollbackToSavepoint(Object the savepoint to roll back to savepoint) Implements org.springframework.transaction.SavepointManager.rollbackToSavepoint. This implementation delegates to a SavepointManager for the underlying transaction, if possible.
public void	setCompleted() Mark this transaction as completed, that is, committed or rolled back.
public void	setRollbackOnly() Overrides default org.springframework.transaction.TransactionExecution.setRollbackOnly. Set the transaction rollback-only.
protected void	setSavepoint(Object savepoint) Set a savepoint for this transaction.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

completed	back to summary
private boolean completed

rollbackOnly	back to summary
private boolean rollbackOnly

savepoint	back to summary
private Object savepoint Annotations @Nullable

AbstractTransactionStatus	back to summary
public AbstractTransactionStatus()

Method Detail

createAndHoldSavepoint	back to summary
public void createAndHoldSavepoint() throws TransactionException Create a savepoint and hold it for the transaction. Exceptions NestedTransactionNotSupportedException: if the underlying transaction does not support savepoints

createAndHoldSavepoint

back to summary

public void createAndHoldSavepoint() throws TransactionException

Create a savepoint and hold it for the transaction.

Exceptions

NestedTransactionNotSupportedException:: if the underlying transaction does not support savepoints

createSavepoint back to summary

createSavepoint	back to summary
public Object createSavepoint() throws TransactionException Implements org.springframework.transaction.SavepointManager.createSavepoint. This implementation delegates to a SavepointManager for the underlying transaction, if possible. Returns:Object Doc from org.springframework.transaction.SavepointManager.createSavepoint. a savepoint object, to be passed into `rollbackToSavepoint` or `releaseSavepoint` Annotations @Override Exceptions TransactionException: Doc from org.springframework.transaction.SavepointManager.createSavepoint. if the savepoint could not be created, for example because the transaction is not in an appropriate state See Also `getSavepointManager()`, `SavepointManager#createSavepoint()`

public Object createSavepoint() throws TransactionException

Implements org.springframework.transaction.SavepointManager.createSavepoint.

This implementation delegates to a SavepointManager for the underlying transaction, if possible.

Returns:Object

Doc from org.springframework.transaction.SavepointManager.createSavepoint.

a savepoint object, to be passed into rollbackToSavepoint or releaseSavepoint

Annotations

@Override

Exceptions

TransactionException:

Doc from org.springframework.transaction.SavepointManager.createSavepoint.

if the savepoint could not be created, for example because the transaction is not in an appropriate state

getSavepoint	back to summary
protected Object getSavepoint() Get the savepoint for this transaction, if any. Annotations @Nullable

getSavepoint

back to summary

protected Object getSavepoint()

Get the savepoint for this transaction, if any.

Annotations

@Nullable

getSavepointManager	back to summary
protected SavepointManager getSavepointManager() Return a SavepointManager for the underlying transaction, if possible. Default implementation always throws a NestedTransactionNotSupportedException. Exceptions NestedTransactionNotSupportedException: if the underlying transaction does not support savepoints

getSavepointManager

back to summary

protected SavepointManager getSavepointManager()

Return a SavepointManager for the underlying transaction, if possible.

Default implementation always throws a NestedTransactionNotSupportedException.

Exceptions

NestedTransactionNotSupportedException:: if the underlying transaction does not support savepoints

hasSavepoint back to summary

hasSavepoint	back to summary
public boolean hasSavepoint() Overrides default org.springframework.transaction.TransactionStatus.hasSavepoint. Doc from org.springframework.transaction.TransactionStatus.hasSavepoint. Return whether this transaction internally carries a savepoint, that is, has been created as nested transaction based on a savepoint. This method is mainly here for diagnostic purposes, alongside `isNewTransaction()`. For programmatic handling of custom savepoints, use the operations provided by `SavepointManager`. The default implementation returns `false`. Annotations @Override

public boolean hasSavepoint()

Overrides default org.springframework.transaction.TransactionStatus.hasSavepoint.

Doc from org.springframework.transaction.TransactionStatus.hasSavepoint.

Return whether this transaction internally carries a savepoint, that is, has been created as nested transaction based on a savepoint.

This method is mainly here for diagnostic purposes, alongside isNewTransaction(). For programmatic handling of custom savepoints, use the operations provided by SavepointManager.

The default implementation returns false.

Annotations

@Override

isCompleted back to summary

isCompleted	back to summary
public boolean isCompleted() Overrides default org.springframework.transaction.TransactionExecution.isCompleted. Doc from org.springframework.transaction.TransactionExecution.isCompleted. Return whether this transaction is completed, that is, whether it has already been committed or rolled back. The default implementation returns `false`. Annotations @Override

public boolean isCompleted()

Overrides default org.springframework.transaction.TransactionExecution.isCompleted.

Doc from org.springframework.transaction.TransactionExecution.isCompleted.

Return whether this transaction is completed, that is, whether it has already been committed or rolled back.

The default implementation returns false.

Annotations

@Override

isGlobalRollbackOnly back to summary

isGlobalRollbackOnly	back to summary
public boolean isGlobalRollbackOnly() Template method for determining the global rollback-only flag of the underlying transaction, if any. This implementation always returns `false`.

public boolean isGlobalRollbackOnly()

Template method for determining the global rollback-only flag of the underlying transaction, if any.

This implementation always returns false.

isLocalRollbackOnly back to summary

isLocalRollbackOnly	back to summary
public boolean isLocalRollbackOnly() Determine the rollback-only flag via checking this TransactionStatus. Will only return "true" if the application called `setRollbackOnly` on this TransactionStatus object.

public boolean isLocalRollbackOnly()

Determine the rollback-only flag via checking this TransactionStatus.

Will only return "true" if the application called setRollbackOnly on this TransactionStatus object.

isRollbackOnly back to summary

isRollbackOnly	back to summary
public boolean isRollbackOnly() Overrides default org.springframework.transaction.TransactionExecution.isRollbackOnly. Determine the rollback-only flag via checking both the local rollback-only flag of this TransactionStatus and the global rollback-only flag of the underlying transaction, if any. Annotations @Override See Also `isLocalRollbackOnly()`, `isGlobalRollbackOnly()`

public boolean isRollbackOnly()

Overrides default org.springframework.transaction.TransactionExecution.isRollbackOnly.

Determine the rollback-only flag via checking both the local rollback-only flag of this TransactionStatus and the global rollback-only flag of the underlying transaction, if any.

Annotations

@Override

releaseHeldSavepoint	back to summary
public void releaseHeldSavepoint() throws TransactionException Release the savepoint that is held for the transaction.

releaseSavepoint back to summary

releaseSavepoint	back to summary
public void releaseSavepoint(Object savepoint) throws TransactionException Implements org.springframework.transaction.SavepointManager.releaseSavepoint. This implementation delegates to a SavepointManager for the underlying transaction, if possible. Parameters savepoint:Object Doc from org.springframework.transaction.SavepointManager.releaseSavepoint. the savepoint to release Annotations @Override Exceptions TransactionException: Doc from org.springframework.transaction.SavepointManager.releaseSavepoint. if the release failed See Also `getSavepointManager()`, `SavepointManager#releaseSavepoint(Object)`

public void releaseSavepoint(Object savepoint) throws TransactionException

Implements org.springframework.transaction.SavepointManager.releaseSavepoint.

This implementation delegates to a SavepointManager for the underlying transaction, if possible.

Parameters

savepoint:Object

Doc from org.springframework.transaction.SavepointManager.releaseSavepoint.

the savepoint to release

Annotations

@Override

Exceptions

TransactionException:

Doc from org.springframework.transaction.SavepointManager.releaseSavepoint.

if the release failed

rollbackToHeldSavepoint	back to summary
public void rollbackToHeldSavepoint() throws TransactionException Roll back to the savepoint that is held for the transaction and release the savepoint right afterwards.

rollbackToSavepoint back to summary

rollbackToSavepoint	back to summary
public void rollbackToSavepoint(Object savepoint) throws TransactionException Implements org.springframework.transaction.SavepointManager.rollbackToSavepoint. This implementation delegates to a SavepointManager for the underlying transaction, if possible. Parameters savepoint:Object Doc from org.springframework.transaction.SavepointManager.rollbackToSavepoint. the savepoint to roll back to Annotations @Override Exceptions TransactionException: Doc from org.springframework.transaction.SavepointManager.rollbackToSavepoint. if the rollback failed See Also `getSavepointManager()`, `SavepointManager#rollbackToSavepoint(Object)`

public void rollbackToSavepoint(Object savepoint) throws TransactionException

Implements org.springframework.transaction.SavepointManager.rollbackToSavepoint.

This implementation delegates to a SavepointManager for the underlying transaction, if possible.

Parameters

savepoint:Object

Doc from org.springframework.transaction.SavepointManager.rollbackToSavepoint.

the savepoint to roll back to

Annotations

@Override

Exceptions

TransactionException:

Doc from org.springframework.transaction.SavepointManager.rollbackToSavepoint.

if the rollback failed

setCompleted	back to summary
public void setCompleted() Mark this transaction as completed, that is, committed or rolled back.

setRollbackOnly	back to summary
public void setRollbackOnly() Overrides default org.springframework.transaction.TransactionExecution.setRollbackOnly. Doc from org.springframework.transaction.TransactionExecution.setRollbackOnly. Set the transaction rollback-only. This instructs the transaction manager that the only possible outcome of the transaction may be a rollback, as alternative to throwing an exception which would in turn trigger a rollback. The default implementation throws an UnsupportedOperationException. Annotations @Override

setRollbackOnly

back to summary

public void setRollbackOnly()

Overrides default org.springframework.transaction.TransactionExecution.setRollbackOnly.

Doc from org.springframework.transaction.TransactionExecution.setRollbackOnly.

Set the transaction rollback-only. This instructs the transaction manager that the only possible outcome of the transaction may be a rollback, as alternative to throwing an exception which would in turn trigger a rollback.

The default implementation throws an UnsupportedOperationException.

Annotations

@Override

setSavepoint back to summary

setSavepoint	back to summary
protected void setSavepoint(Object savepoint) Set a savepoint for this transaction. Useful for PROPAGATION_NESTED. See Also `org.springframework.transaction.TransactionDefinition#PROPAGATION_NESTED`

protected void setSavepoint(Object savepoint)

Set a savepoint for this transaction. Useful for PROPAGATION_NESTED.

See Also: org.springframework.transaction.TransactionDefinition#PROPAGATION_NESTED

public abstract Class AbstractTransactionStatus

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail