io.micronaut.retry.annotation.CircuitBreaker Maven / Gradle / Ivy
/*
* 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
*
* 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.retry.annotation;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import io.micronaut.aop.Around;
import io.micronaut.context.annotation.AliasFor;
import io.micronaut.context.annotation.Type;
import io.micronaut.retry.intercept.DefaultRetryInterceptor;
import javax.validation.constraints.Digits;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
/**
* Variation of {@link Retryable} that implements the Circuit Breaker pattern. Has higher overhead than
* {@link Retryable} as a {@link io.micronaut.retry.CircuitState} has to be maintained for each method call
*
* @author graemerocher
* @since 1.0
*/
@Documented
@Retention(RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Around
@Type(DefaultRetryInterceptor.class)
public @interface CircuitBreaker {
int MAX_RETRY_ATTEMPTS = 4;
/**
* @return The exception types to include (defaults to all)
*/
@AliasFor(annotation = Retryable.class, member = "includes")
Class[] includes() default {};
/**
* @return The exception types to exclude (defaults to none)
*/
@AliasFor(annotation = Retryable.class, member = "excludes")
Class[] excludes() default {};
/**
* @return The maximum number of retry attempts
*/
@Digits(integer = MAX_RETRY_ATTEMPTS, fraction = 0)
@AliasFor(annotation = Retryable.class, member = "attempts")
String attempts() default "3";
/**
* @return The delay between retry attempts
*/
@AliasFor(annotation = Retryable.class, member = "delay")
String delay() default "500ms";
/**
* @return The multiplier to use to calculate the delay between retries.
*/
@Digits(integer = 2, fraction = 2)
@AliasFor(annotation = Retryable.class, member = "multiplier")
String multiplier() default "0";
/**
* The maximum overall delay for an operation to complete until the Circuit state is set to
* {@link io.micronaut.retry.CircuitState#OPEN}.
*
* @return The maximum overall delay
*/
@AliasFor(annotation = Retryable.class, member = "maxDelay")
String maxDelay() default "5s";
/**
* Sets the {@link java.time.Duration} of time before resetting the circuit to
* {@link io.micronaut.retry.CircuitState#HALF_OPEN} allowing a single retry.
*
* @return The {@link java.time.Duration} of time before reset
*/
String reset() default "20s";
}