Package com.linecorp.armeria.client.retry

Class RetryingHttpClientBuilder

java.lang.Object

com.linecorp.armeria.client.retry.RetryingClientBuilder<RetryingHttpClientBuilder,RetryingHttpClient,HttpRequest,HttpResponse>

com.linecorp.armeria.client.retry.RetryingHttpClientBuilder

public class RetryingHttpClientBuilder
extends RetryingClientBuilder<RetryingHttpClientBuilder,RetryingHttpClient,HttpRequest,HttpResponse>

Builds a new RetryingHttpClient or its decorator function.

Constructor Summary

Constructors

Constructor	Description
RetryingHttpClientBuilder(RetryStrategy retryStrategy)	Creates a new builder with the specified RetryStrategy.
RetryingHttpClientBuilder(RetryStrategyWithContent<HttpResponse> retryStrategyWithContent)	Creates a new builder with the specified RetryStrategyWithContent.

Method Summary

Modifier and Type	Method	Description
RetryingHttpClient	build(Client<HttpRequest,HttpResponse> delegate)	Returns a newly-created RetryingHttpClient based on the properties of this builder.
RetryingHttpClientBuilder	contentPreviewLength(int contentPreviewLength)	Sets the length of content required to determine whether to retry or not.
Function<Client<HttpRequest,HttpResponse>,RetryingHttpClient>	newDecorator()	Returns a newly-created decorator that decorates a Client with a new RetryingHttpClient based on the properties of this builder.
String	toString()
RetryingHttpClientBuilder	useRetryAfter(boolean useRetryAfter)	Whether retry should be attempted according to the retryHeader from the server or not.

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

maxTotalAttempts, responseTimeoutForEachAttempt, responseTimeoutMillisForEachAttempt

Methods inherited from class java.lang.Object

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

Constructor Detail

RetryingHttpClientBuilder

public RetryingHttpClientBuilder(RetryStrategy retryStrategy)

Creates a new builder with the specified RetryStrategy.

RetryingHttpClientBuilder

public RetryingHttpClientBuilder(RetryStrategyWithContent<HttpResponse> retryStrategyWithContent)

Creates a new builder with the specified RetryStrategyWithContent.

Method Detail

useRetryAfter

public RetryingHttpClientBuilder 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:

RetryingHttpClientBuilder to support method chaining

contentPreviewLength

public RetryingHttpClientBuilder 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 2147483647.

Parameters:

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

Returns:

RetryingHttpClientBuilder 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 RetryingHttpClient build(Client<HttpRequest,HttpResponse> delegate)

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

newDecorator

public Function<Client<HttpRequest,HttpResponse>,RetryingHttpClient> newDecorator()

Returns a newly-created decorator that decorates a Client with a new RetryingHttpClient based on the properties of this builder.

toString

public String toString()

Overrides:

toString in class RetryingClientBuilder<RetryingHttpClientBuilder,RetryingHttpClient,HttpRequest,HttpResponse>