org.springframework.data.mongodb

Class ReactiveMongoTransactionManager

java.lang.Object

org.springframework.transaction.reactive.AbstractReactiveTransactionManager

org.springframework.data.mongodb.ReactiveMongoTransactionManager

All Implemented Interfaces:

Serializable, InitializingBean, ReactiveTransactionManager, TransactionManager

public class ReactiveMongoTransactionManager
extends AbstractReactiveTransactionManager
implements InitializingBean

A ReactiveTransactionManager implementation that manages ClientSession based transactions for a single ReactiveMongoDatabaseFactory.

Binds a ClientSession from the specified ReactiveMongoDatabaseFactory to the subscriber Context.

Readonly transactions operate on a ClientSession and enable causal consistency, and also start, commit or abort a transaction.

Application code is required to retrieve the MongoDatabase via ReactiveMongoDatabaseUtils.getDatabase(ReactiveMongoDatabaseFactory) instead of a standard ReactiveMongoDatabaseFactory.getMongoDatabase() call. Spring classes such as ReactiveMongoTemplate use this strategy implicitly.

By default failure of a commit operation raises a TransactionSystemException. You can override doCommit(TransactionSynchronizationManager, ReactiveMongoTransactionObject) to implement the Retry Commit Operation behavior as outlined in the MongoDB reference manual.

Since:

2.2

Author:

Christoph Strobl, Mark Paluch

See Also:

MongoDB Transaction Documentation, ReactiveMongoDatabaseUtils.getDatabase(ReactiveMongoDatabaseFactory, SessionSynchronization), Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ReactiveMongoTransactionManager.ReactiveMongoTransactionObject MongoDB specific transaction object, representing a MongoResourceHolder.

Nested classes/interfaces inherited from class org.springframework.transaction.reactive.AbstractReactiveTransactionManager

AbstractReactiveTransactionManager.SuspendedResourcesHolder

Field Summary

Fields inherited from class org.springframework.transaction.reactive.AbstractReactiveTransactionManager

logger

Constructor Summary

Constructors

Constructor and Description
ReactiveMongoTransactionManager() Create a new ReactiveMongoTransactionManager for bean-style usage.
ReactiveMongoTransactionManager(ReactiveMongoDatabaseFactory databaseFactory) Create a new ReactiveMongoTransactionManager obtaining sessions from the given ReactiveMongoDatabaseFactory.
ReactiveMongoTransactionManager(ReactiveMongoDatabaseFactory databaseFactory, com.mongodb.TransactionOptions options) Create a new ReactiveMongoTransactionManager obtaining sessions from the given ReactiveMongoDatabaseFactory applying the given options, if present, when starting a new transaction.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected reactor.core.publisher.Mono<Void>	doBegin(TransactionSynchronizationManager synchronizationManager, Object transaction, TransactionDefinition definition)
protected reactor.core.publisher.Mono<Void>	doCleanupAfterCompletion(TransactionSynchronizationManager synchronizationManager, Object transaction)
protected reactor.core.publisher.Mono<Void>	doCommit(TransactionSynchronizationManager synchronizationManager, GenericReactiveTransaction status)
protected reactor.core.publisher.Mono<Void>	doCommit(TransactionSynchronizationManager synchronizationManager, ReactiveMongoTransactionManager.ReactiveMongoTransactionObject transactionObject) Customization hook to perform an actual commit of the given transaction.
protected Object	doGetTransaction(TransactionSynchronizationManager synchronizationManager)
protected reactor.core.publisher.Mono<Void>	doResume(TransactionSynchronizationManager synchronizationManager, Object transaction, Object suspendedResources)
protected reactor.core.publisher.Mono<Void>	doRollback(TransactionSynchronizationManager synchronizationManager, GenericReactiveTransaction status)
protected reactor.core.publisher.Mono<Void>	doSetRollbackOnly(TransactionSynchronizationManager synchronizationManager, GenericReactiveTransaction status)
protected reactor.core.publisher.Mono<Object>	doSuspend(TransactionSynchronizationManager synchronizationManager, Object transaction)
ReactiveMongoDatabaseFactory	getDatabaseFactory() Get the ReactiveMongoDatabaseFactory that this instance manages transactions for.
protected boolean	isExistingTransaction(Object transaction)
void	setDatabaseFactory(ReactiveMongoDatabaseFactory databaseFactory) Set the ReactiveMongoDatabaseFactory that this instance should manage transactions for.
void	setOptions(com.mongodb.TransactionOptions options) Set the TransactionOptions to be applied when starting transactions.

Methods inherited from class org.springframework.transaction.reactive.AbstractReactiveTransactionManager

commit, getReactiveTransaction, prepareForCommit, registerAfterCompletionWithExistingTransaction, rollback

Methods inherited from class java.lang.Object

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

Constructor Detail

ReactiveMongoTransactionManager

public ReactiveMongoTransactionManager()

Create a new ReactiveMongoTransactionManager for bean-style usage.

Note:The db factory has to be setDatabaseFactory(ReactiveMongoDatabaseFactory) set} before using the instance. Use this constructor to prepare a ReactiveMongoTransactionManager via a BeanFactory.

Optionally it is possible to set default transaction options defining ReadConcern and WriteConcern.

See Also:

setDatabaseFactory(ReactiveMongoDatabaseFactory)

ReactiveMongoTransactionManager

public ReactiveMongoTransactionManager(ReactiveMongoDatabaseFactory databaseFactory)

Create a new ReactiveMongoTransactionManager obtaining sessions from the given ReactiveMongoDatabaseFactory.

Parameters:

databaseFactory - must not be null.

ReactiveMongoTransactionManager

public ReactiveMongoTransactionManager(ReactiveMongoDatabaseFactory databaseFactory,
                                       @Nullable
                                       com.mongodb.TransactionOptions options)

Create a new ReactiveMongoTransactionManager obtaining sessions from the given ReactiveMongoDatabaseFactory applying the given options, if present, when starting a new transaction.

Parameters:

databaseFactory - must not be null.

options - can be null.

Method Detail

doGetTransaction

protected Object doGetTransaction(TransactionSynchronizationManager synchronizationManager)
                           throws TransactionException

Specified by:

doGetTransaction in class AbstractReactiveTransactionManager

Throws:

TransactionException

isExistingTransaction

protected boolean isExistingTransaction(Object transaction)
                                 throws TransactionException

Overrides:

isExistingTransaction in class AbstractReactiveTransactionManager

Throws:

TransactionException

doBegin

protected reactor.core.publisher.Mono<Void> doBegin(TransactionSynchronizationManager synchronizationManager,
                                                    Object transaction,
                                                    TransactionDefinition definition)
                                             throws TransactionException

Specified by:

doBegin in class AbstractReactiveTransactionManager

Throws:

TransactionException

doSuspend

protected reactor.core.publisher.Mono<Object> doSuspend(TransactionSynchronizationManager synchronizationManager,
                                                        Object transaction)
                                                 throws TransactionException

Overrides:

doSuspend in class AbstractReactiveTransactionManager

Throws:

TransactionException

doResume

protected reactor.core.publisher.Mono<Void> doResume(TransactionSynchronizationManager synchronizationManager,
                                                     @Nullable
                                                     Object transaction,
                                                     Object suspendedResources)

Overrides:

doResume in class AbstractReactiveTransactionManager

doCommit

protected final reactor.core.publisher.Mono<Void> doCommit(TransactionSynchronizationManager synchronizationManager,
                                                           GenericReactiveTransaction status)
                                                    throws TransactionException

Specified by:

doCommit in class AbstractReactiveTransactionManager

Throws:

TransactionException

doCommit

protected reactor.core.publisher.Mono<Void> doCommit(TransactionSynchronizationManager synchronizationManager,
                                                     ReactiveMongoTransactionManager.ReactiveMongoTransactionObject transactionObject)

Customization hook to perform an actual commit of the given transaction.
If a commit operation encounters an error, the MongoDB driver throws a MongoException holding error labels.
By default those labels are ignored, nevertheless one might check for transient commit errors labels and retry the the commit.

Parameters:

synchronizationManager - reactive synchronization manager.

transactionObject - never null.

doRollback

protected reactor.core.publisher.Mono<Void> doRollback(TransactionSynchronizationManager synchronizationManager,
                                                       GenericReactiveTransaction status)

Specified by:

doRollback in class AbstractReactiveTransactionManager

doSetRollbackOnly

protected reactor.core.publisher.Mono<Void> doSetRollbackOnly(TransactionSynchronizationManager synchronizationManager,
                                                              GenericReactiveTransaction status)
                                                       throws TransactionException

Overrides:

doSetRollbackOnly in class AbstractReactiveTransactionManager

Throws:

TransactionException

doCleanupAfterCompletion

protected reactor.core.publisher.Mono<Void> doCleanupAfterCompletion(TransactionSynchronizationManager synchronizationManager,
                                                                     Object transaction)

Overrides:

doCleanupAfterCompletion in class AbstractReactiveTransactionManager

setDatabaseFactory

public void setDatabaseFactory(ReactiveMongoDatabaseFactory databaseFactory)

Set the ReactiveMongoDatabaseFactory that this instance should manage transactions for.

Parameters:

databaseFactory - must not be null.

setOptions

public void setOptions(@Nullable
                       com.mongodb.TransactionOptions options)

Set the TransactionOptions to be applied when starting transactions.

Parameters:

options - can be null.

getDatabaseFactory

@Nullable
public ReactiveMongoDatabaseFactory getDatabaseFactory()

Get the ReactiveMongoDatabaseFactory that this instance manages transactions for.

Returns:

can be null.

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean