Package org.springframework.data.mongodb

Enum Class SessionSynchronization

java.lang.Object

java.lang.Enum<SessionSynchronization>

org.springframework.data.mongodb.SessionSynchronization

All Implemented Interfaces:

Serializable, Comparable<SessionSynchronization>, Constable

public enum SessionSynchronization
extends Enum<SessionSynchronization>

SessionSynchronization is used along with MongoTemplate to define in which type of transactions to participate if any.

Since:

2.1

Author:

Christoph Strobl, Mark Paluch

See Also:

• MongoTemplate.setSessionSynchronization(SessionSynchronization)
• MongoDatabaseUtils.getDatabase(MongoDatabaseFactory, SessionSynchronization)
• ReactiveMongoTemplate.setSessionSynchronization(SessionSynchronization)
• ReactiveMongoDatabaseUtils.getDatabase(ReactiveMongoDatabaseFactory, SessionSynchronization)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS	Synchronize with any transaction even with empty transactions and initiate a MongoDB transaction when doing so by registering a MongoDB specific ResourceHolderSynchronization.
NEVER	Do not participate in ongoing transactions.
ON_ACTUAL_TRANSACTION	Synchronize with native MongoDB transactions initiated via MongoTransactionManager.

Method Summary

Modifier and Type	Method	Description
static SessionSynchronization	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SessionSynchronization[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALWAYS

public static final SessionSynchronization ALWAYS

Synchronize with any transaction even with empty transactions and initiate a MongoDB transaction when doing so by registering a MongoDB specific ResourceHolderSynchronization.

ON_ACTUAL_TRANSACTION

public static final SessionSynchronization ON_ACTUAL_TRANSACTION

Synchronize with native MongoDB transactions initiated via MongoTransactionManager.

NEVER

public static final SessionSynchronization NEVER

Do not participate in ongoing transactions.

Since:

3.2.5

Method Details

values

public static SessionSynchronization[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SessionSynchronization valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null