io.quarkus.vertx.SafeVertxContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of quarkus-vertx Show documentation

Write reactive applications with the Vert.x API

There is a newer version: 3.17.5

package io.quarkus.vertx;

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;

import jakarta.enterprise.util.Nonbinding;
import jakarta.interceptor.InterceptorBinding;

/**
 * Indicates that the annotated method should be invoked on a safe duplicated context.
 * This interceptor binding is a declarative alternative to the {@link VertxContextSafetyToggle}.
 * 
 * Important: You must only use this annotation if the annotated method does not access the context
 * concurrently.
 * 
 * If the method is not run on a duplicated context, the interceptor fails.
 * If the method is invoked on an unmarked duplicated context, the context is marked as `safe` and the method is called.
 * If the method is invoked on a `safe` duplicated context, the method is called.
 * If the method is invoked on an `unsafe` duplicated context, the interceptor fails, except if {@link #force()} is
 * set to {@code true}. In this case, the duplicated context is marked as `safe` and the method is called.
 */
@InterceptorBinding
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD, ElementType.CONSTRUCTOR })
@Inherited
public @interface SafeVertxContext {

    /**
     * @return whether the current safety flag of the current context must be overridden.
     */
    @Nonbinding
    boolean force() default false;
}