Skip to content

Commit 906d8df

Browse files
committed
Moving from withMaxAttempts to withMaxRetries
1 parent 149218e commit 906d8df

File tree

4 files changed

+16
-16
lines changed

4 files changed

+16
-16
lines changed

docs/modules/ROOT/pages/spring-cloud-circuitbreaker-framework-retry.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ To provide a default configuration for all of your circuit breakers, create a `C
4242
@Bean
4343
public Customizer<FrameworkRetryCircuitBreakerFactory> defaultCustomizer() {
4444
return factory -> factory.configureDefault(id -> new FrameworkRetryConfigBuilder(id)
45-
.retryPolicy(RetryPolicy.withMaxAttempts(3))
45+
.retryPolicy(RetryPolicy.withMaxRetries(3))
4646
.openTimeout(Duration.ofSeconds(20))
4747
.resetTimeout(Duration.ofSeconds(5))
4848
.build());
@@ -69,7 +69,7 @@ Similarly to providing a default configuration, you can create a `Customizer` be
6969
@Bean
7070
public Customizer<FrameworkRetryCircuitBreakerFactory> slowCustomizer() {
7171
return factory -> factory.configure(builder -> builder
72-
.retryPolicy(RetryPolicy.withMaxAttempts(1))
72+
.retryPolicy(RetryPolicy.withMaxRetries(1))
7373
.openTimeout(Duration.ofSeconds(30))
7474
.resetTimeout(Duration.ofSeconds(10))
7575
.build(), "slow");
@@ -81,7 +81,7 @@ public Customizer<FrameworkRetryCircuitBreakerFactory> slowCustomizer() {
8181

8282
Spring Framework 7 provides several built-in retry policies that can be used with the Framework Retry circuit breaker:
8383

84-
* `RetryPolicy.withMaxAttempts(int)` - Retries a fixed number of times
84+
* `RetryPolicy.withMaxRetries(int)` - Retries a fixed number of times
8585
* `RetryPolicy.withMaxDuration(Duration)` - Retries until a maximum duration is reached
8686
* `RetryPolicy.withBackoff(Duration, double)` - Retries with exponential backoff
8787
* `RetryPolicy.forExceptions(Class<?>...)` - Retries only for specific exception types
@@ -93,7 +93,7 @@ You can also combine policies using `and()` and `or()` operators:
9393
@Bean
9494
public Customizer<FrameworkRetryCircuitBreakerFactory> customRetryPolicy() {
9595
return factory -> factory.configureDefault(id -> new FrameworkRetryConfigBuilder(id)
96-
.retryPolicy(RetryPolicy.withMaxAttempts(3)
96+
.retryPolicy(RetryPolicy.withMaxRetries(3)
9797
.and(RetryPolicy.withMaxDuration(Duration.ofSeconds(5)))
9898
.forExceptions(IOException.class, TimeoutException.class))
9999
.build());
@@ -151,7 +151,7 @@ public class CircuitBreakerConfiguration {
151151
return factory -> {
152152
// Default configuration for all circuit breakers
153153
factory.configureDefault(id -> new FrameworkRetryConfigBuilder(id)
154-
.retryPolicy(RetryPolicy.withMaxAttempts(3)
154+
.retryPolicy(RetryPolicy.withMaxRetries(3)
155155
.withBackoff(Duration.ofMillis(100), 2.0))
156156
.openTimeout(Duration.ofSeconds(20))
157157
.resetTimeout(Duration.ofSeconds(5))
@@ -164,14 +164,14 @@ public class CircuitBreakerConfiguration {
164164
return factory -> {
165165
// Specific configuration for "slow" circuit breaker
166166
factory.configure(builder -> builder
167-
.retryPolicy(RetryPolicy.withMaxAttempts(1))
167+
.retryPolicy(RetryPolicy.withMaxRetries(1))
168168
.openTimeout(Duration.ofSeconds(30))
169169
.resetTimeout(Duration.ofSeconds(10))
170170
.build(), "slow");
171171
172172
// Specific configuration for "critical" circuit breaker
173173
factory.configure(builder -> builder
174-
.retryPolicy(RetryPolicy.withMaxAttempts(5))
174+
.retryPolicy(RetryPolicy.withMaxRetries(5))
175175
.openTimeout(Duration.ofMinutes(2))
176176
.resetTimeout(Duration.ofSeconds(15))
177177
.build(), "critical");

spring-cloud-circuitbreaker-framework-retry/src/test/java/org/springframework/cloud/circuitbreaker/retry/FrameworkRetryCircuitBreakerFactoryTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ void testConfigBuilder() {
9191

9292
assertThat(builder).isNotNull();
9393

94-
FrameworkRetryConfig config = builder.retryPolicy(RetryPolicy.withMaxAttempts(5))
94+
FrameworkRetryConfig config = builder.retryPolicy(RetryPolicy.withMaxRetries(5))
9595
.openTimeout(Duration.ofSeconds(15))
9696
.resetTimeout(Duration.ofSeconds(3))
9797
.build();

spring-cloud-circuitbreaker-framework-retry/src/test/java/org/springframework/cloud/circuitbreaker/retry/FrameworkRetryCircuitBreakerIntegrationTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ static class TestConfiguration {
111111
public Customizer<FrameworkRetryCircuitBreakerFactory> customizer() {
112112
return factory -> {
113113
factory.configureDefault(
114-
id -> new FrameworkRetryConfigBuilder(id).retryPolicy(RetryPolicy.withMaxAttempts(2))
114+
id -> new FrameworkRetryConfigBuilder(id).retryPolicy(RetryPolicy.withMaxRetries(2))
115115
.openTimeout(Duration.ofMillis(100))
116116
.resetTimeout(Duration.ofSeconds(5))
117117
.build());

spring-cloud-circuitbreaker-framework-retry/src/test/java/org/springframework/cloud/circuitbreaker/retry/FrameworkRetryCircuitBreakerTest.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ void testRunWithRetry() {
5757
// Test that retries are attempted successfully
5858
AtomicInteger attempts = new AtomicInteger(0);
5959
FrameworkRetryConfig config = new FrameworkRetryConfigBuilder("test")
60-
.retryPolicy(RetryPolicy.withMaxAttempts(2)) // 1 initial + 2 retries = 3
60+
.retryPolicy(RetryPolicy.withMaxRetries(2)) // 1 initial + 2 retries = 3
6161
// attempts
6262
.build();
6363
FrameworkRetryCircuitBreaker circuitBreaker = new FrameworkRetryCircuitBreaker("test", config);
@@ -82,7 +82,7 @@ void testRunWithRetry() {
8282
void testCircuitOpensAfterSingleFailedExecution() {
8383
// Use no retries so a single failure causes the circuit to open
8484
FrameworkRetryConfig config = new FrameworkRetryConfigBuilder("test")
85-
.retryPolicy(RetryPolicy.withMaxAttempts(0))
85+
.retryPolicy(RetryPolicy.withMaxRetries(0))
8686
.openTimeout(Duration.ofSeconds(20))
8787
.resetTimeout(Duration.ofSeconds(5))
8888
.build();
@@ -99,7 +99,7 @@ void testCircuitOpensAfterSingleFailedExecution() {
9999
@Test
100100
void testCircuitBreakerOpenReturnsFallback() {
101101
FrameworkRetryConfig config = new FrameworkRetryConfigBuilder("test")
102-
.retryPolicy(RetryPolicy.withMaxAttempts(0))
102+
.retryPolicy(RetryPolicy.withMaxRetries(0))
103103
.openTimeout(Duration.ofSeconds(20))
104104
.resetTimeout(Duration.ofSeconds(5))
105105
.build();
@@ -126,7 +126,7 @@ void testCircuitBreakerOpenReturnsFallback() {
126126
@Test
127127
void testCircuitHalfOpenAfterTimeout() throws InterruptedException {
128128
FrameworkRetryConfig config = new FrameworkRetryConfigBuilder("test")
129-
.retryPolicy(RetryPolicy.withMaxAttempts(0))
129+
.retryPolicy(RetryPolicy.withMaxRetries(0))
130130
.openTimeout(Duration.ofMillis(100))
131131
.resetTimeout(Duration.ofSeconds(5))
132132
.build();
@@ -152,7 +152,7 @@ void testCircuitHalfOpenAfterTimeout() throws InterruptedException {
152152
@Test
153153
void testCircuitReopensOnFailureInHalfOpen() throws InterruptedException {
154154
FrameworkRetryConfig config = new FrameworkRetryConfigBuilder("test")
155-
.retryPolicy(RetryPolicy.withMaxAttempts(0))
155+
.retryPolicy(RetryPolicy.withMaxRetries(0))
156156
.openTimeout(Duration.ofMillis(100))
157157
.resetTimeout(Duration.ofSeconds(5))
158158
.build();
@@ -191,7 +191,7 @@ void testGettersReturnCorrectValues() {
191191
void testCircuitOpensAfterAllRetriesExhausted() {
192192
// With retries enabled, circuit opens after all retries are exhausted
193193
FrameworkRetryConfig config = new FrameworkRetryConfigBuilder("test")
194-
.retryPolicy(RetryPolicy.withMaxAttempts(2))
194+
.retryPolicy(RetryPolicy.withMaxRetries(2))
195195
.openTimeout(Duration.ofSeconds(20))
196196
.resetTimeout(Duration.ofSeconds(5))
197197
.build();
@@ -209,7 +209,7 @@ void testCircuitOpensAfterAllRetriesExhausted() {
209209
@Test
210210
void testResetTimeoutClosesCircuit() throws InterruptedException {
211211
FrameworkRetryConfig config = new FrameworkRetryConfigBuilder("test")
212-
.retryPolicy(RetryPolicy.withMaxAttempts(0))
212+
.retryPolicy(RetryPolicy.withMaxRetries(0))
213213
.openTimeout(Duration.ofSeconds(20))
214214
.resetTimeout(Duration.ofMillis(100))
215215
.build();

0 commit comments

Comments
 (0)