io.micronaut.data.mongodb.transaction

Class MongoSynchronousTransactionManager

java.lang.Object

io.micronaut.transaction.support.AbstractSynchronousTransactionManager<com.mongodb.client.ClientSession>

io.micronaut.data.mongodb.transaction.MongoSynchronousTransactionManager

All Implemented Interfaces:

SynchronousTransactionManager<com.mongodb.client.ClientSession>, TransactionManager, TransactionOperations<com.mongodb.client.ClientSession>, java.io.Serializable

@RequiresSyncMongo
 @EachBean(value=com.mongodb.client.MongoClient.class)
 @Internal
public final class MongoSynchronousTransactionManager
extends AbstractSynchronousTransactionManager<com.mongodb.client.ClientSession>

Mongo synchronous transaction manager.

Since:

3.3

Author:

Denis Stepanov

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.micronaut.transaction.support.AbstractSynchronousTransactionManager

AbstractSynchronousTransactionManager.SuspendedResourcesHolder

Field Summary

Fields inherited from class io.micronaut.transaction.support.AbstractSynchronousTransactionManager

logger

Constructor Summary

Constructors

Constructor and Description
MongoSynchronousTransactionManager(com.mongodb.client.MongoClient mongoClient) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	closeClientSession() Close existing connection.
protected void	doBegin(java.lang.Object transaction, TransactionDefinition definition) Begin a new transaction with semantics according to the given transaction definition.
protected void	doCleanupAfterCompletion(java.lang.Object transaction) Cleanup resources after transaction completion.
protected void	doCommit(DefaultTransactionStatus status) Perform an actual commit of the given transaction.
protected java.lang.Object	doGetTransaction() Return a transaction object for the current transaction state.
protected void	doResume(java.lang.Object transaction, java.lang.Object suspendedResources) Resume the resources of the current transaction.
protected void	doRollback(DefaultTransactionStatus status) Perform an actual rollback of the given transaction.
protected void	doSetRollbackOnly(DefaultTransactionStatus status) Set the given transaction rollback-only.
protected java.lang.Object	doSuspend(java.lang.Object transaction) Suspend the resources of the current transaction.
com.mongodb.client.ClientSession	findClientSession() Find existing connection.
com.mongodb.client.ClientSession	getConnection() Obtains the connection for the current transaction.
protected com.mongodb.client.ClientSession	getConnection(java.lang.Object transaction) The connection for the given transaction object.
boolean	hasConnection() Check if the connection exists.
protected boolean	isExistingTransaction(java.lang.Object transaction) Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started).

Methods inherited from class io.micronaut.transaction.support.AbstractSynchronousTransactionManager

commit, determineTimeout, execute, executeRead, executeWrite, getDefaultTimeout, getTransaction, getTransactionSynchronization, invokeAfterCompletion, isFailEarlyOnGlobalRollbackOnly, isGlobalRollbackOnParticipationFailure, isNestedTransactionAllowed, isRollbackOnCommitFailure, isValidateExistingTransaction, newTransactionStatus, prepareForCommit, prepareSynchronization, prepareTransactionStatus, registerAfterCompletionWithExistingTransaction, resume, rollback, setDefaultTimeout, setFailEarlyOnGlobalRollbackOnly, setGlobalRollbackOnParticipationFailure, setNestedTransactionAllowed, setRollbackOnCommitFailure, setTransactionSynchronization, setValidateExistingTransaction, shouldCommitOnGlobalRollbackOnly, suspend, triggerBeforeCommit, triggerBeforeCompletion, useSavepointForNestedTransaction

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoSynchronousTransactionManager

public MongoSynchronousTransactionManager(com.mongodb.client.MongoClient mongoClient)

Default constructor.

Parameters:

mongoClient - The mongo client

Method Detail

findClientSession

@Nullable
public com.mongodb.client.ClientSession findClientSession()

Find existing connection.

Returns:

The client session

closeClientSession

public void closeClientSession()

Close existing connection.

getConnection

public com.mongodb.client.ClientSession getConnection()

Description copied from interface: TransactionOperations

Obtains the connection for the current transaction.

Returns:

The connection

hasConnection

public boolean hasConnection()

Description copied from interface: TransactionOperations

Check if the connection exists.

Returns:

True if transaction exists

getConnection

protected com.mongodb.client.ClientSession getConnection(java.lang.Object transaction)

Description copied from class: AbstractSynchronousTransactionManager

The connection for the given transaction object.

Specified by:

getConnection in class AbstractSynchronousTransactionManager<com.mongodb.client.ClientSession>

Parameters:

transaction - The transaction

Returns:

The connection.

doGetTransaction

protected java.lang.Object doGetTransaction()
                                     throws TransactionException

Description copied from class: AbstractSynchronousTransactionManager

Return a transaction object for the current transaction state.

The returned object will usually be specific to the concrete transaction manager implementation, carrying corresponding transaction state in a modifiable fashion. This object will be passed into the other template methods (e.g. doBegin and doCommit), either directly or as part of a DefaultTransactionStatus instance.

The returned object should contain information about any existing transaction, that is, a transaction that has already started before the current getTransaction call on the transaction manager. Consequently, a doGetTransaction implementation will usually look for an existing transaction and store corresponding state in the returned transaction object.

Specified by:

doGetTransaction in class AbstractSynchronousTransactionManager<com.mongodb.client.ClientSession>

Returns:

the current transaction object

Throws:

CannotCreateTransactionException - if transaction support is not available

TransactionException - in case of lookup or system errors

See Also:

AbstractSynchronousTransactionManager.doBegin(java.lang.Object, io.micronaut.transaction.TransactionDefinition), AbstractSynchronousTransactionManager.doCommit(io.micronaut.transaction.support.DefaultTransactionStatus), AbstractSynchronousTransactionManager.doRollback(io.micronaut.transaction.support.DefaultTransactionStatus), DefaultTransactionStatus.getTransaction()

isExistingTransaction

protected boolean isExistingTransaction(java.lang.Object transaction)
                                 throws TransactionException

Description copied from class: AbstractSynchronousTransactionManager

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.

Overrides:

isExistingTransaction in class AbstractSynchronousTransactionManager<com.mongodb.client.ClientSession>

Parameters:

transaction - transaction object returned by doGetTransaction

Returns:

if there is an existing transaction

Throws:

TransactionException - in case of system errors

See Also:

AbstractSynchronousTransactionManager.doGetTransaction()

doBegin

protected void doBegin(java.lang.Object transaction,
                       TransactionDefinition definition)
                throws TransactionException

Description copied from class: AbstractSynchronousTransactionManager

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.

Specified by:

doBegin in class AbstractSynchronousTransactionManager<com.mongodb.client.ClientSession>

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

doCommit

protected void doCommit(DefaultTransactionStatus status)
                 throws TransactionException

Description copied from class: AbstractSynchronousTransactionManager

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.

Specified by:

doCommit in class AbstractSynchronousTransactionManager<com.mongodb.client.ClientSession>

Parameters:

status - the status representation of the transaction

Throws:

TransactionException - in case of commit or system errors

See Also:

DefaultTransactionStatus.getTransaction()

doRollback

protected void doRollback(DefaultTransactionStatus status)
                   throws TransactionException

Description copied from class: AbstractSynchronousTransactionManager

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.

Specified by:

doRollback in class AbstractSynchronousTransactionManager<com.mongodb.client.ClientSession>

Parameters:

status - the status representation of the transaction

Throws:

TransactionException - in case of system errors

See Also:

DefaultTransactionStatus.getTransaction()

doSuspend

protected java.lang.Object doSuspend(java.lang.Object transaction)

Description copied from class: AbstractSynchronousTransactionManager

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.

Overrides:

doSuspend in class AbstractSynchronousTransactionManager<com.mongodb.client.ClientSession>

Parameters:

transaction - transaction object returned by doGetTransaction

Returns:

an object that holds suspended resources (will be kept unexamined for passing it into doResume)

See Also:

AbstractSynchronousTransactionManager.doResume(java.lang.Object, java.lang.Object)

doResume

protected void doResume(@Nullable
                        java.lang.Object transaction,
                        java.lang.Object suspendedResources)

Description copied from class: AbstractSynchronousTransactionManager

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.

Overrides:

doResume in class AbstractSynchronousTransactionManager<com.mongodb.client.ClientSession>

Parameters:

transaction - transaction object returned by doGetTransaction

suspendedResources - the object that holds suspended resources, as returned by doSuspend

See Also:

AbstractSynchronousTransactionManager.doSuspend(java.lang.Object)

doSetRollbackOnly

protected void doSetRollbackOnly(DefaultTransactionStatus status)

Description copied from class: AbstractSynchronousTransactionManager

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.

Overrides:

doSetRollbackOnly in class AbstractSynchronousTransactionManager<com.mongodb.client.ClientSession>

Parameters:

status - the status representation of the transaction

doCleanupAfterCompletion

protected void doCleanupAfterCompletion(java.lang.Object transaction)

Description copied from class: AbstractSynchronousTransactionManager

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.

Overrides:

doCleanupAfterCompletion in class AbstractSynchronousTransactionManager<com.mongodb.client.ClientSession>

Parameters:

transaction - transaction object returned by doGetTransaction