Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Announce end of support for this bundle, mark classes deprecated for visibility #48

Merged
merged 1 commit into from
Apr 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@
import io.github.resilience4j.timelimiter.TimeLimiterRegistry;
import io.github.resilience4j.timelimiter.internal.InMemoryTimeLimiterRegistry;

/**
* @deprecated See <a href="https://github.com/ExpediaGroup/dropwizard-resilience4j-bundle/blob/master/README.md">README.md</a>
*/
@Deprecated
public class Resilience4jBundle<T> implements ConfiguredBundle<T> {

private final Function<T, Resilience4jConfiguration> resiliencyConfiguratorFunction;
Expand All @@ -57,9 +61,11 @@ public class Resilience4jBundle<T> implements ConfiguredBundle<T> {

/**
* Create a new bundle
* @deprecated See <a href="https://github.com/ExpediaGroup/dropwizard-resilience4j-bundle/blob/master/README.md">README.md</a>
*
* @param resilienceConfiguratorFunction Function to extract the Resilience4j configuration from the dropwizard configuration
*/
@Deprecated
public Resilience4jBundle(@NonNull Function<T, Resilience4jConfiguration> resilienceConfiguratorFunction) {
this(resilienceConfiguratorFunction,
noOpConfigurator(),
Expand All @@ -68,11 +74,13 @@ public Resilience4jBundle(@NonNull Function<T, Resilience4jConfiguration> resili

/**
* Create a new bundle, with a function for modifying CircuitBreaker configurations
* @deprecated See <a href="https://github.com/ExpediaGroup/dropwizard-resilience4j-bundle/blob/master/README.md">README.md</a>
*
* @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<T, Resilience4jConfiguration> resilienceConfiguratorFunction,
@NonNull BiConsumer<String, CircuitBreakerConfig.Builder> circuitBreakerConfigurator,
@NonNull BiConsumer<String, RetryConfig.Builder> retryConfigurator) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@

/**
* A configuration for CircuitBreaker.
* @deprecated See <a href="https://github.com/ExpediaGroup/dropwizard-resilience4j-bundle/blob/master/README.md">README.md</a>
*/
@Deprecated
public class CircuitBreakerConfiguration {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@

/**
* Resilience4j configuration
* @deprecated See <a href="https://github.com/ExpediaGroup/dropwizard-resilience4j-bundle/blob/master/README.md">README.md</a>
*/
@Deprecated
public class Resilience4jConfiguration {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@

/**
* A configuration for TimeLimiter.
* @deprecated See <a href="https://github.com/ExpediaGroup/dropwizard-resilience4j-bundle/blob/master/README.md">README.md</a>
*/
@Deprecated
public class TimeLimiterConfiguration {

/**
Expand Down