io.github.resilience4j.retry

Interface AsyncRetry

All Known Implementing Classes:

AsyncRetryImpl

public interface AsyncRetry

A AsyncRetry instance is thread-safe can be used to decorate multiple requests.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AsyncRetry.Context
static interface	AsyncRetry.EventPublisher An EventPublisher which subscribes to the reactive stream of RetryEvents and can be used to register event consumers.
static interface	AsyncRetry.Metrics

Method Summary

Modifier and Type	Method and Description
AsyncRetry.Context	context() Creates a retry Context.
static <T> java.util.function.Supplier<java.util.concurrent.CompletionStage<T>>	decorateCompletionStage(AsyncRetry retry, java.util.concurrent.ScheduledExecutorService scheduler, java.util.function.Supplier<java.util.concurrent.CompletionStage<T>> supplier) Decorates CompletionStageSupplier with Retry
default <T> java.util.concurrent.CompletionStage<T>	executeCompletionStage(java.util.concurrent.ScheduledExecutorService scheduler, java.util.function.Supplier<java.util.concurrent.CompletionStage<T>> supplier) Decorates and executes the decorated CompletionStage.
AsyncRetry.EventPublisher	getEventPublisher() Returns an EventPublisher which can be used to register event consumers.
AsyncRetry.Metrics	getMetrics() Get the Metrics of this RateLimiter.
java.lang.String	getName() Returns the ID of this Retry.
RetryConfig	getRetryConfig() Returns the RetryConfig of this Retry.
static AsyncRetry	of(java.lang.String id, RetryConfig retryConfig) Creates a Retry with a custom Retry configuration.
static AsyncRetry	of(java.lang.String id, java.util.function.Supplier<RetryConfig> retryConfigSupplier) Creates a Retry with a custom Retry configuration.
static AsyncRetry	ofDefaults(java.lang.String id) Creates a Retry with default configuration.

Method Detail

getName

java.lang.String getName()

Returns the ID of this Retry.

Returns:

the ID of this Retry

getEventPublisher

AsyncRetry.EventPublisher getEventPublisher()

Returns an EventPublisher which can be used to register event consumers.

Returns:

an EventPublisher

context

AsyncRetry.Context context()

Creates a retry Context.

Returns:

the retry Context

getRetryConfig

RetryConfig getRetryConfig()

Returns the RetryConfig of this Retry.

Returns:

the RetryConfig of this Retry

of

static AsyncRetry of(java.lang.String id,
                     RetryConfig retryConfig)

Creates a Retry with a custom Retry configuration.

Parameters:

id - the ID of the Retry

retryConfig - a custom Retry configuration

Returns:

a Retry with a custom Retry configuration.

of

static AsyncRetry of(java.lang.String id,
                     java.util.function.Supplier<RetryConfig> retryConfigSupplier)

Creates a Retry with a custom Retry configuration.

Parameters:

id - the ID of the Retry

retryConfigSupplier - a supplier of a custom Retry configuration

Returns:

a Retry with a custom Retry configuration.

ofDefaults

static AsyncRetry ofDefaults(java.lang.String id)

Creates a Retry with default configuration.

Parameters:

id - the ID of the Retry

Returns:

a Retry with default configuration

executeCompletionStage

default <T> java.util.concurrent.CompletionStage<T> executeCompletionStage(java.util.concurrent.ScheduledExecutorService scheduler,
                                                                           java.util.function.Supplier<java.util.concurrent.CompletionStage<T>> supplier)

Decorates and executes the decorated CompletionStage.

Type Parameters:

T - the type of results supplied by this supplier

Parameters:

scheduler - execution service to use to schedule retries

supplier - the original CompletionStage

Returns:

the decorated CompletionStage.

decorateCompletionStage

static <T> java.util.function.Supplier<java.util.concurrent.CompletionStage<T>> decorateCompletionStage(AsyncRetry retry,
                                                                                                        java.util.concurrent.ScheduledExecutorService scheduler,
                                                                                                        java.util.function.Supplier<java.util.concurrent.CompletionStage<T>> supplier)

Decorates CompletionStageSupplier with Retry

Type Parameters:

T - type of completion stage result

Parameters:

retry - the retry context

scheduler - execution service to use to schedule retries

supplier - completion stage supplier

Returns:

decorated supplier

getMetrics

AsyncRetry.Metrics getMetrics()

Get the Metrics of this RateLimiter.

Returns:

the Metrics of this RateLimiter