Functional Interface:: This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface CircuitBreakerRule

Determines whether a Response should be reported as a success or failure to a CircuitBreaker. If you need to determine whether the request was successful by looking into the Response content, use CircuitBreakerRuleWithContent.

Note that if the last CircuitBreakerRule completes with CircuitBreakerDecision.next() or a Response is not matched with the CircuitBreakerRules, then the Response will be reported as a success.

For example:


 // If a response status is 500(Interval Server Error), the response will be reported as a failure.
 // Otherwise, the response will be reported as a success.
 CircuitBreakerRule.onStatus(HttpStatus.INTERNAL_SERVER_ERROR);

 // A response will be reported as a success if no exception is raised.
 CircuitBreakerRule.onException();

 // A CircuitBreakerRule that reports a response as a failure except that a response status code is 2xx.
 CircuitBreakerRule.of(
         // Report as a success if the class of a response status is 2xx
         CircuitBreakerRule.builder()
                           .onStatusClass(HttpStatusClass.SUCCESS)
                           .thenSuccess(),
         // Everything else is reported as a failure
         ClientBreakerRule.builder().thenFailure());

Method Summary

Modifier and Type	Method	Description
`static CircuitBreakerRuleBuilder`	`builder()`	Returns a newly created `CircuitBreakerRuleBuilder`.
`static CircuitBreakerRuleBuilder`	`builder(HttpMethod... methods)`	Returns a newly created `CircuitBreakerRuleBuilder` with the specified `HttpMethod`s.
`static CircuitBreakerRuleBuilder`	`builder(Iterable<HttpMethod> methods)`	Returns a newly created `CircuitBreakerRuleBuilder` with the specified `HttpMethod`s.
`static CircuitBreakerRuleBuilder`	`builder(Predicate<? super RequestHeaders> requestHeadersFilter)`	Returns a newly created `CircuitBreakerRuleBuilder` with the specified `requestHeadersFilter`.
`static CircuitBreakerRule`	`of(CircuitBreakerRule... circuitBreakerRules)`	Returns a `CircuitBreakerRule` that combines the specified `CircuitBreakerRule`s.
`static CircuitBreakerRule`	`of(Iterable<? extends CircuitBreakerRule> circuitBreakerRules)`	Returns a `CircuitBreakerRule` that combines the specified `CircuitBreakerRule`s.
`static CircuitBreakerRule`	`onException()`	Returns a newly created `CircuitBreakerRule` that will report a `Response` as a failure, if an `Exception` is raised.
`static CircuitBreakerRule`	`onException(Class<? extends Throwable> exception)`	Returns a newly created `CircuitBreakerRule` that will report a `Response` as a failure, if an `Exception` is raised and it is an instance of the specified `exception`.
`static CircuitBreakerRule`	`onException(Predicate<? super Throwable> exceptionFilter)`	Returns a newly created `CircuitBreakerRule` that will report a `Response` as a failure, if an `Exception` is raised and the specified `exceptionFilter` returns `true`.
`static CircuitBreakerRule`	`onServerErrorStatus()`	Returns a newly created `CircuitBreakerRule` that will report a `Response` as a failure, if the class of the response status is `HttpStatusClass.SERVER_ERROR`.
`static CircuitBreakerRule`	`onStatus(HttpStatus... statuses)`	Returns a newly created `CircuitBreakerRule` that will report a `Response` as a failure, if the response status is one of the specified `HttpStatus`es.
`static CircuitBreakerRule`	`onStatus(Iterable<HttpStatus> statuses)`	Returns a newly created `CircuitBreakerRule` that will report a `Response` as a failure, if the response status is one of the specified `HttpStatus`es.
`static CircuitBreakerRule`	`onStatus(Predicate<? super HttpStatus> statusFilter)`	Returns a newly created `CircuitBreakerRule` that will report a `Response` as a failure, if the specified `statusFilter` returns `true`.
`static CircuitBreakerRule`	`onStatusClass(HttpStatusClass statusClass)`	Returns a newly created `CircuitBreakerRule` that will report a `Response` as a failure, if the class of the response status is one of the specified `HttpStatusClass`es.
`static CircuitBreakerRule`	`onStatusClass(Iterable<HttpStatusClass> statusClasses)`	Returns a newly created `CircuitBreakerRule` that will report a `Response` as a failure, if the class of the response status is one of the specified `HttpStatusClass`es.
`default CircuitBreakerRule`	`orElse(CircuitBreakerRule other)`	Returns a composed `CircuitBreakerRule` that represents a logical OR of this `CircuitBreakerRule` and another.
`default boolean`	`requiresResponseTrailers()`	Returns whether this rule requires the response trailers to determine if a `Response` is successful or not.
`CompletionStage<CircuitBreakerDecision>`	`shouldReportAsSuccess(ClientRequestContext ctx, Throwable cause)`	Returns a `CompletionStage` that contains a `CircuitBreakerDecision` which indicates a `Response` is successful or not.

Method Details
- onStatusClass
  
  static CircuitBreakerRule onStatusClass(HttpStatusClass statusClass)
  
  Returns a newly created CircuitBreakerRule that will report a Response as a failure, if the class of the response status is one of the specified HttpStatusClasses.
- onStatusClass
  
  static CircuitBreakerRule onStatusClass(Iterable<HttpStatusClass> statusClasses)
  
  Returns a newly created CircuitBreakerRule that will report a Response as a failure, if the class of the response status is one of the specified HttpStatusClasses.
- onServerErrorStatus
  
  static CircuitBreakerRule onServerErrorStatus()
  
  Returns a newly created CircuitBreakerRule that will report a Response as a failure, if the class of the response status is HttpStatusClass.SERVER_ERROR.
- onStatus
  
  static CircuitBreakerRule onStatus(HttpStatus... statuses)
  
  Returns a newly created CircuitBreakerRule that will report a Response as a failure, if the response status is one of the specified HttpStatuses.
- onStatus
  
  static CircuitBreakerRule onStatus(Iterable<HttpStatus> statuses)
  
  Returns a newly created CircuitBreakerRule that will report a Response as a failure, if the response status is one of the specified HttpStatuses.
- onStatus
  
  static CircuitBreakerRule onStatus(Predicate<? super HttpStatus> statusFilter)
  
  Returns a newly created CircuitBreakerRule that will report a Response as a failure, if the specified statusFilter returns true.
- onException
  
  static CircuitBreakerRule onException(Class<? extends Throwable> exception)
  
  Returns a newly created CircuitBreakerRule that will report a Response as a failure, if an Exception is raised and it is an instance of the specified exception.
- onException
  
  static CircuitBreakerRule onException(Predicate<? super Throwable> exceptionFilter)
  
  Returns a newly created CircuitBreakerRule that will report a Response as a failure, if an Exception is raised and the specified exceptionFilter returns true.
- onException
  
  static CircuitBreakerRule onException()
  
  Returns a newly created CircuitBreakerRule that will report a Response as a failure, if an Exception is raised.
- builder
  
  static CircuitBreakerRuleBuilder builder()
  
  Returns a newly created CircuitBreakerRuleBuilder.
- builder
  
  static CircuitBreakerRuleBuilder builder(HttpMethod... methods)
  
  Returns a newly created CircuitBreakerRuleBuilder with the specified HttpMethods.
- builder
  
  static CircuitBreakerRuleBuilder builder(Iterable<HttpMethod> methods)
  
  Returns a newly created CircuitBreakerRuleBuilder with the specified HttpMethods.
- builder
  
  static CircuitBreakerRuleBuilder builder(Predicate<? super RequestHeaders> requestHeadersFilter)
  
  Returns a newly created CircuitBreakerRuleBuilder with the specified requestHeadersFilter.
- of
  
  static CircuitBreakerRule of(CircuitBreakerRule... circuitBreakerRules)
  
  Returns a CircuitBreakerRule that combines the specified CircuitBreakerRules.
- of
  
  static CircuitBreakerRule of(Iterable<? extends CircuitBreakerRule> circuitBreakerRules)
  
  Returns a CircuitBreakerRule that combines the specified CircuitBreakerRules.
- orElse
  
  default CircuitBreakerRule orElse(CircuitBreakerRule other)
  
  Returns a composed CircuitBreakerRule that represents a logical OR of this CircuitBreakerRule and another. If this CircuitBreakerRule completes with CircuitBreakerDecision.next(), then other CircuitBreakerRule is evaluated.
- shouldReportAsSuccess
  
  CompletionStage<CircuitBreakerDecision> shouldReportAsSuccess(ClientRequestContext ctx, @Nullable Throwable cause)
  Returns a CompletionStage that contains a CircuitBreakerDecision which indicates a Response is successful or not. If CircuitBreakerDecision.success() is returned, CircuitBreaker.onSuccess() is called so that the CircuitBreaker increases its success count and uses it to make a decision to close or open the circuit. If CircuitBreakerDecision.failure() is returned, it works the other way around. If CircuitBreakerDecision.ignore() is returned, the CircuitBreaker ignores it. If CircuitBreakerDecision.next() is returned, a next CircuitBreakerRule will be evaluated.
  Note that if the last CircuitBreakerRule completes with CircuitBreakerDecision.next() or a Response is not matched with the given CircuitBreakerRules, then the Response is reported as a success.
  To retrieve the ResponseHeaders, you can use the specified ClientRequestContext:
  > CompletionStage<CircuitBreakerDecision> shouldReportAsSuccess(ClientRequestContext ctx, > @Nullable Throwable cause) { > if (cause != null) { > return CompletableFuture.completedFuture(CircuitBreakerDecision.failure()); > } > ResponseHeaders responseHeaders = ctx.log().responseHeaders(); > if (responseHeaders.status().codeClass() == HttpStatusClass.SERVER_ERROR) { > return CompletableFuture.completedFuture(CircuitBreakerDecision.failure()); > } > ... > return CompletableFuture.completedFuture(CircuitBreakerDecision.success()) > }
  Parameters:
  
  ctx - the ClientRequestContext of this request
  
  cause - the Throwable which is raised while sending a request. null if there's no exception.
- requiresResponseTrailers
  
  default boolean requiresResponseTrailers()
  
  Returns whether this rule requires the response trailers to determine if a Response is successful or not.

Interface CircuitBreakerRule

Method Summary

Method Details