Package com.linecorp.armeria.client.retry

Class RetryingClient

java.lang.Object

com.linecorp.armeria.common.util.AbstractUnwrappable<Client<T_I,T_O>>

com.linecorp.armeria.client.DecoratingClient<I,O,I,O>

com.linecorp.armeria.client.SimpleDecoratingClient<I,O>

com.linecorp.armeria.client.retry.AbstractRetryingClient<HttpRequest,HttpResponse>

com.linecorp.armeria.client.retry.RetryingClient

All Implemented Interfaces:

Client<HttpRequest,HttpResponse>, HttpClient, Unwrappable

public final class RetryingClient
extends AbstractRetryingClient<HttpRequest,HttpResponse>
implements HttpClient

An HttpClient decorator that handles failures of an invocation and retries HTTP requests.

Field Summary

Fields inherited from class com.linecorp.armeria.client.retry.AbstractRetryingClient

ARMERIA_RETRY_COUNT

Method Summary

Modifier and Type	Method	Description
static RetryingClientBuilder	builder(RetryConfig<HttpResponse> retryConfig)	Returns a new RetryingClientBuilder with the specified RetryConfig.
static RetryingClientBuilder	builder(RetryRule retryRule)	Returns a new RetryingClientBuilder with the specified RetryRule.
static RetryingClientBuilder	builder(RetryRuleWithContent<HttpResponse> retryRuleWithContent)	Returns a new RetryingClientBuilder with the specified RetryRuleWithContent.
static RetryingClientBuilder	builder(RetryRuleWithContent<HttpResponse> retryRuleWithContent, int maxContentLength)	Returns a new RetryingClientBuilder with the specified RetryRuleWithContent and the specified maxContentLength.
static RetryingClientBuilder	builderWithMapping(RetryConfigMapping<HttpResponse> mapping)	Returns a new RetryingClientBuilder with the specified RetryConfigMapping.
protected HttpResponse	doExecute(ClientRequestContext ctx, HttpRequest req)	Invoked by AbstractRetryingClient.execute(ClientRequestContext, Request) after the deadline for response timeout is set.
static Function<? super HttpClient,RetryingClient>	newDecorator(RetryConfig<HttpResponse> retryConfig)	Creates a new HttpClient decorator that handles failures of an invocation and retries HTTP requests.
static Function<? super HttpClient,RetryingClient>	newDecorator(RetryRule retryRule)	Creates a new HttpClient decorator that handles failures of an invocation and retries HTTP requests.
static Function<? super HttpClient,RetryingClient>	newDecorator(RetryRule retryRule, int maxTotalAttempts)	Deprecated. Use newDecorator(RetryConfig) instead.
static Function<? super HttpClient,RetryingClient>	newDecorator(RetryRule retryRule, int maxTotalAttempts, long responseTimeoutMillisForEachAttempt)	Deprecated. Use newDecorator(RetryConfig) instead.
static Function<? super HttpClient,RetryingClient>	newDecorator(RetryRuleWithContent<HttpResponse> retryRuleWithContent)	Creates a new HttpClient decorator with the specified RetryRuleWithContent that handles failures of an invocation and retries HTTP requests.
static Function<? super HttpClient,RetryingClient>	newDecorator(RetryRuleWithContent<HttpResponse> retryRuleWithContent, int maxTotalAttempts)	Deprecated. Use newDecorator(RetryConfig) instead.
static Function<? super HttpClient,RetryingClient>	newDecorator(RetryRuleWithContent<HttpResponse> retryRuleWithContent, int maxTotalAttempts, long responseTimeoutMillisForEachAttempt)	Deprecated. Use newDecorator(RetryConfig) instead.
static Function<? super HttpClient,RetryingClient>	newDecoratorWithMapping(RetryConfigMapping<HttpResponse> mapping)	Creates a new HttpClient decorator that handles failures of an invocation and retries HTTP requests.

Methods inherited from class com.linecorp.armeria.client.retry.AbstractRetryingClient

execute, getNextDelay, getNextDelay, getTotalAttempts, mapping, newDerivedContext, onRetryingComplete, retryRule, retryRuleWithContent, scheduleNextRetry, setResponseTimeout

Methods inherited from class com.linecorp.armeria.common.util.AbstractUnwrappable

as, toString, unwrap, unwrapAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.client.Client

as, unwrap

Methods inherited from interface com.linecorp.armeria.client.HttpClient

execute

Methods inherited from interface com.linecorp.armeria.common.util.Unwrappable

equalsIgnoreWrapper, unwrapAll

Method Details

builder

public static RetryingClientBuilder builder(RetryConfig<HttpResponse> retryConfig)

Returns a new RetryingClientBuilder with the specified RetryConfig. The RetryConfig object encapsulates RetryRule or RetryRuleWithContent, maxContentLength, maxTotalAttempts and responseTimeoutMillisForEachAttempt.

builder

public static RetryingClientBuilder builder(RetryRule retryRule)

Returns a new RetryingClientBuilder with the specified RetryRule.

builder

public static RetryingClientBuilder builder(RetryRuleWithContent<HttpResponse> retryRuleWithContent)

Returns a new RetryingClientBuilder with the specified RetryRuleWithContent.

builder

public static RetryingClientBuilder builder(RetryRuleWithContent<HttpResponse> retryRuleWithContent,
 int maxContentLength)

Returns a new RetryingClientBuilder with the specified RetryRuleWithContent and the specified maxContentLength. The maxContentLength required to determine whether to retry or not. If the total length of content exceeds this length and there's no retry condition matched, it will hand over the stream to the client.

Throws:

IllegalArgumentException - if the specified maxContentLength is equal to or less than 0

builderWithMapping

public static RetryingClientBuilder builderWithMapping(RetryConfigMapping<HttpResponse> mapping)

Returns a new RetryingClientBuilder with the specified RetryConfigMapping.

newDecorator

public static Function<? super HttpClient,RetryingClient> newDecorator(RetryRule retryRule)

Creates a new HttpClient decorator that handles failures of an invocation and retries HTTP requests.

Parameters:

retryRule - the retry rule

newDecorator

public static Function<? super HttpClient,RetryingClient> newDecorator(RetryRuleWithContent<HttpResponse> retryRuleWithContent)

Creates a new HttpClient decorator with the specified RetryRuleWithContent that handles failures of an invocation and retries HTTP requests.

Parameters:

retryRuleWithContent - the retry rule

newDecorator

@Deprecated
public static Function<? super HttpClient,RetryingClient> newDecorator(RetryRule retryRule,
 int maxTotalAttempts)

Deprecated.

Use newDecorator(RetryConfig) instead.

Creates a new HttpClient decorator that handles failures of an invocation and retries HTTP requests.

Parameters:

retryRule - the retry rule

maxTotalAttempts - the maximum allowed number of total attempts

newDecorator

@Deprecated
public static Function<? super HttpClient,RetryingClient> newDecorator(RetryRuleWithContent<HttpResponse> retryRuleWithContent,
 int maxTotalAttempts)

Deprecated.

Use newDecorator(RetryConfig) instead.

Creates a new HttpClient decorator with the specified RetryRuleWithContent that handles failures of an invocation and retries HTTP requests.

Parameters:

retryRuleWithContent - the retry rule

maxTotalAttempts - the maximum allowed number of total attempts

newDecorator

@Deprecated
public static Function<? super HttpClient,RetryingClient> newDecorator(RetryRule retryRule,
 int maxTotalAttempts,
 long responseTimeoutMillisForEachAttempt)

Deprecated.

Use newDecorator(RetryConfig) instead.

Creates a new HttpClient decorator that handles failures of an invocation and retries HTTP requests.

Parameters:

retryRule - the retry rule

maxTotalAttempts - the maximum number of total attempts

responseTimeoutMillisForEachAttempt - response timeout for each attempt. 0 disables the timeout

newDecorator

@Deprecated
public static Function<? super HttpClient,RetryingClient> newDecorator(RetryRuleWithContent<HttpResponse> retryRuleWithContent,
 int maxTotalAttempts,
 long responseTimeoutMillisForEachAttempt)

Deprecated.

Use newDecorator(RetryConfig) instead.

Creates a new HttpClient decorator with the specified RetryRuleWithContent that handles failures of an invocation and retries HTTP requests.

Parameters:

retryRuleWithContent - the retry rule

maxTotalAttempts - the maximum number of total attempts

responseTimeoutMillisForEachAttempt - response timeout for each attempt. 0 disables the timeout

newDecorator

public static Function<? super HttpClient,RetryingClient> newDecorator(RetryConfig<HttpResponse> retryConfig)

Creates a new HttpClient decorator that handles failures of an invocation and retries HTTP requests. The RetryConfig object encapsulates RetryRule or RetryRuleWithContent, maxContentLength, maxTotalAttempts and responseTimeoutMillisForEachAttempt.

newDecoratorWithMapping

public static Function<? super HttpClient,RetryingClient> newDecoratorWithMapping(RetryConfigMapping<HttpResponse> mapping)

Creates a new HttpClient decorator that handles failures of an invocation and retries HTTP requests.

Parameters:

mapping - the mapping that returns a RetryConfig for a given ClientRequestContext and Request.

doExecute

protected HttpResponse doExecute(ClientRequestContext ctx,
 HttpRequest req)
                          throws Exception

Description copied from class: AbstractRetryingClient

Invoked by AbstractRetryingClient.execute(ClientRequestContext, Request) after the deadline for response timeout is set.

Specified by:

doExecute in class AbstractRetryingClient<HttpRequest,HttpResponse>

Throws:

Exception