io.sphere.sdk.retry

Interface RetryAction

All Superinterfaces:

Function<RetryContext,RetryStrategy>

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 RetryAction
extends Function<RetryContext,RetryStrategy>

Provides some default implementations for RetryRule.apply(RetryContext).

Method Summary

Modifier and Type	Method and Description
RetryStrategy	apply(RetryContext retryContext)
static Duration	calculateDurationWithExponentialRandomBackoff(long retryAttempt, long initialRetryDelay, long maxDelay) Computes a exponential backoff time delay in milliseconds to be used in retries, the delay grows with failed retry attempts count with a randomness interval.
static RetryAction	ofExponentialBackoff(long maxAttempts, long initialRetryDelay, long maxDelay) Retry in the future with exponential backoff strategy.
static RetryAction	ofGiveUpAndSendFirstException()
static RetryAction	ofGiveUpAndSendLatestException() Throws the latest error and does not retry.
static RetryAction	ofImmediateRetries(long maxAttempts) Retries immediately for a maximum amount of attempts.
static RetryAction	ofScheduledRetry(long maxAttempts, Duration duration) Retry in the future with a fixed waiting time.
static RetryAction	ofScheduledRetry(long maxAttempts, Function<RetryContext,Duration> durationFunction) Retry in the future with a waiting time depending on the RetryContext, for example to take the number of attempts in consideration.
static RetryAction	ofShutdownServiceAndSendFirstException()
static RetryAction	ofShutdownServiceAndSendLatestException()

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Method Detail

apply

@Nullable
RetryStrategy apply(RetryContext retryContext)

Specified by:

apply in interface Function<RetryContext,RetryStrategy>

ofScheduledRetry

static RetryAction ofScheduledRetry(long maxAttempts,
                                    Duration duration)

Retry in the future with a fixed waiting time.

Parameters:

maxAttempts - maximum amount of attempts until giving up and throwing the latest Exception

duration - time to wait before retrying

Returns:

action

ofScheduledRetry

static RetryAction ofScheduledRetry(long maxAttempts,
                                    Function<RetryContext,Duration> durationFunction)

Retry in the future with a waiting time depending on the RetryContext, for example to take the number of attempts in consideration.

import io.sphere.sdk.client.RetrySphereClientDecorator;

import io.sphere.sdk.client.SphereClient;

import io.sphere.sdk.retry.RetryAction;

import io.sphere.sdk.retry.RetryPredicate;

import io.sphere.sdk.retry.RetryRule;

import java.time.Duration;

import java.util.List;

import static io.sphere.sdk.http.HttpStatusCode.BAD_GATEWAY_502;

import static io.sphere.sdk.http.HttpStatusCode.GATEWAY_TIMEOUT_504;

import static io.sphere.sdk.http.HttpStatusCode.SERVICE_UNAVAILABLE_503;

import static java.util.Collections.singletonList;

public class RetryBadGatewayExample {
    public static SphereClient ofRetry(final SphereClient delegate) {
        final int maxAttempts = 5;
        final List<RetryRule> retryRules = singletonList(RetryRule.of(
                RetryPredicate.ofMatchingStatusCodes(BAD_GATEWAY_502, SERVICE_UNAVAILABLE_503, GATEWAY_TIMEOUT_504),
                RetryAction.ofScheduledRetry(maxAttempts, context -> Duration.ofSeconds(context.getAttempt() * 2)))
        );
        return RetrySphereClientDecorator.of(delegate, retryRules);
    }
}
See the test code.

Parameters:

maxAttempts - maximum amount of attempts until giving up and throwing the latest Exception

durationFunction - function that takes the RetryContext and provides the duration to wait until the next retry

Returns:

action

ofShutdownServiceAndSendFirstException

static RetryAction ofShutdownServiceAndSendFirstException()

ofShutdownServiceAndSendLatestException

static RetryAction ofShutdownServiceAndSendLatestException()

ofGiveUpAndSendFirstException

static RetryAction ofGiveUpAndSendFirstException()

ofGiveUpAndSendLatestException

static RetryAction ofGiveUpAndSendLatestException()

Throws the latest error and does not retry.

Returns:

action

ofImmediateRetries

static RetryAction ofImmediateRetries(long maxAttempts)

Retries immediately for a maximum amount of attempts.

Parameters:

maxAttempts - maximum amount of attempts until giving up and throwing the latest Exception

Returns:

action

ofExponentialBackoff

static RetryAction ofExponentialBackoff(long maxAttempts,
                                        long initialRetryDelay,
                                        long maxDelay)

Retry in the future with exponential backoff strategy.

Parameters:

maxAttempts - maximum amount of attempts until giving up and throwing the latest Exception

initialRetryDelay - initial time to wait before retrying in milliseconds

maxDelay - maximum time to wait before retrying in milliseconds

Returns:

action

calculateDurationWithExponentialRandomBackoff

static Duration calculateDurationWithExponentialRandomBackoff(long retryAttempt,
                                                              long initialRetryDelay,
                                                              long maxDelay)

Computes a exponential backoff time delay in milliseconds to be used in retries, the delay grows with failed retry attempts count with a randomness interval. (see: ) (see: )

Parameters:

retryAttempt - the number of attempts already tried by the client.

initialRetryDelay - the initial Retry delay.

maxDelay - the maxDelay in milliseconds.

Returns:

a duration in milliseconds, that grows with the number of failed attempts.