io.micronaut.spring.tx.annotation.Transactional Maven / Gradle / Ivy
Show all versions of micronaut-spring Show documentation
/*
* Copyright 2017-2019 original authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.micronaut.spring.tx.annotation;
import io.micronaut.aop.Around;
import io.micronaut.context.annotation.AliasFor;
import io.micronaut.context.annotation.Type;
import io.micronaut.core.annotation.Blocking;
import org.springframework.transaction.TransactionDefinition;
import org.springframework.transaction.annotation.Isolation;
import org.springframework.transaction.annotation.Propagation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Describes transaction attributes on a method or class. This is a variation of Spring's
* {@link org.springframework.transaction.annotation.Transactional} that uses Micronaut AOP
*
* This annotation type is generally directly comparable to Spring's
* {@link org.springframework.transaction.interceptor.RuleBasedTransactionAttribute}
* class, and in fact {@link org.springframework.transaction.annotation.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 rules are relevant to the exception,
* it will be treated like
* {@link org.springframework.transaction.interceptor.DefaultTransactionAttribute}
* (rolling back on {@link RuntimeException} and {@link Error} but not on checked
* exceptions).
*
*
For specific information about the semantics of this annotation's attributes,
* consult the {@link org.springframework.transaction.TransactionDefinition} and
* {@link org.springframework.transaction.interceptor.TransactionAttribute} javadocs.
*
* @author Colin Sampaleanu
* @author Juergen Hoeller
* @author Sam Brannen
* @see org.springframework.transaction.interceptor.TransactionAttribute
* @see org.springframework.transaction.interceptor.DefaultTransactionAttribute
* @see org.springframework.transaction.interceptor.RuleBasedTransactionAttribute
* @since 1.2
*/
@SuppressWarnings("JavadocStyle")
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@Around
@Type(TransactionInterceptor.class)
@Blocking
public @interface Transactional {
/**
* Alias for {@link #transactionManager}.
*
* @return The transaction manager
* @see #transactionManager
*/
@AliasFor(annotation = org.springframework.transaction.annotation.Transactional.class, member = "transactionManager")
String value() default "";
/**
* 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
* {@link org.springframework.transaction.PlatformTransactionManager}
* bean definition.
*
* @return The transaction manager
* @see #value
* @since 4.2
*/
@AliasFor(annotation = org.springframework.transaction.annotation.Transactional.class, member = "value")
String transactionManager() default "";
/**
* The transaction propagation type.
*
Defaults to {@link Propagation#REQUIRED}.
*
* @return The propatation
* @see org.springframework.transaction.interceptor.TransactionAttribute#getPropagationBehavior()
*/
@AliasFor(annotation = org.springframework.transaction.annotation.Transactional.class, member = "propagation")
Propagation propagation() default Propagation.REQUIRED;
/**
* The transaction isolation level.
*
Defaults to {@link Isolation#DEFAULT}.
*
* @return The isolation level
* @see org.springframework.transaction.interceptor.TransactionAttribute#getIsolationLevel()
*/
@AliasFor(annotation = org.springframework.transaction.annotation.Transactional.class, member = "isolation")
Isolation isolation() default Isolation.DEFAULT;
/**
* The timeout for this transaction.
*
Defaults to the default timeout of the underlying transaction system.
*
* @return The timeout
* @see org.springframework.transaction.interceptor.TransactionAttribute#getTimeout()
*/
@AliasFor(annotation = org.springframework.transaction.annotation.Transactional.class, member = "timeout")
int timeout() default TransactionDefinition.TIMEOUT_DEFAULT;
/**
* {@code true} if the transaction is read-only.
*
Defaults to {@code 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.
*
* @return Whether is read-only transaction
* @see org.springframework.transaction.interceptor.TransactionAttribute#isReadOnly()
*/
@AliasFor(annotation = org.springframework.transaction.annotation.Transactional.class, member = "readOnly")
boolean readOnly() default false;
/**
* Defines zero (0) or more exception {@link Class classes}, which must be
* subclasses of {@link Throwable}, indicating which exception types must cause
* a transaction rollback.
*
By default, a transaction will be rolling back on {@link RuntimeException}
* and {@link Error} but not on checked exceptions (business exceptions). See
* {@link org.springframework.transaction.interceptor.DefaultTransactionAttribute#rollbackOn(Throwable)}
* for a detailed explanation.
*
This is the preferred way to construct a rollback rule (in contrast to
* {@link #rollbackForClassName}), matching the exception class and its subclasses.
*
Similar to {@link org.springframework.transaction.interceptor.RollbackRuleAttribute#RollbackRuleAttribute(Class clazz)}.
*
* @return Rollback for exceptions
* @see #rollbackForClassName
* @see org.springframework.transaction.interceptor.DefaultTransactionAttribute#rollbackOn(Throwable)
*/
@AliasFor(annotation = org.springframework.transaction.annotation.Transactional.class, member = "rollbackFor")
Class[] rollbackFor() default {};
/**
* Defines zero (0) or more exception names (for exceptions which must be a
* subclass of {@link 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 {@code "ServletException"} would
* match {@code 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,
* {@code "Exception"} will match nearly anything and will probably hide other
* rules. {@code "java.lang.Exception"} would be correct if {@code "Exception"}
* were meant to define a rule for all checked exceptions. With more unusual
* {@link Exception} names such as {@code "BaseBusinessException"} there is no
* need to use a FQN.
*
Similar to {@link org.springframework.transaction.interceptor.RollbackRuleAttribute#RollbackRuleAttribute(String exceptionName)}.
*
* @return Rollback for classname
* @see #rollbackFor
* @see org.springframework.transaction.interceptor.DefaultTransactionAttribute#rollbackOn(Throwable)
*/
@AliasFor(annotation = org.springframework.transaction.annotation.Transactional.class, member = "rollbackForClassName")
String[] rollbackForClassName() default {};
/**
* Defines zero (0) or more exception {@link Class Classes}, which must be
* subclasses of {@link Throwable}, indicating which exception types must
* not cause a transaction rollback.
*
This is the preferred way to construct a rollback rule (in contrast
* to {@link #noRollbackForClassName}), matching the exception class and
* its subclasses.
*
Similar to {@link org.springframework.transaction.interceptor.NoRollbackRuleAttribute#NoRollbackRuleAttribute(Class clazz)}.
*
* @return Do not rollback for exceptions
* @see #noRollbackForClassName
* @see org.springframework.transaction.interceptor.DefaultTransactionAttribute#rollbackOn(Throwable)
*/
@AliasFor(annotation = org.springframework.transaction.annotation.Transactional.class, member = "rollbackOn")
Class[] noRollbackFor() default {};
/**
* Defines zero (0) or more exception names (for exceptions which must be a
* subclass of {@link Throwable}) indicating which exception types must not
* cause a transaction rollback.
*
See the description of {@link #rollbackForClassName} for further
* information on how the specified names are treated.
*
Similar to {@link org.springframework.transaction.interceptor.NoRollbackRuleAttribute#NoRollbackRuleAttribute(String exceptionName)}.
*
* @return Do not rollback for class name
* @see #noRollbackFor
* @see org.springframework.transaction.interceptor.DefaultTransactionAttribute#rollbackOn(Throwable)
*/
@AliasFor(annotation = org.springframework.transaction.annotation.Transactional.class, member = "noRollbackForClassName")
String[] noRollbackForClassName() default {};
}