diff --git a/README.adoc b/README.adoc index bab2b0f..8600dcc 100644 --- a/README.adoc +++ b/README.adoc @@ -4,6 +4,7 @@ Manual changes to this file will be lost when it is generated again. Edit the files in the src/main/asciidoc/ directory instead. //// + :doctype: book :idprefix: :idseparator: - @@ -65,10 +66,10 @@ The `configureDefault` method can be used to provide a default configuration. ---- @Bean public Customizer defaultCustomizer() { - return factory -> factory.configureDefault(id -> new Resilience4JConfigBuilder(id) - .timeLimiterConfig(TimeLimiterConfig.custom().timeoutDuration(Duration.ofSeconds(4)).build()) - .circuitBreakerConfig(CircuitBreakerConfig.ofDefaults()) - .build()); + return factory -> factory.configureDefault(id -> new Resilience4JConfigBuilder(id) + .timeLimiterConfig(TimeLimiterConfig.custom().timeoutDuration(Duration.ofSeconds(4)).build()) + .circuitBreakerConfig(CircuitBreakerConfig.ofDefaults()) + .build()); } ---- ==== @@ -80,9 +81,9 @@ public Customizer defaultCustomizer() { ---- @Bean public Customizer defaultCustomizer() { - return factory -> factory.configureDefault(id -> new Resilience4JConfigBuilder(id) - .circuitBreakerConfig(CircuitBreakerConfig.ofDefaults()) - .timeLimiterConfig(TimeLimiterConfig.custom().timeoutDuration(Duration.ofSeconds(4)).build()).build()); + return factory -> factory.configureDefault(id -> new Resilience4JConfigBuilder(id) + .circuitBreakerConfig(CircuitBreakerConfig.ofDefaults()) + .timeLimiterConfig(TimeLimiterConfig.custom().timeoutDuration(Duration.ofSeconds(4)).build()).build()); } ---- ==== @@ -97,8 +98,8 @@ Similarly to providing a default configuration, you can create a `Customize` bea ---- @Bean public Customizer slowCustomizer() { - return factory -> factory.configure(builder -> builder.circuitBreakerConfig(CircuitBreakerConfig.ofDefaults()) - .timeLimiterConfig(TimeLimiterConfig.custom().timeoutDuration(Duration.ofSeconds(2)).build()), "slow"); + return factory -> factory.configure(builder -> builder.circuitBreakerConfig(CircuitBreakerConfig.ofDefaults()) + .timeLimiterConfig(TimeLimiterConfig.custom().timeoutDuration(Duration.ofSeconds(2)).build()), "slow"); } ---- ==== @@ -113,8 +114,8 @@ This can be useful for adding event handlers to Resilience4J circuit breakers. ---- @Bean public Customizer slowCustomizer() { - return factory -> factory.addCircuitBreakerCustomizer(circuitBreaker -> circuitBreaker.getEventPublisher() - .onError(normalFluxErrorConsumer).onSuccess(normalFluxSuccessConsumer), "normalflux"); + return factory -> factory.addCircuitBreakerCustomizer(circuitBreaker -> circuitBreaker.getEventPublisher() + .onError(normalFluxErrorConsumer).onSuccess(normalFluxSuccessConsumer), "normalflux"); } ---- ==== @@ -126,12 +127,12 @@ public Customizer slowCustomizer() { ---- @Bean public Customizer slowCusomtizer() { - return factory -> { - factory.configure(builder -> builder - .timeLimiterConfig(TimeLimiterConfig.custom().timeoutDuration(Duration.ofSeconds(2)).build()) - .circuitBreakerConfig(CircuitBreakerConfig.ofDefaults()), "slow", "slowflux"); - factory.addCircuitBreakerCustomizer(circuitBreaker -> circuitBreaker.getEventPublisher() - .onError(normalFluxErrorConsumer).onSuccess(normalFluxSuccessConsumer), "normalflux"); + return factory -> { + factory.configure(builder -> builder + .timeLimiterConfig(TimeLimiterConfig.custom().timeoutDuration(Duration.ofSeconds(2)).build()) + .circuitBreakerConfig(CircuitBreakerConfig.ofDefaults()), "slow", "slowflux"); + factory.addCircuitBreakerCustomizer(circuitBreaker -> circuitBreaker.getEventPublisher() + .onError(normalFluxErrorConsumer).onSuccess(normalFluxSuccessConsumer), "normalflux"); }; } ---- @@ -167,8 +168,8 @@ The `configureDefault` method can be used to provide a default configuration. ---- @Bean public Customizer defaultCustomizer() { - return factory -> factory.configureDefault(id -> new SpringRetryConfigBuilder(id) - .retryPolicy(new TimeoutRetryPolicy()).build()); + return factory -> factory.configureDefault(id -> new SpringRetryConfigBuilder(id) + .retryPolicy(new TimeoutRetryPolicy()).build()); } ---- ==== @@ -183,7 +184,7 @@ Similarly to providing a default configuration, you can create a `Customize` bea ---- @Bean public Customizer slowCustomizer() { - return factory -> factory.configure(builder -> builder.retryPolicy(new SimpleRetryPolicy(1)).build(), "slow"); + return factory -> factory.configure(builder -> builder.retryPolicy(new SimpleRetryPolicy(1)).build(), "slow"); } ---- ==== @@ -198,23 +199,23 @@ This can be useful for adding event handlers to the `RetryTemplate`. ---- @Bean public Customizer slowCustomizer() { - return factory -> factory.addRetryTemplateCustomizers(retryTemplate -> retryTemplate.registerListener(new RetryListener() { + return factory -> factory.addRetryTemplateCustomizers(retryTemplate -> retryTemplate.registerListener(new RetryListener() { - @Override - public boolean open(RetryContext context, RetryCallback callback) { - return false; - } + @Override + public boolean open(RetryContext context, RetryCallback callback) { + return false; + } - @Override - public void close(RetryContext context, RetryCallback callback, Throwable throwable) { + @Override + public void close(RetryContext context, RetryCallback callback, Throwable throwable) { - } + } - @Override - public void onError(RetryContext context, RetryCallback callback, Throwable throwable) { + @Override + public void onError(RetryContext context, RetryCallback callback, Throwable throwable) { - } - })); + } + })); } ---- ==== @@ -283,6 +284,11 @@ https://eclipse.org[Eclipse] when working with the code. We use the https://eclipse.org/m2e/[m2eclipse] eclipse plugin for maven support. Other IDEs and tools should also work without issue as long as they use Maven 3.3.3 or better. +==== Activate the Spring Maven profile +Spring Cloud projects require the 'spring' Maven profile to be activated to resolve +the spring milestone and snapshot repositories. Use your preferred IDE to set this +profile to be active, or you may experience build errors. + ==== Importing into eclipse with m2eclipse We recommend the https://eclipse.org/m2e/[m2eclipse] eclipse plugin when working with eclipse. If you don't already have m2eclipse installed it is available from the "eclipse @@ -491,4 +497,4 @@ Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. There click on t - `checkstyle.suppressions.file` - default suppressions. Please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` URL. - `checkstyle.additional.suppressions.file` - this variable corresponds to suppressions in your local project. E.g. you're working on `spring-cloud-contract`. Then point to the `project-root/src/checkstyle/checkstyle-suppressions.xml` folder. Example for `spring-cloud-contract` would be: `/home/username/spring-cloud-contract/src/checkstyle/checkstyle-suppressions.xml`. -IMPORTANT: Remember to set the `Scan Scope` to `All sources` since we apply checkstyle rules for production and test sources. \ No newline at end of file +IMPORTANT: Remember to set the `Scan Scope` to `All sources` since we apply checkstyle rules for production and test sources. diff --git a/docs/pom.xml b/docs/pom.xml index 0f171d9..302622c 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -16,8 +16,8 @@ spring-cloud-circuitbreaker ${basedir}/.. - 1.0.x spring.cloud.circuit.* + deploy @@ -33,16 +33,6 @@ spring-cloud-circuitbreaker-spring-retry - - - - maven-deploy-plugin - - true - - - - docs @@ -72,6 +62,9 @@ org.apache.maven.plugins maven-antrun-plugin + + maven-deploy-plugin + diff --git a/pom.xml b/pom.xml index 6676977..a500ec4 100644 --- a/pom.xml +++ b/pom.xml @@ -11,7 +11,7 @@ org.springframework.cloud spring-cloud-build - 2.3.0.RELEASE + 2.3.1.BUILD-SNAPSHOT