org.springframework.transaction.annotation

Annotation Type Transactional

@Target(value={TYPE,METHOD})
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
public @interface Transactional

Describes a transaction attribute on an individual method or on a class.

At the class level, this annotation applies as a default to all methods of the declaring class and its subclasses. Note that it does not apply to ancestor classes up the class hierarchy; methods need to be locally redeclared in order to participate in a subclass-level annotation.

This annotation type is generally directly comparable to Spring's RuleBasedTransactionAttribute class, and in fact AnnotationTransactionAttributeSource will directly convert the data to the latter class, so that Spring's transaction support code does not have to know about annotations. If no custom rollback rules apply, the transaction will roll back on RuntimeException and Error but not on checked exceptions.

For specific information about the semantics of this annotation's attributes, consult the TransactionDefinition and TransactionAttribute javadocs.

This annotation commonly works with thread-bound transactions managed by PlatformTransactionManager, exposing a transaction to all data access operations within the current execution thread. Note: This does NOT propagate to newly started threads within the method.

Alternatively, this annotation may demarcate a reactive transaction managed by ReactiveTransactionManager which uses the Reactor context instead of thread-local attributes. As a consequence, all participating data access operations need to execute within the same Reactor context in the same reactive pipeline.

Since:

1.2

Author:

Colin Sampaleanu, Juergen Hoeller, Sam Brannen

See Also:

TransactionAttribute, DefaultTransactionAttribute, RuleBasedTransactionAttribute

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Isolation	isolation The transaction isolation level.
Class<? extends Throwable>[]	noRollbackFor Defines zero (0) or more exception Classes, which must be subclasses of Throwable, indicating which exception types must not cause a transaction rollback.
String[]	noRollbackForClassName Defines zero (0) or more exception names (for exceptions which must be a subclass of Throwable) indicating which exception types must not cause a transaction rollback.
Propagation	propagation The transaction propagation type.
boolean	readOnly A boolean flag that can be set to true if the transaction is effectively read-only, allowing for corresponding optimizations at runtime.
Class<? extends Throwable>[]	rollbackFor Defines zero (0) or more exception classes, which must be subclasses of Throwable, indicating which exception types must cause a transaction rollback.
String[]	rollbackForClassName Defines zero (0) or more exception names (for exceptions which must be a subclass of Throwable), indicating which exception types must cause a transaction rollback.
int	timeout The timeout for this transaction (in seconds).
String	transactionManager A qualifier value for the specified transaction.
String	value Alias for transactionManager().

Element Detail

value

@AliasFor(value="transactionManager")
public abstract String value

Alias for transactionManager().

See Also:

transactionManager()

Default:

""

transactionManager

@AliasFor(value="value")
public abstract String transactionManager

A qualifier value for the specified transaction.

May be used to determine the target transaction manager, matching the qualifier value (or the bean name) of a specific TransactionManager bean definition.

Since:

4.2

See Also:

value(), PlatformTransactionManager, ReactiveTransactionManager

Default:

""

propagation

public abstract Propagation propagation

The transaction propagation type.

Defaults to Propagation.REQUIRED.

See Also:

TransactionDefinition.getPropagationBehavior()

Default:

org.springframework.transaction.annotation.Propagation.REQUIRED

isolation

public abstract Isolation isolation

The transaction isolation level.

Defaults to Isolation.DEFAULT.

Exclusively designed for use with Propagation.REQUIRED or Propagation.REQUIRES_NEW since it only applies to newly started transactions. Consider switching the "validateExistingTransactions" flag to "true" on your transaction manager if you'd like isolation level declarations to get rejected when participating in an existing transaction with a different isolation level.

See Also:

TransactionDefinition.getIsolationLevel(), AbstractPlatformTransactionManager.setValidateExistingTransaction(boolean)

Default:

org.springframework.transaction.annotation.Isolation.DEFAULT

timeout

public abstract int timeout

The timeout for this transaction (in seconds).

Defaults to the default timeout of the underlying transaction system.

Exclusively designed for use with Propagation.REQUIRED or Propagation.REQUIRES_NEW since it only applies to newly started transactions.

See Also:

TransactionDefinition.getTimeout()

Default:

-1

readOnly

public abstract boolean readOnly

A boolean flag that can be set to true if the transaction is effectively read-only, allowing for corresponding optimizations at runtime.

Defaults to false.

This just serves as a hint for the actual transaction subsystem; it will not necessarily cause failure of write access attempts. A transaction manager which cannot interpret the read-only hint will not throw an exception when asked for a read-only transaction but rather silently ignore the hint.

See Also:

TransactionDefinition.isReadOnly(), TransactionSynchronizationManager.isCurrentTransactionReadOnly()

Default:

false

rollbackFor

public abstract Class<? extends Throwable>[] rollbackFor

Defines zero (0) or more exception classes, which must be subclasses of Throwable, indicating which exception types must cause a transaction rollback.

By default, a transaction will be rolling back on RuntimeException and Error but not on checked exceptions (business exceptions). See DefaultTransactionAttribute.rollbackOn(Throwable) for a detailed explanation.

This is the preferred way to construct a rollback rule (in contrast to rollbackForClassName()), matching the exception class and its subclasses.

Similar to RollbackRuleAttribute.RollbackRuleAttribute(Class clazz).

See Also:

rollbackForClassName(), DefaultTransactionAttribute.rollbackOn(Throwable)

Default:

{}

rollbackForClassName

public abstract String[] rollbackForClassName

Defines zero (0) or more exception names (for exceptions which must be a subclass of Throwable), indicating which exception types must cause a transaction rollback.

This can be a substring of a fully qualified class name, with no wildcard support at present. For example, a value of "ServletException" would match javax.servlet.ServletException and its subclasses.

NB: Consider carefully how specific the pattern is and whether to include package information (which isn't mandatory). For example, "Exception" will match nearly anything and will probably hide other rules. "java.lang.Exception" would be correct if "Exception" were meant to define a rule for all checked exceptions. With more unusual Exception names such as "BaseBusinessException" there is no need to use a FQN.

Similar to RollbackRuleAttribute.RollbackRuleAttribute(String exceptionName).

See Also:

rollbackFor(), DefaultTransactionAttribute.rollbackOn(Throwable)

Default:

{}

noRollbackFor

public abstract Class<? extends Throwable>[] noRollbackFor

Defines zero (0) or more exception Classes, which must be subclasses of Throwable, indicating which exception types must not cause a transaction rollback.

This is the preferred way to construct a rollback rule (in contrast to noRollbackForClassName()), matching the exception class and its subclasses.

Similar to NoRollbackRuleAttribute.NoRollbackRuleAttribute(Class clazz).

See Also:

noRollbackForClassName(), DefaultTransactionAttribute.rollbackOn(Throwable)

Default:

{}

noRollbackForClassName

public abstract String[] noRollbackForClassName

Defines zero (0) or more exception names (for exceptions which must be a subclass of Throwable) indicating which exception types must not cause a transaction rollback.

See the description of rollbackForClassName() for further information on how the specified names are treated.

Similar to NoRollbackRuleAttribute.NoRollbackRuleAttribute(String exceptionName).

See Also:

noRollbackFor(), DefaultTransactionAttribute.rollbackOn(Throwable)

Default:

{}