Package com.linecorp.armeria.client.circuitbreaker

Interface CircuitBreakerRuleWithContent<T extends Response>

Type Parameters:

T - the response type

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 CircuitBreakerRuleWithContent<T extends Response>

Determines whether a Response should be reported as a success or failure to a CircuitBreaker using the content of the Response. If you just need the HTTP headers to make a decision, use CircuitBreakerRule for efficiency.

Method Summary

Modifier and Type	Method	Description
static <T extends Response> CircuitBreakerRuleWithContentBuilder<T>	builder()	Returns a newly created CircuitBreakerRuleWithContentBuilder.
static <T extends Response> CircuitBreakerRuleWithContentBuilder<T>	builder(HttpMethod... methods)	Returns a newly created CircuitBreakerRuleWithContentBuilder with the specified HttpMethods.
static <T extends Response> CircuitBreakerRuleWithContentBuilder<T>	builder(Iterable<HttpMethod> methods)	Returns a newly created CircuitBreakerRuleWithContentBuilder with the specified HttpMethods.
static <T extends Response> CircuitBreakerRuleWithContentBuilder<T>	builder(BiPredicate<? super ClientRequestContext,? super RequestHeaders> requestHeadersFilter)	Returns a newly created CircuitBreakerRuleWithContentBuilder with the specified requestHeadersFilter.
static <T extends Response> CircuitBreakerRuleWithContent<T>	of(CircuitBreakerRuleWithContent<T>... circuitBreakerRules)	Returns a CircuitBreakerRuleWithContent that combines the specified CircuitBreakerRuleWithContents.
static <T extends Response> CircuitBreakerRuleWithContent<T>	of(Iterable<? extends CircuitBreakerRuleWithContent<T>> circuitBreakerRules)	Returns a CircuitBreakerRuleWithContent that combines the specified CircuitBreakerRuleWithContents.
static <T extends Response> CircuitBreakerRuleWithContent<T>	onResponse(BiFunction<? super ClientRequestContext,? super T,? extends CompletionStage<Boolean>> responseFilter)	Returns a newly created CircuitBreakerRuleWithContent that will report a Response as a failure if the specified responseFilter completes with true.
default CircuitBreakerRuleWithContent<T>	orElse(CircuitBreakerRule other)	Returns a composed CircuitBreakerRuleWithContent that represents a logical OR of this CircuitBreakerRuleWithContent and the specified CircuitBreakerRule.
default CircuitBreakerRuleWithContent<T>	orElse(CircuitBreakerRuleWithContent<T> other)	Returns a composed CircuitBreakerRuleWithContent that represents a logical OR of this CircuitBreakerRuleWithContent 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, T response, Throwable cause)	Returns a CompletionStage that contains a CircuitBreakerDecision.

Method Details

onResponse

static <T extends Response>
CircuitBreakerRuleWithContent<T> onResponse(BiFunction<? super ClientRequestContext,? super T,? extends CompletionStage<Boolean>> responseFilter)

Returns a newly created CircuitBreakerRuleWithContent that will report a Response as a failure if the specified responseFilter completes with true.

builder

static <T extends Response>
CircuitBreakerRuleWithContentBuilder<T> builder()

Returns a newly created CircuitBreakerRuleWithContentBuilder.

builder

static <T extends Response>
CircuitBreakerRuleWithContentBuilder<T> builder(HttpMethod... methods)

Returns a newly created CircuitBreakerRuleWithContentBuilder with the specified HttpMethods.

builder

static <T extends Response>
CircuitBreakerRuleWithContentBuilder<T> builder(Iterable<HttpMethod> methods)

Returns a newly created CircuitBreakerRuleWithContentBuilder with the specified HttpMethods.

builder

static <T extends Response>
CircuitBreakerRuleWithContentBuilder<T> builder(BiPredicate<? super ClientRequestContext,? super RequestHeaders> requestHeadersFilter)

Returns a newly created CircuitBreakerRuleWithContentBuilder with the specified requestHeadersFilter.

of

@SafeVarargs
static <T extends Response>
CircuitBreakerRuleWithContent<T> of(CircuitBreakerRuleWithContent<T>... circuitBreakerRules)

Returns a CircuitBreakerRuleWithContent that combines the specified CircuitBreakerRuleWithContents.

of

static <T extends Response>
CircuitBreakerRuleWithContent<T> of(Iterable<? extends CircuitBreakerRuleWithContent<T>> circuitBreakerRules)

Returns a CircuitBreakerRuleWithContent that combines the specified CircuitBreakerRuleWithContents.

orElse

default CircuitBreakerRuleWithContent<T> orElse(CircuitBreakerRule other)

Returns a composed CircuitBreakerRuleWithContent that represents a logical OR of this CircuitBreakerRuleWithContent and the specified CircuitBreakerRule. If this CircuitBreakerRuleWithContent completes with CircuitBreakerDecision.next(), then other CircuitBreakerRule is evaluated.

orElse

default CircuitBreakerRuleWithContent<T> orElse(CircuitBreakerRuleWithContent<T> other)

Returns a composed CircuitBreakerRuleWithContent that represents a logical OR of this CircuitBreakerRuleWithContent and another. If this CircuitBreakerRuleWithContent completes with CircuitBreakerDecision.next(), then other CircuitBreakerRuleWithContent is evaluated.

shouldReportAsSuccess

CompletionStage<CircuitBreakerDecision> shouldReportAsSuccess(ClientRequestContext ctx,
@Nullable
T response,
@Nullable
Throwable cause)

Returns a CompletionStage that contains a CircuitBreakerDecision. 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 the last CircuitBreakerRule completes with CircuitBreakerDecision.next() or a Response did not match the given CircuitBreakerRules, the Response will be reported as a success.

Parameters:

ctx - the ClientRequestContext of this request.

response - the Response from the server. null if a Throwable is raised before receiving the content of the Response.

cause - the Throwable which is raised while sending a request and before receiving the content of the Response. 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.