Package io.servicetalk.http.netty

Class RetryingHttpRequesterFilter.Builder

java.lang.Object

io.servicetalk.http.netty.RetryingHttpRequesterFilter.Builder

Enclosing class:

RetryingHttpRequesterFilter

public static final class RetryingHttpRequesterFilter.Builder
extends Object

A builder for RetryingHttpRequesterFilter, which puts an upper bound on retry attempts. To configure the maximum number of retry attempts see maxTotalRetries(int).

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RetryingHttpRequesterFilter	build()	Builds a retrying RetryingHttpRequesterFilter with this' builders configuration.
RetryingHttpRequesterFilter.Builder	ignoreServiceDiscovererErrors(boolean ignoreSdErrors)	By default, fail a request if the last signal from the associated ServiceDiscoverer was an error.
RetryingHttpRequesterFilter.Builder	maxTotalRetries(int maxRetries)	Set the maximum number of allowed retry operations before giving up, applied as total max across all retry functions (see.
RetryingHttpRequesterFilter.Builder	onRequestRetry(RetryingHttpRequesterFilter.RetryCallbacks onRequestRetry)	Callback invoked on every request retry attempt.
RetryingHttpRequesterFilter.Builder	responseMapper(Function<HttpResponseMetaData,RetryingHttpRequesterFilter.HttpResponseException> mapper)	Selectively map a response to an RetryingHttpRequesterFilter.HttpResponseException that can match a retry behaviour through retryResponses(BiFunction).
RetryingHttpRequesterFilter.Builder	retryDelayedRetries(BiFunction<HttpRequestMetaData,RetryingHttpRequesterFilter.DelayedRetry,RetryingHttpRequesterFilter.BackOffPolicy> mapper)	Deprecated. Use retryDelayedRetryExceptions(BiFunction) instead.
RetryingHttpRequesterFilter.Builder	retryDelayedRetryExceptions(BiFunction<HttpRequestMetaData,DelayedRetryException,RetryingHttpRequesterFilter.BackOffPolicy> mapper)	The retrying-filter will evaluate the Throwable marked with DelayedRetryException interface and use the provided delay as a constant delay on-top of the retry period already defined.
RetryingHttpRequesterFilter.Builder	retryExpectationFailed(boolean retryExpectationFailed)	Retries HttpResponseStatus.EXPECTATION_FAILED response without HttpHeaderNames.EXPECT header.
RetryingHttpRequesterFilter.Builder	retryIdempotentRequests(BiFunction<HttpRequestMetaData,IOException,RetryingHttpRequesterFilter.BackOffPolicy> mapper)	Retries idempotent requests when applicable.
RetryingHttpRequesterFilter.Builder	retryOther(BiFunction<HttpRequestMetaData,Throwable,RetryingHttpRequesterFilter.BackOffPolicy> mapper)	Support additional criteria for determining which requests or errors should be retried.
RetryingHttpRequesterFilter.Builder	retryResponses(BiFunction<HttpRequestMetaData,RetryingHttpRequesterFilter.HttpResponseException,RetryingHttpRequesterFilter.BackOffPolicy> mapper)	The retrying-filter will evaluate RetryingHttpRequesterFilter.HttpResponseException that resulted from the responseMapper(Function), and support different retry behaviour according to the request and the response.
RetryingHttpRequesterFilter.Builder	retryResponses(BiFunction<HttpRequestMetaData,RetryingHttpRequesterFilter.HttpResponseException,RetryingHttpRequesterFilter.BackOffPolicy> mapper, boolean returnOriginalResponses)	The retrying-filter will evaluate RetryingHttpRequesterFilter.HttpResponseException that resulted from the responseMapper(Function), and support different retry behaviour according to the request and the response.
RetryingHttpRequesterFilter.Builder	retryRetryableExceptions(BiFunction<HttpRequestMetaData,RetryableException,RetryingHttpRequesterFilter.BackOffPolicy> mapper)	The retrying-filter will evaluate for RetryableExceptions in the request flow.
RetryingHttpRequesterFilter.Builder	waitForLoadBalancer(boolean waitForLb)	By default, automatic retries wait for the associated LoadBalancer to be ready before triggering a retry for requests.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

waitForLoadBalancer

public RetryingHttpRequesterFilter.Builder waitForLoadBalancer(boolean waitForLb)

By default, automatic retries wait for the associated LoadBalancer to be ready before triggering a retry for requests. This behavior may add latency to requests till the time the load balancer is ready instead of failing fast. This method allows controlling that behavior.

Parameters:

waitForLb - Whether to wait for the LoadBalancer to be ready before retrying requests.

Returns:

this.

ignoreServiceDiscovererErrors

public RetryingHttpRequesterFilter.Builder ignoreServiceDiscovererErrors(boolean ignoreSdErrors)

By default, fail a request if the last signal from the associated ServiceDiscoverer was an error. This method disables that behavior.

Parameters:

ignoreSdErrors - ignore ServiceDiscoverer errors when evaluating a request failure.

Returns:

this.

maxTotalRetries

public RetryingHttpRequesterFilter.Builder maxTotalRetries(int maxRetries)

Set the maximum number of allowed retry operations before giving up, applied as total max across all retry functions (see. retryDelayedRetries(BiFunction), retryIdempotentRequests(BiFunction), retryRetryableExceptions(BiFunction), retryResponses(BiFunction), retryOther(BiFunction)).

Maximum total retries guards the LB/SD readiness flow, making sure LB connection issues will also be retried with a limit.

Parameters:

maxRetries - Maximum number of allowed retries before giving up

Returns:

this

responseMapper

public RetryingHttpRequesterFilter.Builder responseMapper(Function<HttpResponseMetaData,RetryingHttpRequesterFilter.HttpResponseException> mapper)

Selectively map a response to an RetryingHttpRequesterFilter.HttpResponseException that can match a retry behaviour through retryResponses(BiFunction).

Parameters:

mapper - a Function that maps a HttpResponseMetaData to an RetryingHttpRequesterFilter.HttpResponseException or returns null if there is no mapping for response meta-data. In the case that the request cannot be retried, the RetryingHttpRequesterFilter.HttpResponseException will be returned via the error pathway.

It's important that this Function doesn't block to avoid performance impacts. It's important that this Function doesn't throw exceptions.

Returns:

this

retryRetryableExceptions

public RetryingHttpRequesterFilter.Builder retryRetryableExceptions(BiFunction<HttpRequestMetaData,RetryableException,RetryingHttpRequesterFilter.BackOffPolicy> mapper)

The retrying-filter will evaluate for RetryableExceptions in the request flow.

To disable retries you can return RetryingHttpRequesterFilter.BackOffPolicy.ofNoRetries() from the mapper.

It's important that this BiFunction doesn't block to avoid performance impacts. It's important that this BiFunction doesn't throw exceptions.

Parameters:

mapper - The mapper to map the HttpRequestMetaData and the RetryableException to a RetryingHttpRequesterFilter.BackOffPolicy.

Returns:

this.

retryIdempotentRequests

public RetryingHttpRequesterFilter.Builder retryIdempotentRequests(BiFunction<HttpRequestMetaData,IOException,RetryingHttpRequesterFilter.BackOffPolicy> mapper)

Retries idempotent requests when applicable.

Note: This predicate expects that the retried requests have a payload body that is replayable, i.e. multiple subscribes to the payload Publisher observe the same data. Publishers that do not emit any data or which are created from in-memory data are typically replayable.

To disable retries you can return RetryingHttpRequesterFilter.BackOffPolicy.ofNoRetries() from the mapper.

It's important that this BiFunction doesn't block to avoid performance impacts. It's important that this BiFunction doesn't throw exceptions.

Parameters:

mapper - The mapper to map the HttpRequestMetaData and the IOException to a RetryingHttpRequesterFilter.BackOffPolicy.

Returns:

this.

retryExpectationFailed

public RetryingHttpRequesterFilter.Builder retryExpectationFailed(boolean retryExpectationFailed)

Retries HttpResponseStatus.EXPECTATION_FAILED response without HttpHeaderNames.EXPECT header.

Parameters:

retryExpectationFailed - if true, filter will automatically map HttpResponseStatus.EXPECTATION_FAILED into ExpectationFailedException and retry a request without HttpHeaderNames.EXPECT header.

Returns:

this.

See Also:

• Expect

retryDelayedRetryExceptions

public RetryingHttpRequesterFilter.Builder retryDelayedRetryExceptions(BiFunction<HttpRequestMetaData,DelayedRetryException,RetryingHttpRequesterFilter.BackOffPolicy> mapper)

The retrying-filter will evaluate the Throwable marked with DelayedRetryException interface and use the provided delay as a constant delay on-top of the retry period already defined.

In case a max-delay was set in this builder, the constant-delay overrides it and takes precedence.

To disable retries and proceed evaluating other retry functions you can return, RetryingHttpRequesterFilter.BackOffPolicy.ofNoRetries() from the passed mapper.

It's important that this BiFunction doesn't block to avoid performance impacts. It's important that this BiFunction doesn't throw exceptions.

Parameters:

mapper - The mapper to map the HttpRequestMetaData and the delayed-exception to a RetryingHttpRequesterFilter.BackOffPolicy.

Returns:

this.

retryDelayedRetries

@Deprecated
public RetryingHttpRequesterFilter.Builder retryDelayedRetries(BiFunction<HttpRequestMetaData,RetryingHttpRequesterFilter.DelayedRetry,RetryingHttpRequesterFilter.BackOffPolicy> mapper)

Deprecated.

Use retryDelayedRetryExceptions(BiFunction) instead.

The retrying-filter will evaluate the RetryingHttpRequesterFilter.DelayedRetry marker interface of an exception and use the provided delay as a constant delay on-top of the retry period already defined.

In case a max-delay was set in this builder, the constant-delay overrides it and takes precedence.

To disable retries you can return RetryingHttpRequesterFilter.BackOffPolicy.NO_RETRIES from the mapper.

It's important that this BiFunction doesn't block to avoid performance impacts. It's important that this BiFunction doesn't throw exceptions.

Parameters:

mapper - The mapper to map the HttpRequestMetaData and the delayed-exception to a RetryingHttpRequesterFilter.BackOffPolicy.

Returns:

this.

retryResponses

public RetryingHttpRequesterFilter.Builder retryResponses(BiFunction<HttpRequestMetaData,RetryingHttpRequesterFilter.HttpResponseException,RetryingHttpRequesterFilter.BackOffPolicy> mapper)

The retrying-filter will evaluate RetryingHttpRequesterFilter.HttpResponseException that resulted from the responseMapper(Function), and support different retry behaviour according to the request and the response.

To disable retries you can return RetryingHttpRequesterFilter.BackOffPolicy.NO_RETRIES from the mapper.

It's important that this BiFunction doesn't block to avoid performance impacts. It's important that this BiFunction doesn't throw exceptions.

Parameters:

mapper - The mapper to map the HttpRequestMetaData and the delayed-exception to a RetryingHttpRequesterFilter.BackOffPolicy.

Returns:

this.

retryResponses

public RetryingHttpRequesterFilter.Builder retryResponses(BiFunction<HttpRequestMetaData,RetryingHttpRequesterFilter.HttpResponseException,RetryingHttpRequesterFilter.BackOffPolicy> mapper,
 boolean returnOriginalResponses)

The retrying-filter will evaluate RetryingHttpRequesterFilter.HttpResponseException that resulted from the responseMapper(Function), and support different retry behaviour according to the request and the response.

To disable retries you can return RetryingHttpRequesterFilter.BackOffPolicy.NO_RETRIES from the mapper.

It's important that this BiFunction doesn't block to avoid performance impacts. It's important that this BiFunction doesn't throw exceptions.

Parameters:

mapper - The mapper to map the HttpRequestMetaData and the delayed-exception to a RetryingHttpRequesterFilter.BackOffPolicy.

returnOriginalResponses - whether to unwrap the response defined by the RetryingHttpRequesterFilter.HttpResponseException meta-data in the case that the request is not retried.

Returns:

this.

retryOther

public RetryingHttpRequesterFilter.Builder retryOther(BiFunction<HttpRequestMetaData,Throwable,RetryingHttpRequesterFilter.BackOffPolicy> mapper)

Support additional criteria for determining which requests or errors should be retried.

To disable retries you can return RetryingHttpRequesterFilter.BackOffPolicy.NO_RETRIES from the mapper.

It's important that this BiFunction doesn't block to avoid performance impacts. It's important that this BiFunction doesn't throw exceptions.

Parameters:

mapper - BiFunction that checks whether a given combination of meta-data and cause should be retried, producing a RetryingHttpRequesterFilter.BackOffPolicy in such cases.

Returns:

this

onRequestRetry

public RetryingHttpRequesterFilter.Builder onRequestRetry(RetryingHttpRequesterFilter.RetryCallbacks onRequestRetry)

Callback invoked on every request retry attempt.

This can be used to track when RetryingHttpRequesterFilter.BackOffPolicy actually decides to retry a request, to update request meta-data before a retry, or implement logging/metrics. However, it can not be used to influence the retry decision, use other "retry*" functions for that purpose.

Parameters:

onRequestRetry - RetryingHttpRequesterFilter.RetryCallbacks to get notified on every request retry attempt

Returns:

this

build

public RetryingHttpRequesterFilter build()

Builds a retrying RetryingHttpRequesterFilter with this' builders configuration.

Returns:

A new retrying RetryingHttpRequesterFilter