io.micronaut.retry.annotation.Recoverable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-retry Show documentation

Natively Cloud Native

The newest version!

/*
 * 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.retry.annotation;

import io.micronaut.aop.Around;
import io.micronaut.context.annotation.Type;
import io.micronaut.retry.intercept.RecoveryInterceptor;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * AOP around advice that can be applied to any type or method that requires {@link Fallback} handling.
 *
 * When applied to a type if an exception occurs this advice will attempt to resolve an implementation of the
 * class that is annotated with {@link Fallback}
 *
 * @author graemerocher
 * @since 1.0
 */
@Documented
@Retention(RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Around
@Type(RecoveryInterceptor.class)
public @interface Recoverable {
    /**
     * Used to specify the API to lookup fallbacks for. This is useful in cases
     * where the fallback is not a direct subclass of the implementation.
     *
     * @return The API to look up a fallback for
     * @see Fallback
     * @since 2.0.0
     */
    Class api() default void.class;
}