Package io.quarkus.narayana.jta

Enum Class TransactionSemantics

java.lang.Object

java.lang.Enum<TransactionSemantics>

io.quarkus.narayana.jta.TransactionSemantics

All Implemented Interfaces:

Serializable, Comparable<TransactionSemantics>, Constable

public enum TransactionSemantics
extends Enum<TransactionSemantics>

Enum that can be used to control the transaction behaviour in the presence or absence of an existing transaction.

See Also:

• QuarkusTransaction.joiningExisting()
• QuarkusTransaction.requiringNew()
• QuarkusTransaction.disallowingExisting()
• QuarkusTransaction.suspendingExisting()
• QuarkusTransaction.runner(TransactionSemantics)

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
DISALLOW_EXISTING	If a transaction is already associated with the current thread a QuarkusTransactionException will be thrown, otherwise a new transaction is started, and follows all the normal lifecycle rules.
JOIN_EXISTING	If no transaction is active then a new transaction will be started, and committed when the method ends.
REQUIRE_NEW	If an existing transaction is already associated with the current thread then the transaction is suspended, then a new transaction is started which follows all the normal lifecycle rules, and when it's complete the original transaction is resumed.
SUSPEND_EXISTING	If no transaction is active then these semantics are basically a no-op.

Method Summary

Modifier and Type	Method	Description
static TransactionSemantics	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TransactionSemantics[]	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

DISALLOW_EXISTING

public static final TransactionSemantics DISALLOW_EXISTING

If a transaction is already associated with the current thread a QuarkusTransactionException will be thrown, otherwise a new transaction is started, and follows all the normal lifecycle rules.

See Also:

• QuarkusTransaction.disallowingExisting()
• QuarkusTransaction.runner(TransactionSemantics)

JOIN_EXISTING

public static final TransactionSemantics JOIN_EXISTING

If no transaction is active then a new transaction will be started, and committed when the method ends. If an exception is thrown the exception handler registered by TransactionRunnerOptions.exceptionHandler(Function) will be called to decide if the TX should be committed or rolled back.

If an existing transaction is active then the method is run in the context of the existing transaction. If an exception is thrown the exception handler will be called, however a result of TransactionExceptionResult.ROLLBACK will result in the TX marked as rollback only, while a result of TransactionExceptionResult.COMMIT will result in no action being taken.

See Also:

• QuarkusTransaction.joiningExisting()
• QuarkusTransaction.runner(TransactionSemantics)

REQUIRE_NEW

public static final TransactionSemantics REQUIRE_NEW

If an existing transaction is already associated with the current thread then the transaction is suspended, then a new transaction is started which follows all the normal lifecycle rules, and when it's complete the original transaction is resumed.

Otherwise, a new transaction is started, and follows all the normal lifecycle rules.

See Also:

• QuarkusTransaction.requiringNew()
• QuarkusTransaction.runner(TransactionSemantics)

SUSPEND_EXISTING

public static final TransactionSemantics SUSPEND_EXISTING

If no transaction is active then these semantics are basically a no-op.

If a transaction is active then it is suspended, and resumed after the task is run.

The exception handler will never be consulted when these semantics are in use, specifying both an exception handler and these semantics are considered an error.

These semantics allows for code to easily be run outside the scope of a transaction.

See Also:

• QuarkusTransaction.suspendingExisting()
• QuarkusTransaction.runner(TransactionSemantics)

Method Details

values

public static TransactionSemantics[] 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 TransactionSemantics 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