From 311afda6bc11a87de1ceb1cabe7aac3e57ddf528 Mon Sep 17 00:00:00 2001 From: Jordan Lopez Date: Thu, 20 Apr 2023 16:02:11 -0500 Subject: [PATCH] fix: Announce end of support for this bundle, mark classes as deprecated for visibility. --- README.md | 5 ++++- .../dropwizard/resilience4j/Resilience4jBundle.java | 8 ++++++++ .../configuration/CircuitBreakerConfiguration.java | 2 ++ .../configuration/Resilience4jConfiguration.java | 2 ++ .../configuration/TimeLimiterConfiguration.java | 2 ++ 5 files changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c0405d4..350221c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,11 @@ -dropwizard-resilience4j-bundle +dropwizard-resilience4j-bundle (DEPRECATED) ============================== [![Release](https://github.com/ExpediaGroup/dropwizard-resilience4j-bundle/actions/workflows/release.yml/badge.svg)](https://github.com/ExpediaGroup/dropwizard-resilience4j-bundle/actions/workflows/release.yml) +**DEPRECATED: We no longer maintain dropwizard-resilience4j-bundle. If you have questions or concerns, please open an +issue or fork this repository.** + Lightweight integration of Resilience4J into Dropwizard configuration and metrics. Does not provide any other services - actually _using_ all the Resilience4j stuff is up to you. The [R4J documentation](https://resilience4j.readme.io/docs) is pretty good. diff --git a/src/main/java/com/expediagroup/dropwizard/resilience4j/Resilience4jBundle.java b/src/main/java/com/expediagroup/dropwizard/resilience4j/Resilience4jBundle.java index feef626..d571d63 100644 --- a/src/main/java/com/expediagroup/dropwizard/resilience4j/Resilience4jBundle.java +++ b/src/main/java/com/expediagroup/dropwizard/resilience4j/Resilience4jBundle.java @@ -47,6 +47,10 @@ import io.github.resilience4j.timelimiter.TimeLimiterRegistry; import io.github.resilience4j.timelimiter.internal.InMemoryTimeLimiterRegistry; +/** + * @deprecated See README.md + */ +@Deprecated public class Resilience4jBundle implements ConfiguredBundle { private final Function resiliencyConfiguratorFunction; @@ -57,9 +61,11 @@ public class Resilience4jBundle implements ConfiguredBundle { /** * Create a new bundle + * @deprecated See README.md * * @param resilienceConfiguratorFunction Function to extract the Resilience4j configuration from the dropwizard configuration */ + @Deprecated public Resilience4jBundle(@NonNull Function resilienceConfiguratorFunction) { this(resilienceConfiguratorFunction, noOpConfigurator(), @@ -68,11 +74,13 @@ public Resilience4jBundle(@NonNull Function resili /** * Create a new bundle, with a function for modifying CircuitBreaker configurations + * @deprecated See README.md * * @param resilienceConfiguratorFunction Function to extract the Resilience4j configuration from the dropwizard configuration * @param circuitBreakerConfigurator A function that will be passed the name and builder for each circuit breaker before it is created * @param retryConfigurator A function that will be passed the name and builder for each retryer */ + @Deprecated public Resilience4jBundle(@NonNull Function resilienceConfiguratorFunction, @NonNull BiConsumer circuitBreakerConfigurator, @NonNull BiConsumer retryConfigurator) { diff --git a/src/main/java/com/expediagroup/dropwizard/resilience4j/configuration/CircuitBreakerConfiguration.java b/src/main/java/com/expediagroup/dropwizard/resilience4j/configuration/CircuitBreakerConfiguration.java index 92fe422..64da0ef 100644 --- a/src/main/java/com/expediagroup/dropwizard/resilience4j/configuration/CircuitBreakerConfiguration.java +++ b/src/main/java/com/expediagroup/dropwizard/resilience4j/configuration/CircuitBreakerConfiguration.java @@ -23,7 +23,9 @@ /** * A configuration for CircuitBreaker. + * @deprecated See README.md */ +@Deprecated public class CircuitBreakerConfiguration { /** diff --git a/src/main/java/com/expediagroup/dropwizard/resilience4j/configuration/Resilience4jConfiguration.java b/src/main/java/com/expediagroup/dropwizard/resilience4j/configuration/Resilience4jConfiguration.java index c5eedf0..76f5a75 100644 --- a/src/main/java/com/expediagroup/dropwizard/resilience4j/configuration/Resilience4jConfiguration.java +++ b/src/main/java/com/expediagroup/dropwizard/resilience4j/configuration/Resilience4jConfiguration.java @@ -29,7 +29,9 @@ /** * Resilience4j configuration + * @deprecated See README.md */ +@Deprecated public class Resilience4jConfiguration { /** diff --git a/src/main/java/com/expediagroup/dropwizard/resilience4j/configuration/TimeLimiterConfiguration.java b/src/main/java/com/expediagroup/dropwizard/resilience4j/configuration/TimeLimiterConfiguration.java index aabb967..34fc8ac 100644 --- a/src/main/java/com/expediagroup/dropwizard/resilience4j/configuration/TimeLimiterConfiguration.java +++ b/src/main/java/com/expediagroup/dropwizard/resilience4j/configuration/TimeLimiterConfiguration.java @@ -23,7 +23,9 @@ /** * A configuration for TimeLimiter. + * @deprecated See README.md */ +@Deprecated public class TimeLimiterConfiguration { /**