Module methanol

Package com.github.mizosoft.methanol

Class RetryInterceptor

java.lang.Object

com.github.mizosoft.methanol.RetryInterceptor

All Implemented Interfaces:

Methanol.Interceptor

public final class RetryInterceptor
extends java.lang.Object
implements Methanol.Interceptor

An interceptor that retries HTTP requests based on configurable conditions.

Retry conditions are evaluated in the order they are added. The first matching condition determines the next request to send. Later conditions are not evaluated.

Example:

Retry server errors with exponential backoff:

 var client = Methanol.newBuilder()
     .interceptor(RetryInterceptor.newBuilder()
         .maxRetries(3)
         .backoff(BackoffStrategy.exponential(
             Duration.ofMillis(100),
             Duration.ofSeconds(10)).withJitter())
         .onStatus(500, 502, 503, 504)
         .onException(ConnectException.class)
         .build())
     .build();
 

See Also:

RetryInterceptor.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RetryInterceptor.BackoffStrategy	A strategy for backing off (delaying) before a retry.
static class	RetryInterceptor.Builder	A builder of RetryInterceptor instances.
static interface	RetryInterceptor.Context<T>	Context for deciding whether an HTTP call should be retried.
static interface	RetryInterceptor.Listener	A listener for RetryInterceptor events.

Nested classes/interfaces inherited from interface com.github.mizosoft.methanol.Methanol.Interceptor

Methanol.Interceptor.Chain<T>

Method Summary

Modifier and Type	Method	Description
<T> java.net.http.HttpResponse<T>	intercept(java.net.http.HttpRequest request, Methanol.Interceptor.Chain<T> chain)	Intercepts given request and returns the resulting response, usually by forwarding to the given chain.
<T> java.util.concurrent.CompletableFuture<java.net.http.HttpResponse<T>>	interceptAsync(java.net.http.HttpRequest request, Methanol.Interceptor.Chain<T> chain)	Intercepts the given request and returns a CompletableFuture for the resulting response, usually by forwarding to the given chain.
static RetryInterceptor.Builder	newBuilder()	Returns a new builder of RetryInterceptor instances.

Methods inherited from class java.lang.Object

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

Method Detail

intercept

public <T> java.net.http.HttpResponse<T> intercept(java.net.http.HttpRequest request,
                                                   Methanol.Interceptor.Chain<T> chain)
                                            throws java.io.IOException,
                                                   java.lang.InterruptedException

Description copied from interface: Methanol.Interceptor

Intercepts given request and returns the resulting response, usually by forwarding to the given chain.

Specified by:

intercept in interface Methanol.Interceptor

Throws:

java.io.IOException

java.lang.InterruptedException

interceptAsync

public <T> java.util.concurrent.CompletableFuture<java.net.http.HttpResponse<T>> interceptAsync(java.net.http.HttpRequest request,
                                                                                                Methanol.Interceptor.Chain<T> chain)

Description copied from interface: Methanol.Interceptor

Intercepts the given request and returns a CompletableFuture for the resulting response, usually by forwarding to the given chain.

Specified by:

interceptAsync in interface Methanol.Interceptor

newBuilder

public static RetryInterceptor.Builder newBuilder()

Returns a new builder of RetryInterceptor instances.