Class AbstractInternalTransaction<C>

java.lang.Object

io.micronaut.transaction.impl.AbstractInternalTransaction<C>

Type Parameters:

C - The connection type

All Implemented Interfaces:

io.micronaut.core.propagation.PropagatedContextElement, InternalTransaction<C>, TransactionExecution, TransactionStatus<C>

Direct Known Subclasses:

DefaultTransactionStatus

@Internal
public abstract class AbstractInternalTransaction<C>
extends Object
implements InternalTransaction<C>

The abstract internal transaction.

Since:

4.0.0

Author:

Denis Stepanov

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable List<TransactionSynchronization>	synchronizations

Constructor Summary

Constructors

Constructor	Description
AbstractInternalTransaction()

Method Summary

Modifier and Type	Method	Description
void	bindConnectionSynchronizationsToTransaction()	Binds the synchronizations registered by InternalTransaction.registerConnectionSynchronization(ConnectionSynchronization) to this transaction.
void	bindConnectionSynchronizationsToTransaction(@NonNull Runnable release)	Binds the synchronizations registered by InternalTransaction.registerConnectionSynchronization(ConnectionSynchronization) and the release of the connection to this transaction.
void	cleanupAfterCompletion()	Final cleanup after the transaction completed, always invoked even if an earlier completion step failed.
void	discardConnectionSynchronizations()	Discards the connection synchronizations bound to this transaction without executing them.
boolean	isCompleted()	Return whether this transaction is completed, that is, whether it has already been committed or rolled back.
boolean	isConnectionOwnedByOuterScope()
boolean	isGlobalRollbackOnly()	Template method for determining the global rollback-only flag of the underlying transaction, if any.
boolean	isLocalRollbackOnly()	Determine the rollback-only flag via checking this TransactionStatus.
boolean	isRollbackOnly()	Return whether the transaction has been marked as rollback-only (either by the application or by the transaction infrastructure).
void	registerConnectionSynchronization(@NonNull ConnectionSynchronization synchronization)	Registers a synchronization restoring the connection state changed by this transaction.
void	registerInvocationSynchronization(@NonNull TransactionSynchronization synchronization)	The variation of TransactionStatus.registerSynchronization(TransactionSynchronization) that is always executed on the current TX invocation.
void	registerResourceCommit(TransactionResourceCommit resourceCommit)	Registers vendor-specific work for the resource commit boundary.
void	registerSynchronization(@NonNull TransactionSynchronization synchronization)	Register a new transaction synchronization for the current state.
protected void	setGlobalRollbackOnly()	Set global rollback only.
void	setRollbackOnly()	Set the transaction rollback-only.
void	triggerAfterCommit()
void	triggerAfterCompletion(TransactionSynchronization.Status status)
void	triggerBeforeCommit()
void	triggerBeforeCompletion()
boolean	triggerResourceCommit()	Runs a registered resource commit action.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface InternalTransaction

isNestedTransaction, resume, suspend

Methods inherited from interface TransactionExecution

getTransactionDefinition, isNewTransaction

Methods inherited from interface TransactionStatus

getConnection, getConnectionStatus, getTransaction, propagate, propagate, propagate

Field Details

synchronizations

protected @Nullable List<TransactionSynchronization> synchronizations

Constructor Details

AbstractInternalTransaction

public AbstractInternalTransaction()

Method Details

setGlobalRollbackOnly

protected void setGlobalRollbackOnly()

Set global rollback only.

setRollbackOnly

public void setRollbackOnly()

Description copied from interface: TransactionExecution

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.

Specified by:

setRollbackOnly in interface TransactionExecution

isRollbackOnly

public boolean isRollbackOnly()

Description copied from interface: TransactionExecution

Return whether the transaction has been marked as rollback-only (either by the application or by the transaction infrastructure).

Specified by:

isRollbackOnly in interface TransactionExecution

Returns:

Whether the execution has been marked to rollback

isLocalRollbackOnly

public boolean isLocalRollbackOnly()

Description copied from interface: InternalTransaction

Determine the rollback-only flag via checking this TransactionStatus.

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

Specified by:

isLocalRollbackOnly in interface InternalTransaction<C>

Returns:

Whether is local rollback

isGlobalRollbackOnly

public boolean isGlobalRollbackOnly()

Description copied from interface: InternalTransaction

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

This implementation always returns false.

Specified by:

isGlobalRollbackOnly in interface InternalTransaction<C>

Returns:

Whether is global rollback

isCompleted

public boolean isCompleted()

Description copied from interface: TransactionExecution

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

Specified by:

isCompleted in interface TransactionExecution

Returns:

Whether the execution has completed

triggerBeforeCommit

public void triggerBeforeCommit()

Specified by:

triggerBeforeCommit in interface InternalTransaction<C>

triggerAfterCommit

public void triggerAfterCommit()

Specified by:

triggerAfterCommit in interface InternalTransaction<C>

triggerBeforeCompletion

public void triggerBeforeCompletion()

Specified by:

triggerBeforeCompletion in interface InternalTransaction<C>

registerResourceCommit

public void registerResourceCommit(TransactionResourceCommit resourceCommit)

Description copied from interface: InternalTransaction

Registers vendor-specific work for the resource commit boundary.

Specified by:

registerResourceCommit in interface InternalTransaction<C>

Parameters:

resourceCommit - The resource commit callback

triggerResourceCommit

public boolean triggerResourceCommit()

Description copied from interface: InternalTransaction

Runs a registered resource commit action.

Specified by:

triggerResourceCommit in interface InternalTransaction<C>

Returns:

true when a resource commit action was registered and executed

triggerAfterCompletion

public void triggerAfterCompletion(TransactionSynchronization.Status status)

Specified by:

triggerAfterCompletion in interface InternalTransaction<C>

cleanupAfterCompletion

public void cleanupAfterCompletion()

Description copied from interface: InternalTransaction

Final cleanup after the transaction completed, always invoked even if an earlier completion step failed. Runs the connection synchronizations bound to this transaction, see InternalTransaction.bindConnectionSynchronizationsToTransaction().

Specified by:

cleanupAfterCompletion in interface InternalTransaction<C>

registerConnectionSynchronization

public void registerConnectionSynchronization(@NonNull ConnectionSynchronization synchronization)

Description copied from interface: InternalTransaction

Registers a synchronization restoring the connection state changed by this transaction. By default, the synchronization is registered on the connection status; if the transaction reuses a connection owned by an outer scope, it is executed at InternalTransaction.cleanupAfterCompletion().

Specified by:

registerConnectionSynchronization in interface InternalTransaction<C>

Parameters:

synchronization - The synchronization

bindConnectionSynchronizationsToTransaction

public void bindConnectionSynchronizationsToTransaction()

Description copied from interface: InternalTransaction

Binds the synchronizations registered by InternalTransaction.registerConnectionSynchronization(ConnectionSynchronization) to this transaction. Used when the transaction is started on a connection owned by an outer scope.

Specified by:

bindConnectionSynchronizationsToTransaction in interface InternalTransaction<C>

bindConnectionSynchronizationsToTransaction

public void bindConnectionSynchronizationsToTransaction(@NonNull Runnable release)

Description copied from interface: InternalTransaction

Binds the synchronizations registered by InternalTransaction.registerConnectionSynchronization(ConnectionSynchronization) and the release of the connection to this transaction. Used when the transaction owns the connection. The connection is released at InternalTransaction.cleanupAfterCompletion(), after the connection state is restored.

Specified by:

bindConnectionSynchronizationsToTransaction in interface InternalTransaction<C>

Parameters:

release - The release of the connection

discardConnectionSynchronizations

public void discardConnectionSynchronizations()

Description copied from interface: InternalTransaction

Discards the connection synchronizations bound to this transaction without executing them. Used when restoring the connection state is unsafe, for example, restoring the auto-commit of a partially started transaction that couldn't be rolled back would commit it.

Specified by:

discardConnectionSynchronizations in interface InternalTransaction<C>

isConnectionOwnedByOuterScope

public boolean isConnectionOwnedByOuterScope()

Returns:

true if the transaction was started on a connection owned by an outer scope, see bindConnectionSynchronizationsToTransaction()

Since:

5.3.0

registerSynchronization

public void registerSynchronization(@NonNull TransactionSynchronization synchronization)

Description copied from interface: TransactionStatus

Register a new transaction synchronization for the current state.

Note that synchronizations can implement the Ordered interface. They will be executed in an order according to their order value (if any).

Specified by:

registerSynchronization in interface TransactionStatus<C>

Parameters:

synchronization - the synchronization object to register

registerInvocationSynchronization

public void registerInvocationSynchronization(@NonNull TransactionSynchronization synchronization)

Description copied from interface: InternalTransaction

The variation of TransactionStatus.registerSynchronization(TransactionSynchronization) that is always executed on the current TX invocation. The ordinary TransactionStatus.registerSynchronization(TransactionSynchronization) will always bound the synchronization to the TX in progress.

Specified by:

registerInvocationSynchronization in interface InternalTransaction<C>

Parameters:

synchronization - The synchronization