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>	onException()	Returns a newly created RetryRuleWithContent that retries with default backoff on any Exception.
static <T extends Response> RetryRuleWithContent<T>	onException(Backoff backoff)	Returns a newly created RetryRuleWithContent that retries with the specified Backoff on any Exception.
static <T extends Response> RetryRuleWithContent<T>	onException(Class<? extends Throwable> exception)	Returns a newly created a RetryRuleWithContent that will retry with the default backoff if an Exception is raised and that is an instance of the specified exception.
static <T extends Response> RetryRuleWithContent<T>	onException(Class<? extends Throwable> exception, Backoff backoff)	Returns a newly created a RetryRuleWithContent that will retry with the specified Backoff if an Exception is raised and that is an instance of the specified exception.
static <T extends Response> RetryRuleWithContent<T>	onException(BiPredicate<? super ClientRequestContext,? super Throwable> exceptionFilter)	Returns a newly created RetryRuleWithContent that will retry with the default backoff if an Exception is raised and the specified exceptionFilter returns true.
static <T extends Response> RetryRuleWithContent<T>	onException(BiPredicate<? super ClientRequestContext,? super Throwable> exceptionFilter, Backoff backoff)	Returns a newly created RetryRuleWithContent that will retry with the specified Backoff if an Exception is raised and the specified exceptionFilter returns true.
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.
static <T extends Response> RetryRuleWithContent<T>	onResponse(BiFunction<? super ClientRequestContext,? super T,? extends CompletionStage<Boolean>> retryFunction, Backoff backoff)	Returns a newly created RetryRuleWithContent that will retry with the specified Backoff if the specified retryFunction completes with true.
static <T extends Response> RetryRuleWithContent<T>	onServerErrorStatus()	Returns a newly created RetryRuleWithContent that will retry with the default backoff if the class of the response status is HttpStatusClass.SERVER_ERROR.
static <T extends Response> RetryRuleWithContent<T>	onServerErrorStatus(Backoff backoff)	Returns a newly created RetryRuleWithContent that will retry with the specified Backoff if the class of the response status is HttpStatusClass.SERVER_ERROR.
static <T extends Response> RetryRuleWithContent<T>	onStatus(HttpStatus... statuses)	Returns a newly created RetryRuleWithContent that will retry with the default backoff if the response status is one of the specified HttpStatuses.
static <T extends Response> RetryRuleWithContent<T>	onStatus(Iterable<HttpStatus> statuses)	Returns a newly created RetryRuleWithContent that will retry with the default backoff if the response status is one of the specified HttpStatuses.
static <T extends Response> RetryRuleWithContent<T>	onStatus(Iterable<HttpStatus> statuses, Backoff backoff)	Returns a newly created RetryRuleWithContent that will retry with the specified Backoff if the response status is one of the specified HttpStatuses.
static <T extends Response> RetryRuleWithContent<T>	onStatus(BiPredicate<? super ClientRequestContext,? super HttpStatus> statusFilter)	Returns a newly created a RetryRuleWithContent that will retry with the default backoff if the response status matches the specified statusFilter.
static <T extends Response> RetryRuleWithContent<T>	onStatus(BiPredicate<? super ClientRequestContext,? super HttpStatus> statusFilter, Backoff backoff)	Returns a newly created a RetryRuleWithContent that will retry with the specified Backoff if the response status matches the specified statusFilter.
static <T extends Response> RetryRuleWithContent<T>	onStatusClass(HttpStatusClass statusClass)	Returns a newly created RetryRuleWithContent that will retry with the default backoff if the class of the response status is the specified HttpStatusClass.
static <T extends Response> RetryRuleWithContent<T>	onStatusClass(HttpStatusClass... statusClasses)	Returns a newly created RetryRuleWithContent that will retry with the default backoff if the class of the response status is the specified HttpStatusClasses.
static <T extends Response> RetryRuleWithContent<T>	onStatusClass(HttpStatusClass statusClass, Backoff backoff)	Returns a newly created RetryRuleWithContent that will retry with the specified Backoff if the class of the response status is the specified HttpStatusClass.
static <T extends Response> RetryRuleWithContent<T>	onStatusClass(Iterable<HttpStatusClass> statusClasses)	Returns a newly created RetryRuleWithContent that will retry with the default backoff if the class of the response status is the specified HttpStatusClasses.
static <T extends Response> RetryRuleWithContent<T>	onStatusClass(Iterable<HttpStatusClass> statusClasses, Backoff backoff)	Returns a newly created RetryRuleWithContent that will retry with the specified Backoff if the class of the response status is the specified HttpStatusClasses.
static <T extends Response> RetryRuleWithContent<T>	onUnprocessed()	Returns a RetryRuleWithContent that retries with the default backoff on an UnprocessedRequestException which means that the request has not been processed by the server.
static <T extends Response> RetryRuleWithContent<T>	onUnprocessed(Backoff backoff)	Returns a RetryRuleWithContent that retries with the specified Backoff on an UnprocessedRequestException which means that the request has not been processed by the server.
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.

onResponse

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

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

onStatusClass

static <T extends Response> RetryRuleWithContent<T> onStatusClass(HttpStatusClass statusClass)

Returns a newly created RetryRuleWithContent that will retry with the default backoff if the class of the response status is the specified HttpStatusClass.

onStatusClass

static <T extends Response> RetryRuleWithContent<T> onStatusClass(HttpStatusClass statusClass,
 Backoff backoff)

Returns a newly created RetryRuleWithContent that will retry with the specified Backoff if the class of the response status is the specified HttpStatusClass.

onStatusClass

static <T extends Response> RetryRuleWithContent<T> onStatusClass(HttpStatusClass... statusClasses)

Returns a newly created RetryRuleWithContent that will retry with the default backoff if the class of the response status is the specified HttpStatusClasses.

onStatusClass

static <T extends Response> RetryRuleWithContent<T> onStatusClass(Iterable<HttpStatusClass> statusClasses)

Returns a newly created RetryRuleWithContent that will retry with the default backoff if the class of the response status is the specified HttpStatusClasses.

onStatusClass

static <T extends Response> RetryRuleWithContent<T> onStatusClass(Iterable<HttpStatusClass> statusClasses,
 Backoff backoff)

Returns a newly created RetryRuleWithContent that will retry with the specified Backoff if the class of the response status is the specified HttpStatusClasses.

onServerErrorStatus

static <T extends Response> RetryRuleWithContent<T> onServerErrorStatus()

Returns a newly created RetryRuleWithContent that will retry with the default backoff if the class of the response status is HttpStatusClass.SERVER_ERROR.

onServerErrorStatus

static <T extends Response> RetryRuleWithContent<T> onServerErrorStatus(Backoff backoff)

Returns a newly created RetryRuleWithContent that will retry with the specified Backoff if the class of the response status is HttpStatusClass.SERVER_ERROR.

onStatus

static <T extends Response> RetryRuleWithContent<T> onStatus(HttpStatus... statuses)

Returns a newly created RetryRuleWithContent that will retry with the default backoff if the response status is one of the specified HttpStatuses.

onStatus

static <T extends Response> RetryRuleWithContent<T> onStatus(Iterable<HttpStatus> statuses)

Returns a newly created RetryRuleWithContent that will retry with the default backoff if the response status is one of the specified HttpStatuses.

onStatus

static <T extends Response> RetryRuleWithContent<T> onStatus(Iterable<HttpStatus> statuses,
 Backoff backoff)

Returns a newly created RetryRuleWithContent that will retry with the specified Backoff if the response status is one of the specified HttpStatuses.

onStatus

static <T extends Response> RetryRuleWithContent<T> onStatus(BiPredicate<? super ClientRequestContext,? super HttpStatus> statusFilter)

Returns a newly created a RetryRuleWithContent that will retry with the default backoff if the response status matches the specified statusFilter.

onStatus

static <T extends Response> RetryRuleWithContent<T> onStatus(BiPredicate<? super ClientRequestContext,? super HttpStatus> statusFilter,
 Backoff backoff)

Returns a newly created a RetryRuleWithContent that will retry with the specified Backoff if the response status matches the specified statusFilter.

onException

static <T extends Response> RetryRuleWithContent<T> onException(Class<? extends Throwable> exception)

Returns a newly created a RetryRuleWithContent that will retry with the default backoff if an Exception is raised and that is an instance of the specified exception.

onException

static <T extends Response> RetryRuleWithContent<T> onException(Class<? extends Throwable> exception,
 Backoff backoff)

Returns a newly created a RetryRuleWithContent that will retry with the specified Backoff if an Exception is raised and that is an instance of the specified exception.

onException

static <T extends Response> RetryRuleWithContent<T> onException(BiPredicate<? super ClientRequestContext,? super Throwable> exceptionFilter)

Returns a newly created RetryRuleWithContent that will retry with the default backoff if an Exception is raised and the specified exceptionFilter returns true.

onException

static <T extends Response> RetryRuleWithContent<T> onException(BiPredicate<? super ClientRequestContext,? super Throwable> exceptionFilter,
 Backoff backoff)

Returns a newly created RetryRuleWithContent that will retry with the specified Backoff if an Exception is raised and the specified exceptionFilter returns true.

onException

static <T extends Response> RetryRuleWithContent<T> onException()

Returns a newly created RetryRuleWithContent that retries with default backoff on any Exception. Note that this rule should be used carefully because it retries regardless of idempotency.

onException

static <T extends Response> RetryRuleWithContent<T> onException(Backoff backoff)

Returns a newly created RetryRuleWithContent that retries with the specified Backoff on any Exception. Note that this rule should be used carefully because it retries regardless of idempotency.

onUnprocessed

static <T extends Response> RetryRuleWithContent<T> onUnprocessed()

Returns a RetryRuleWithContent that retries with the default backoff on an UnprocessedRequestException which means that the request has not been processed by the server. Therefore, you can safely retry the request without worrying about the idempotency of the request.

onUnprocessed

static <T extends Response> RetryRuleWithContent<T> onUnprocessed(Backoff backoff)

Returns a RetryRuleWithContent that retries with the specified Backoff on an UnprocessedRequestException which means that the request has not been processed by the server. Therefore, you can safely retry the request without worrying about the idempotency of the request.

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.