Package com.linecorp.armeria.client.retry

Interface RetryRuleWithContent<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 RetryRuleWithContent<T extends Response>

Determines whether a failed request should be retried using the content of a Response. If you just need the headers to make a decision, use RetryRule for efficiency.

Method Summary

Modifier and Type	Method	Description
static <T extends Response> RetryRuleWithContentBuilder<T>	builder()	Returns a newly created RetryRuleWithContentBuilder.
static <T extends Response> RetryRuleWithContentBuilder<T>	builder(HttpMethod... methods)	Returns a newly created RetryRuleWithContentBuilder with the specified HttpMethods.
static <T extends Response> RetryRuleWithContentBuilder<T>	builder(Iterable<HttpMethod> methods)	Returns a newly created RetryRuleWithContentBuilder with the specified HttpMethods.
static <T extends Response> RetryRuleWithContentBuilder<T>	builder(BiPredicate<? super ClientRequestContext,? super RequestHeaders> requestHeadersFilter)	Returns a newly created RetryRuleWithContentBuilder with the specified requestHeadersFilter.
static <T extends Response> RetryRuleWithContent<T>	of(RetryRuleWithContent<T>... retryRules)	Returns a RetryRuleWithContent that combines the specified retryRules.
static <T extends Response> RetryRuleWithContent<T>	of(Iterable<? extends RetryRuleWithContent<T>> retryRules)	Returns a RetryRuleWithContent that combines all the RetryRuleWithContent of the retryRules.
static <T extends Response> RetryRuleWithContent<T>	onResponse(BiFunction<? super ClientRequestContext,? super T,? extends CompletionStage<Boolean>> retryFunction)	Returns a newly created RetryRuleWithContent that will retry with the default backoff if the specified retryFunction completes with true.
default RetryRuleWithContent<T>	orElse(RetryRule other)	Returns a composed RetryRuleWithContent that represents a logical OR of this RetryRuleWithContent and the specified RetryRule.
default RetryRuleWithContent<T>	orElse(RetryRuleWithContent<T> other)	Returns a composed RetryRuleWithContent that represents a logical OR of this RetryRuleWithContent and another.
default boolean	requiresResponseTrailers()	Returns whether this rule requires the response trailers to determine if a Response is successful or not.
CompletionStage<RetryDecision>	shouldRetry(ClientRequestContext ctx, T response, @Nullable Throwable cause)	Tells whether the request sent with the specified ClientRequestContext requires a retry or not.

Method Details

onResponse

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

Returns a newly created RetryRuleWithContent that will retry with the default backoff if the specified retryFunction completes with true.

builder

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

Returns a newly created RetryRuleWithContentBuilder.

builder

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

Returns a newly created RetryRuleWithContentBuilder with the specified HttpMethods.

builder

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

Returns a newly created RetryRuleWithContentBuilder with the specified HttpMethods.

builder

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

Returns a newly created RetryRuleWithContentBuilder with the specified requestHeadersFilter.

of

@SafeVarargs
static <T extends Response> RetryRuleWithContent<T> of(RetryRuleWithContent<T>... retryRules)

Returns a RetryRuleWithContent that combines the specified retryRules.

of

static <T extends Response> RetryRuleWithContent<T> of(Iterable<? extends RetryRuleWithContent<T>> retryRules)

Returns a RetryRuleWithContent that combines all the RetryRuleWithContent of the retryRules.

orElse

default RetryRuleWithContent<T> orElse(RetryRule other)

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

orElse

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

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

shouldRetry

CompletionStage<RetryDecision> shouldRetry(ClientRequestContext ctx,
 @Nullable
 T response,
 @Nullable
 @Nullable Throwable cause)

Tells whether the request sent with the specified ClientRequestContext requires a retry or not. Implement this method to return a CompletionStage and to complete it with a desired Backoff. To stop trying further, complete it with null.

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.