io.micronaut.transaction.annotation.ReadOnly Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-data-tx Show documentation
Data Repository Support for Micronaut
There is a newer version: 4.9.3
/*
 * Copyright 2017-2020 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
 *
 * https://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.transaction.annotation;

import io.micronaut.context.annotation.AliasFor;
import io.micronaut.transaction.TransactionDefinition;

import java.lang.annotation.*;

/**
 * Stereotype annotation for demarcating a read-only transaction. Since the
 * {@code jakarta.transaction.Transactional}
 *
 * @author graemerocher
 * @since 1.0.0
 */
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Transactional(readOnly = true)
public @interface ReadOnly {
    /**
     * Alias for {@link #transactionManager}.
     *
     * @return The transaction manager
     * @see #transactionManager
     */
    @AliasFor(annotation = Transactional.class, member = "value")
    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 io.micronaut.transaction.SynchronousTransactionManager}
     * bean definition.
     *
     * @return The transaction manager
     * @see #value
     */
    @AliasFor(annotation = Transactional.class, member = "value")
    String transactionManager() default "";

    /**
     * The transaction propagation type.
     * 
Defaults to {@link TransactionDefinition.Propagation#REQUIRED}.
     *
     * @return The propagation
     */
    @AliasFor(annotation = Transactional.class, member = "propagation")
    TransactionDefinition.Propagation propagation() default TransactionDefinition.Propagation.REQUIRED;

    /**
     * The transaction isolation level.
     * 
Defaults to {@link TransactionDefinition.Isolation#DEFAULT}.
     *
     * @return The isolation level
     */
    @AliasFor(annotation = Transactional.class, member = "isolation")
    TransactionDefinition.Isolation isolation() default TransactionDefinition.Isolation.DEFAULT;

    /**
     * The timeout for this transaction.
     * Defaults to the default timeout of the underlying transaction system.
     *
     * @return The timeout
     */
    @AliasFor(annotation = Transactional.class, member = "timeout")
    int timeout() default -1;

    /**
     * Defines the exceptions that will not result in a rollback.
     * @return The exception types that will not result in a rollback.
     */
    @AliasFor(annotation = Transactional.class, member = "noRollbackFor")
    Class[] noRollbackFor() default {};
}