org.springframework.data.mongodb

Class MongoTransactionManager

java.lang.Object

org.springframework.transaction.support.AbstractPlatformTransactionManager

org.springframework.data.mongodb.MongoTransactionManager

All Implemented Interfaces:

Serializable, InitializingBean, PlatformTransactionManager, ResourceTransactionManager, TransactionManager

public class MongoTransactionManager
extends AbstractPlatformTransactionManager
implements ResourceTransactionManager, InitializingBean

A PlatformTransactionManager implementation that manages ClientSession based transactions for a single MongoDbFactory.

Binds a ClientSession from the specified MongoDbFactory to the thread.

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 MongoDatabaseUtils.getDatabase(MongoDbFactory) instead of a standard MongoDbFactory.getDb() call. Spring classes such as MongoTemplate use this strategy implicitly.

By default failure of a commit operation raises a TransactionSystemException. One may override doCommit(MongoTransactionObject) to implement the Retry Commit Operation behavior as outlined in the MongoDB reference manual.

Since:

2.1

Author:

Christoph Strobl, Mark Paluch

See Also:

MongoDB Transaction Documentation, MongoDatabaseUtils.getDatabase(MongoDbFactory, SessionSynchronization), Serialized Form

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager

AbstractPlatformTransactionManager.SuspendedResourcesHolder

Field Summary

Fields inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager

logger, SYNCHRONIZATION_ALWAYS, SYNCHRONIZATION_NEVER, SYNCHRONIZATION_ON_ACTUAL_TRANSACTION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected void	doBegin(Object transaction, TransactionDefinition definition)
protected void	doCleanupAfterCompletion(Object transaction)
protected void	doCommit(DefaultTransactionStatus status)
protected void	doCommit(MongoTransactionManager.MongoTransactionObject transactionObject) Customization hook to perform an actual commit of the given transaction.
protected Object	doGetTransaction()
protected void	doResume(Object transaction, Object suspendedResources)
protected void	doRollback(DefaultTransactionStatus status)
protected void	doSetRollbackOnly(DefaultTransactionStatus status)
protected Object	doSuspend(Object transaction)
MongoDbFactory	getDbFactory() Get the MongoDbFactory that this instance manages transactions for.
MongoDbFactory	getResourceFactory()
protected boolean	isExistingTransaction(Object transaction)
void	setDbFactory(MongoDbFactory dbFactory) Set the MongoDbFactory 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.support.AbstractPlatformTransactionManager

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.transaction.PlatformTransactionManager

commit, getTransaction, rollback

Constructor Detail

MongoTransactionManager

public MongoTransactionManager()

Create a new MongoTransactionManager for bean-style usage.

Note:The db factory has to be set before using the instance. Use this constructor to prepare a MongoTransactionManager via a BeanFactory.

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

See Also:

setDbFactory(MongoDbFactory), AbstractPlatformTransactionManager.setTransactionSynchronization(int)

MongoTransactionManager

public MongoTransactionManager(MongoDbFactory dbFactory)

Create a new MongoTransactionManager obtaining sessions from the given MongoDbFactory.

Parameters:

dbFactory - must not be null.

MongoTransactionManager

public MongoTransactionManager(MongoDbFactory dbFactory,
                               @Nullable
                               com.mongodb.TransactionOptions options)

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

Parameters:

dbFactory - must not be null.

options - can be null.

Method Detail

doGetTransaction

protected Object doGetTransaction()
                           throws TransactionException

Specified by:

doGetTransaction in class AbstractPlatformTransactionManager

Throws:

TransactionException

isExistingTransaction

protected boolean isExistingTransaction(Object transaction)
                                 throws TransactionException

Overrides:

isExistingTransaction in class AbstractPlatformTransactionManager

Throws:

TransactionException

doBegin

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

Specified by:

doBegin in class AbstractPlatformTransactionManager

Throws:

TransactionException

doSuspend

protected Object doSuspend(Object transaction)
                    throws TransactionException

Overrides:

doSuspend in class AbstractPlatformTransactionManager

Throws:

TransactionException

doResume

protected void doResume(@Nullable
                        Object transaction,
                        Object suspendedResources)

Overrides:

doResume in class AbstractPlatformTransactionManager

doCommit

protected final void doCommit(DefaultTransactionStatus status)
                       throws TransactionException

Specified by:

doCommit in class AbstractPlatformTransactionManager

Throws:

TransactionException

doCommit

protected void doCommit(MongoTransactionManager.MongoTransactionObject transactionObject)
                 throws Exception

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.

 int retries = 3;
 do {
     try {
         transactionObject.commitTransaction();
         break;
     } catch (MongoException ex) {
         if (!ex.hasErrorLabel(MongoException.UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL)) {
             throw ex;
         }
     }
     Thread.sleep(500);
 } while (--retries > 0);
     

Parameters:

transactionObject - never null.

Throws:

Exception - in case of transaction errors.

doRollback

protected void doRollback(DefaultTransactionStatus status)
                   throws TransactionException

Specified by:

doRollback in class AbstractPlatformTransactionManager

Throws:

TransactionException

doSetRollbackOnly

protected void doSetRollbackOnly(DefaultTransactionStatus status)
                          throws TransactionException

Overrides:

doSetRollbackOnly in class AbstractPlatformTransactionManager

Throws:

TransactionException

doCleanupAfterCompletion

protected void doCleanupAfterCompletion(Object transaction)

Overrides:

doCleanupAfterCompletion in class AbstractPlatformTransactionManager

setDbFactory

public void setDbFactory(MongoDbFactory dbFactory)

Set the MongoDbFactory that this instance should manage transactions for.

Parameters:

dbFactory - 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.

getDbFactory

@Nullable
public MongoDbFactory getDbFactory()

Get the MongoDbFactory that this instance manages transactions for.

Returns:

can be null.

getResourceFactory

public MongoDbFactory getResourceFactory()

Specified by:

getResourceFactory in interface ResourceTransactionManager

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean