Package io.servicetalk.http.netty

Class RetryingHttpRequesterFilter

java.lang.Object

io.servicetalk.http.netty.RetryingHttpRequesterFilter

All Implemented Interfaces:

HttpExecutionStrategyInfluencer, StreamingHttpClientFilterFactory, ExecutionStrategyInfluencer<HttpExecutionStrategy>

public final class RetryingHttpRequesterFilter
extends Object
implements StreamingHttpClientFilterFactory, ExecutionStrategyInfluencer<HttpExecutionStrategy>

A filter to enable retries for HTTP clients.

Retries are supported for both the request flow and the response flow. Retries, in other words, can be triggered as part of a service response if needed, through RetryingHttpRequesterFilter.Builder.responseMapper(Function).

Retries can have different criteria and different backoff polices, as defined from the relevant Builder methods (i.e. RetryingHttpRequesterFilter.Builder.retryOther(BiFunction)). Similarly, max-retries for each flow can be set in the RetryingHttpRequesterFilter.BackOffPolicy, as well as a total max-retries to be respected by both flows, as set in RetryingHttpRequesterFilter.Builder.maxTotalRetries(int).

See Also:

• RetryStrategies

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RetryingHttpRequesterFilter.BackOffPolicy	Definition and presets of retry backoff policies.
static final class	RetryingHttpRequesterFilter.Builder	A builder for RetryingHttpRequesterFilter, which puts an upper bound on retry attempts.
static interface	RetryingHttpRequesterFilter.DelayedRetry	An interface that enhances any Exception to provide a constant delay to be applied when retrying through a retrying-filter.
static class	RetryingHttpRequesterFilter.HttpResponseException	This exception indicates response that matched the retrying rules of the RetryingHttpRequesterFilter and will-be/was retried.

Method Summary

Modifier and Type	Method	Description
StreamingHttpClientFilter	create(FilterableStreamingHttpClient client)	Creates a StreamingHttpClientFilter using the provided StreamingHttpClientFilter.
static RetryingHttpRequesterFilter	disableAllRetries()	Retrying filter that disables any form of retry behaviour.
static RetryingHttpRequesterFilter	disableAutoRetries()	Retrying filter that disables automatic retries for exceptions, but still waits until LoadBalancer becomes ready for the first time.
HttpExecutionStrategy	requiredOffloads()	Return an ExecutionStrategy that describes the offloads required by the influencer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.servicetalk.http.api.HttpExecutionStrategyInfluencer

influenceStrategy

Method Details

create

public StreamingHttpClientFilter create(FilterableStreamingHttpClient client)

Description copied from interface: StreamingHttpClientFilterFactory

Creates a StreamingHttpClientFilter using the provided StreamingHttpClientFilter.

Specified by:

create in interface StreamingHttpClientFilterFactory

Parameters:

client - FilterableStreamingHttpClient to filter

Returns:

StreamingHttpClientFilter using the provided StreamingHttpClientFilter.

requiredOffloads

public HttpExecutionStrategy requiredOffloads()

Description copied from interface: HttpExecutionStrategyInfluencer

Return an ExecutionStrategy that describes the offloads required by the influencer.

The provided default implementation requests offloading of all operations. Implementations that require no offloading should be careful to return HttpExecutionStrategies.offloadNone() rather than HttpExecutionStrategies.offloadNever(). Implementations should avoid returning HttpExecutionStrategies.defaultStrategy(), instead returning the strategy they require or HttpExecutionStrategies.offloadAll() if offloading for all paths is required (safe default).

Specified by:

requiredOffloads in interface ExecutionStrategyInfluencer<HttpExecutionStrategy>

Specified by:

requiredOffloads in interface HttpExecutionStrategyInfluencer

Returns:

the ExecutionStrategy required by the influencer.

disableAutoRetries

public static RetryingHttpRequesterFilter disableAutoRetries()

Retrying filter that disables automatic retries for exceptions, but still waits until LoadBalancer becomes ready for the first time.

Returns:

a retrying filter that disables automatic retries for exceptions, but still waits until LoadBalancer becomes ready for the first time.

See Also:

• RetryingHttpRequesterFilter.Builder.waitForLoadBalancer(boolean)

disableAllRetries

public static RetryingHttpRequesterFilter disableAllRetries()

Retrying filter that disables any form of retry behaviour. All types of failures will not be re-attempted, including LoadBalancer readiness state.

Returns:

a retrying filter that disables any form of retry behaviour. All types of failures will not be re-attempted.

See Also:

• RetryingHttpRequesterFilter.Builder.waitForLoadBalancer(boolean)