com.linecorp.armeria.client.retry

Class RetryingClientBuilder

java.lang.Object

com.linecorp.armeria.client.retry.AbstractRetryingClientBuilder<HttpResponse>

com.linecorp.armeria.client.retry.RetryingClientBuilder

Direct Known Subclasses:

RetryingHttpClientBuilder

public class RetryingClientBuilder
extends AbstractRetryingClientBuilder<HttpResponse>

Builds a new RetryingClient or its decorator function.

Method Summary

Modifier and Type	Method and Description
RetryingClient	build(HttpClient delegate) Returns a newly-created RetryingClient based on the properties of this builder.
RetryingClientBuilder	contentPreviewLength(int contentPreviewLength) Sets the length of content required to determine whether to retry or not.
RetryingClientBuilder	maxTotalAttempts(int maxTotalAttempts) Sets the maximum number of total attempts.
Function<? super HttpClient,RetryingClient>	newDecorator() Returns a newly-created decorator that decorates an HttpClient with a new RetryingClient based on the properties of this builder.
RetryingClientBuilder	responseTimeoutForEachAttempt(Duration responseTimeoutForEachAttempt) Sets the response timeout for each attempt.
RetryingClientBuilder	responseTimeoutMillisForEachAttempt(long responseTimeoutMillisForEachAttempt) Sets the response timeout for each attempt in milliseconds.
String	toString()
RetryingClientBuilder	useRetryAfter(boolean useRetryAfter) Whether retry should be attempted according to the retryHeader from the server or not.

Methods inherited from class java.lang.Object

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

Method Detail

useRetryAfter

public RetryingClientBuilder useRetryAfter(boolean useRetryAfter)

Whether retry should be attempted according to the retryHeader from the server or not. The web server may request a client to retry after specific time with retryAfter header. If you want to follow the direction from the server not by your Backoff, invoke this method with the useRetryAfter with true to request after the specified delay.

Parameters:

useRetryAfter - true if you want to retry after using the retryAfter header. false otherwise

Returns:

RetryingClientBuilder to support method chaining

contentPreviewLength

public RetryingClientBuilder contentPreviewLength(int contentPreviewLength)

Sets the length of content 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. Note that this property is useful only if you specified RetryStrategyWithContent when calling this builder's constructor. The default value of this property is .

Parameters:

contentPreviewLength - the content length to preview. 0 does not disable the length limit.

Returns:

RetryingClientBuilder to support method chaining

Throws:

IllegalStateException - if this builder is created with a RetryStrategy rather than RetryStrategyWithContent

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

build

public RetryingClient build(HttpClient delegate)

Returns a newly-created RetryingClient based on the properties of this builder.

newDecorator

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

Returns a newly-created decorator that decorates an HttpClient with a new RetryingClient based on the properties of this builder.

toString

public String toString()

Overrides:

toString in class AbstractRetryingClientBuilder<HttpResponse>

maxTotalAttempts

public RetryingClientBuilder maxTotalAttempts(int maxTotalAttempts)

Description copied from class: AbstractRetryingClientBuilder

Sets the maximum number of total attempts. If unspecified, the value from Flags.defaultMaxTotalAttempts() will be used.

Overrides:

maxTotalAttempts in class AbstractRetryingClientBuilder<HttpResponse>

Returns:

this to support method chaining.

responseTimeoutMillisForEachAttempt

public RetryingClientBuilder responseTimeoutMillisForEachAttempt(long responseTimeoutMillisForEachAttempt)

Description copied from class: AbstractRetryingClientBuilder

Sets the response timeout for each attempt in milliseconds. When requests in AbstractRetryingClient are made, corresponding responses are timed out by this value. 0 disables the timeout. It will be set by the default value in Flags.defaultResponseTimeoutMillis(), if the client dose not specify.

Overrides:

responseTimeoutMillisForEachAttempt in class AbstractRetryingClientBuilder<HttpResponse>

Returns:

this to support method chaining.

See Also:

Per-attempt timeout

responseTimeoutForEachAttempt

public RetryingClientBuilder responseTimeoutForEachAttempt(Duration responseTimeoutForEachAttempt)

Description copied from class: AbstractRetryingClientBuilder

Sets the response timeout for each attempt. When requests in AbstractRetryingClient are made, corresponding responses are timed out by this value. 0 disables the timeout.

Overrides:

responseTimeoutForEachAttempt in class AbstractRetryingClientBuilder<HttpResponse>

Returns:

this to support method chaining.

See Also:

Per-attempt timeout