Package io.micronaut.transaction.support

Class AbstractSynchronousStateTransactionManager<T>

  • Type Parameters:
    T - The resource type
    All Implemented Interfaces:
    TransactionStateOperations<T,​SynchronousTransactionState>, TransactionManager, java.io.Serializable
    Direct Known Subclasses:
    AbstractSynchronousTransactionManager
    @Internal
public abstract class AbstractSynchronousStateTransactionManager<T>
extends java.lang.Object
implements java.io.Serializable
    NOTICE: This is a fork of Spring's AbstractPlatformTransactionManager modernizing it to use enums, Slf4j and decoupling from Spring.

    Abstract base class that implements standard transaction workflow, serving as basis for concrete platform transaction managers.

    This base class provides the following workflow handling:

    • determines if there is an existing transaction;
    • applies the appropriate propagation behavior;
    • suspends and resumes transactions if necessary;
    • checks the rollback-only flag on commit;
    • applies the appropriate modification on rollback (actual rollback or setting rollback-only);
    • triggers registered synchronization callbacks (if transaction synchronization is active).

    Subclasses have to implement specific template methods for specific states of a transaction, e.g.: begin, suspend, resume, commit, rollback. The most important of them are abstract and must be provided by a concrete implementation; for the rest, defaults are provided, so overriding is optional.

    Transaction synchronization is a generic mechanism for registering callbacks that get invoked at transaction completion time. This is mainly used internally by the data access support classes for JDBC, Hibernate, JPA, etc when running within a JTA transaction: They register resources that are opened within the transaction for closing at transaction completion time, allowing e.g. for reuse of the same Hibernate Session within the transaction. The same mechanism can also be leveraged for custom synchronization needs in an application.

    The state of this class is serializable, to allow for serializing the transaction strategy along with proxies that carry a transaction interceptor. It is up to subclasses if they wish to make their state to be serializable too. They should implement the java.io.Serializable marker interface in that case, and potentially a private readObject() method (according to Java serialization rules) if they need to restore any transient state.

    Since:
    28.03.2003, 3.4.0
    Author:
    Juergen Hoeller, graemerocher, Denis Stepanov
    See Also:
    setTransactionSynchronization(io.micronaut.transaction.support.AbstractSynchronousStateTransactionManager.Synchronization), TransactionSynchronizationManager, Serialized Form

    • Field Detail

      • logger

        protected transient org.slf4j.Logger logger

    • Constructor Detail

      • AbstractSynchronousStateTransactionManager

        public AbstractSynchronousStateTransactionManager()

    • Method Detail

      • setTransactionSynchronization

        public final void setTransactionSynchronization​(@NonNull
                                                io.micronaut.transaction.support.AbstractSynchronousStateTransactionManager.Synchronization transactionSynchronization)
        Set when this transaction manager should activate the thread-bound transaction synchronization support. Default is "always".

        Note that transaction synchronization isn't supported for multiple concurrent transactions by different transaction managers. Only one transaction manager is allowed to activate it at any time.

        Parameters:
        transactionSynchronization - the synchronization to use
        See Also:
        AbstractSynchronousStateTransactionManager.Synchronization.ALWAYS, AbstractSynchronousStateTransactionManager.Synchronization.ON_ACTUAL_TRANSACTION, AbstractSynchronousStateTransactionManager.Synchronization.NEVER, TransactionSynchronization

      • getTransactionSynchronization

        @NonNull
public final io.micronaut.transaction.support.AbstractSynchronousStateTransactionManager.Synchronization getTransactionSynchronization()
        Return if this transaction manager should activate the thread-bound transaction synchronization support.
        Returns:
        The current synchronization

      • setDefaultTimeout

        public final void setDefaultTimeout​(@NonNull
                                    java.time.Duration defaultTimeout)
        Specify the default timeout that this transaction manager should apply if there is no timeout specified at the transaction level, in seconds.

        Default is the underlying transaction infrastructure's default timeout, e.g. typically 30 seconds in case of a JTA provider, indicated by the TransactionDefinition.TIMEOUT_DEFAULT value.

        Parameters:
        defaultTimeout - The default timeout
        See Also:
        TransactionDefinition.TIMEOUT_DEFAULT

      • getDefaultTimeout

        @NonNull
public final java.time.Duration getDefaultTimeout()
        Return the default timeout that this transaction manager should apply if there is no timeout specified at the transaction level, in seconds.

        Returns TransactionDefinition.TIMEOUT_DEFAULT to indicate the underlying transaction infrastructure's default timeout.

        Returns:
        The default timeout

      • setNestedTransactionAllowed

        public final void setNestedTransactionAllowed​(boolean nestedTransactionAllowed)
        Set whether nested transactions are allowed. Default is "false".

        Typically initialized with an appropriate default by the concrete transaction manager subclass.

        Parameters:
        nestedTransactionAllowed - Whether a nested transaction is allowed

      • isNestedTransactionAllowed

        public final boolean isNestedTransactionAllowed()
        Returns:
        Return whether nested transactions are allowed.

      • setValidateExistingTransaction

        public final void setValidateExistingTransaction​(boolean validateExistingTransaction)
        Set whether existing transactions should be validated before participating in them.

        When participating in an existing transaction (e.g. with PROPAGATION_REQUIRED or PROPAGATION_SUPPORTS encountering an existing transaction), this outer transaction's characteristics will apply even to the inner transaction scope. Validation will detect incompatible isolation level and read-only settings on the inner transaction definition and reject participation accordingly through throwing a corresponding exception.

        Default is "false", leniently ignoring inner transaction settings, simply overriding them with the outer transaction's characteristics. Switch this flag to "true" in order to enforce strict validation.

        Parameters:
        validateExistingTransaction - Whether to validate an existing transaction
        Since:
        2.5.1

      • isValidateExistingTransaction

        public final boolean isValidateExistingTransaction()
        Return whether existing transactions should be validated before participating in them.
        Returns:
        Whether to validate existing transactions
        Since:
        2.5.1

      • setGlobalRollbackOnParticipationFailure

        public final void setGlobalRollbackOnParticipationFailure​(boolean globalRollbackOnParticipationFailure)
        Set whether to globally mark an existing transaction as rollback-only after a participating transaction failed.

        Default is "true": If a participating transaction (e.g. with PROPAGATION_REQUIRED or PROPAGATION_SUPPORTS encountering an existing transaction) fails, the transaction will be globally marked as rollback-only. The only possible outcome of such a transaction is a rollback: The transaction originator cannot make the transaction commit anymore.

        Switch this to "false" to let the transaction originator make the rollback decision. If a participating transaction fails with an exception, the caller can still decide to continue with a different path within the transaction. However, note that this will only work as long as all participating resources are capable of continuing towards a transaction commit even after a data access failure: This is generally not the case for a Hibernate Session, for example; neither is it for a sequence of JDBC insert/update/delete operations.

        Note:This flag only applies to an explicit rollback attempt for a subtransaction, typically caused by an exception thrown by a data access operation (where TransactionInterceptor will trigger a PlatformTransactionManager.rollback() call according to a rollback rule). If the flag is off, the caller can handle the exception and decide on a rollback, independent of the rollback rules of the subtransaction. This flag does, however, not apply to explicit setRollbackOnly calls on a TransactionStatus, which will always cause an eventual global rollback (as it might not throw an exception after the rollback-only call).

        The recommended solution for handling failure of a subtransaction is a "nested transaction", where the global transaction can be rolled back to a savepoint taken at the beginning of the subtransaction. propagation NESTED provides exactly those semantics; however, it will only work when nested transaction support is available. This is the case with DataSourceTransactionManager, but not with JtaTransactionManager.

        Parameters:
        globalRollbackOnParticipationFailure - Whether to globally mark transaction as rollback only
        See Also:
        setNestedTransactionAllowed(boolean)

      • isGlobalRollbackOnParticipationFailure

        public final boolean isGlobalRollbackOnParticipationFailure()
        Returns:
        Return whether to globally mark an existing transaction as rollback-only after a participating transaction failed.

      • setFailEarlyOnGlobalRollbackOnly

        public final void setFailEarlyOnGlobalRollbackOnly​(boolean failEarlyOnGlobalRollbackOnly)
        Set whether to fail early in case of the transaction being globally marked as rollback-only.

        Default is "false", only causing an UnexpectedRollbackException at the outermost transaction boundary. Switch this flag on to cause an UnexpectedRollbackException as early as the global rollback-only marker has been first detected, even from within an inner transaction boundary.

        Parameters:
        failEarlyOnGlobalRollbackOnly - Sets whether to fail early on global rollback
        Since:
        2.0
        See Also:
        UnexpectedRollbackException

      • isFailEarlyOnGlobalRollbackOnly

        public final boolean isFailEarlyOnGlobalRollbackOnly()
        Returns:
        Return whether to fail early in case of the transaction being globally marked as rollback-only.
        Since:
        2.0

      • isRollbackOnCommitFailure

        public final boolean isRollbackOnCommitFailure()
        Returns:
        Return whether doRollback should be performed on failure of the doCommit call.

      • newTransactionStatus

        protected DefaultTransactionStatus<T> newTransactionStatus​(@NonNull
                                                           SynchronousTransactionState state,
                                                           TransactionDefinition definition,
                                                           @Nullable
                                                           java.lang.Object transaction,
                                                           boolean newTransaction,
                                                           boolean newSynchronization,
                                                           boolean debug,
                                                           @Nullable
                                                           java.lang.Object suspendedResources)
        Create a TransactionStatus instance for the given arguments.
        Parameters:
        state - The transaction state
        definition - The definition
        transaction - The transaction object
        newTransaction - Is this is a new transaction
        newSynchronization - Is this a new synchronization
        debug - Is debug enabled
        suspendedResources - Any suspended resources
        Returns:
        The status

      • getConnection

        @Nullable
protected abstract T getConnection​(@NonNull
                                   SynchronousTransactionState state,
                                   java.lang.Object transaction)
        The connection for the given transaction object.
        Parameters:
        state - The transaction state
        transaction - The transaction
        Returns:
        The connection.

      • triggerBeforeCommit

        protected final void triggerBeforeCommit​(@NonNull
                                         SynchronousTransactionState state,
                                         @NonNull
                                         DefaultTransactionStatus<T> status)
        Trigger beforeCommit callbacks.
        Parameters:
        state - The transaction state
        status - object representing the transaction

      • triggerBeforeCompletion

        protected final void triggerBeforeCompletion​(@NonNull
                                             SynchronousTransactionState state,
                                             @NonNull
                                             DefaultTransactionStatus<T> status)
        Trigger beforeCompletion callbacks.
        Parameters:
        state - The transaction state
        status - object representing the transaction

      • isExistingTransaction

        protected boolean isExistingTransaction​(@NonNull
                                        SynchronousTransactionState state,
                                        @NonNull
                                        java.lang.Object transaction)
                                 throws TransactionException
        Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started).

        The result will be evaluated according to the specified propagation behavior for the new transaction. An existing transaction might get suspended (in case of PROPAGATION_REQUIRES_NEW), or the new transaction might participate in the existing one (in case of PROPAGATION_REQUIRED).

        The default implementation returns false, assuming that participating in existing transactions is generally not supported. Subclasses are of course encouraged to provide such support.

        Parameters:
        state - The transaction state
        transaction - transaction object returned by doGetTransaction
        Returns:
        if there is an existing transaction
        Throws:
        TransactionException - in case of system errors
        See Also:
        doGetTransaction(io.micronaut.transaction.support.SynchronousTransactionState)

      • doBegin

        protected abstract void doBegin​(@NonNull
                                java.lang.Object transaction,
                                TransactionDefinition definition)
                         throws TransactionException
        Begin a new transaction with semantics according to the given transaction definition. Does not have to care about applying the propagation behavior, as this has already been handled by this abstract manager.

        This method gets called when the transaction manager has decided to actually start a new transaction. Either there wasn't any transaction before, or the previous transaction has been suspended.

        A special scenario is a nested transaction without savepoint: If useSavepointForNestedTransaction() returns "false", this method will be called to start a nested transaction when necessary. In such a context, there will be an active transaction: The implementation of this method has to detect this and start an appropriate nested transaction.

        Parameters:
        transaction - transaction object returned by doGetTransaction
        definition - a TransactionDefinition instance, describing propagation behavior, isolation level, read-only flag, timeout, and transaction name
        Throws:
        TransactionException - in case of creation or system errors
        NestedTransactionNotSupportedException - if the underlying transaction does not support nesting

      • doSuspend

        @Nullable
protected java.lang.Object doSuspend​(@NonNull
                                     java.lang.Object transaction)
                              throws TransactionException
        Suspend the resources of the current transaction. Transaction synchronization will already have been suspended.

        The default implementation throws a TransactionSuspensionNotSupportedException, assuming that transaction suspension is generally not supported.

        Parameters:
        transaction - transaction object returned by doGetTransaction
        Returns:
        an object that holds suspended resources (will be kept unexamined for passing it into doResume)
        Throws:
        TransactionSuspensionNotSupportedException - if suspending is not supported by the transaction manager implementation
        TransactionException - in case of system errors
        See Also:
        doResume(java.lang.Object, java.lang.Object)

      • doResume

        protected void doResume​(@Nullable
                        java.lang.Object transaction,
                        @NonNull
                        java.lang.Object suspendedResources)
                 throws TransactionException
        Resume the resources of the current transaction. Transaction synchronization will be resumed afterwards.

        The default implementation throws a TransactionSuspensionNotSupportedException, assuming that transaction suspension is generally not supported.

        Parameters:
        transaction - transaction object returned by doGetTransaction
        suspendedResources - the object that holds suspended resources, as returned by doSuspend
        Throws:
        TransactionSuspensionNotSupportedException - if resuming is not supported by the transaction manager implementation
        TransactionException - in case of system errors
        See Also:
        doSuspend(java.lang.Object)

      • shouldCommitOnGlobalRollbackOnly

        protected boolean shouldCommitOnGlobalRollbackOnly()
        Return whether to call doCommit on a transaction that has been marked as rollback-only in a global fashion.

        Does not apply if an application locally sets the transaction to rollback-only via the TransactionStatus, but only to the transaction itself being marked as rollback-only by the transaction coordinator.

        Default is "false": Local transaction strategies usually don't hold the rollback-only marker in the transaction itself, therefore they can't handle rollback-only transactions as part of transaction commit. Hence, AbstractPlatformTransactionManager will trigger a rollback in that case, throwing an UnexpectedRollbackException afterwards.

        Override this to return "true" if the concrete transaction manager expects a doCommit call even for a rollback-only transaction, allowing for special handling there. This will, for example, be the case for JTA, where UserTransaction.commit will check the read-only flag itself and throw a corresponding RollbackException, which might include the specific reason (such as a transaction timeout).

        If this method returns "true" but the doCommit implementation does not throw an exception, this transaction manager will throw an UnexpectedRollbackException itself. This should not be the typical case; it is mainly checked to cover misbehaving JTA providers that silently roll back even when the rollback has not been requested by the calling code.

        Returns:
        Whether to call doCommit on a transaction that has been marked as rollback-only in a global fashion.
        See Also:
        doCommit(io.micronaut.transaction.support.DefaultTransactionStatus<T>), DefaultTransactionStatus.isGlobalRollbackOnly(), AbstractTransactionStatus.isLocalRollbackOnly(), TransactionExecution.setRollbackOnly(), UnexpectedRollbackException

      • prepareForCommit

        protected void prepareForCommit​(DefaultTransactionStatus<T> status)
        Make preparations for commit, to be performed before the beforeCommit synchronization callbacks occur.

        Note that exceptions will get propagated to the commit caller and cause a rollback of the transaction.

        Parameters:
        status - the status representation of the transaction
        Throws:
        java.lang.RuntimeException - in case of errors; will be propagated to the caller (note: do not throw TransactionException subclasses here!)

      • doCommit

        protected abstract void doCommit​(DefaultTransactionStatus<T> status)
                          throws TransactionException
        Perform an actual commit of the given transaction.

        An implementation does not need to check the "new transaction" flag or the rollback-only flag; this will already have been handled before. Usually, a straight commit will be performed on the transaction object contained in the passed-in status.

        Parameters:
        status - the status representation of the transaction
        Throws:
        TransactionException - in case of commit or system errors
        See Also:
        DefaultTransactionStatus.getTransaction()

      • doRollback

        protected abstract void doRollback​(DefaultTransactionStatus<T> status)
                            throws TransactionException
        Perform an actual rollback of the given transaction.

        An implementation does not need to check the "new transaction" flag; this will already have been handled before. Usually, a straight rollback will be performed on the transaction object contained in the passed-in status.

        Parameters:
        status - the status representation of the transaction
        Throws:
        TransactionException - in case of system errors
        See Also:
        DefaultTransactionStatus.getTransaction()

      • doSetRollbackOnly

        protected void doSetRollbackOnly​(DefaultTransactionStatus<T> status)
                          throws TransactionException
        Set the given transaction rollback-only. Only called on rollback if the current transaction participates in an existing one.

        The default implementation throws an IllegalTransactionStateException, assuming that participating in existing transactions is generally not supported. Subclasses are of course encouraged to provide such support.

        Parameters:
        status - the status representation of the transaction
        Throws:
        TransactionException - in case of system errors

      • doCleanupAfterCompletion

        protected void doCleanupAfterCompletion​(@NonNull
                                        SynchronousTransactionState state,
                                        java.lang.Object transaction)
        Cleanup resources after transaction completion.

        Called after doCommit and doRollback execution, on any outcome. The default implementation does nothing.

        Should not throw any exceptions but just issue warnings on errors.

        Parameters:
        state - The state
        transaction - transaction object returned by doGetTransaction

      • doDestroyState

        protected void doDestroyState​(@NonNull
                              SynchronousTransactionState state)
        Destroy the state.
        Parameters:
        state - The state