Package com.linecorp.armeria.client.retry

Class RetryRuleBuilder

java.lang.Object

com.linecorp.armeria.client.AbstractRuleBuilder

com.linecorp.armeria.client.retry.RetryRuleBuilder

public final class RetryRuleBuilder
extends AbstractRuleBuilder

A builder for creating a new RetryRule.

Method Summary

Modifier and Type	Method	Description
RetryRuleBuilder	onException()	Makes a RetryRule retry on any Exception.
RetryRuleBuilder	onException(Class<? extends Throwable> exception)	Adds the specified exception type for a RetryRule which will retry if an Exception is raised and it is an instance of the specified exception.
RetryRuleBuilder	onException(BiPredicate<? super ClientRequestContext,? super Throwable> exceptionFilter)	Adds the specified exceptionFilter for a RetryRule which will retry if an Exception is raised and the specified exceptionFilter returns true.
RetryRuleBuilder	onGrpcTrailers(BiPredicate<? super ClientRequestContext,? super HttpHeaders> grpcTrailersFilter)	Adds the specified grpcTrailersFilter for a RetryRuleWithContent which will retry if the grpcTrailersFilter returns true.
RetryRuleBuilder	onResponseHeaders(BiPredicate<? super ClientRequestContext,? super ResponseHeaders> responseHeadersFilter)	Adds the specified responseHeadersFilter for a RetryRule which will retry if the responseHeadersFilter returns true.
RetryRuleBuilder	onResponseTrailers(BiPredicate<? super ClientRequestContext,? super HttpHeaders> responseTrailersFilter)	Adds the specified responseTrailersFilter for a RetryRuleWithContent which will retry if the responseTrailersFilter returns true.
RetryRuleBuilder	onServerErrorStatus()	Adds the HttpStatusClass.SERVER_ERROR for a RetryRule which will retry if a class of the response status is HttpStatusClass.SERVER_ERROR.
RetryRuleBuilder	onStatus(HttpStatus... statuses)	Adds the specified HttpStatuses for a RetryRule which will retry if a response status is one of the specified HttpStatuses.
RetryRuleBuilder	onStatus(Iterable<HttpStatus> statuses)	Adds the specified HttpStatuses for a RetryRule which will retry if a response status is one of the specified HttpStatuses.
RetryRuleBuilder	onStatus(BiPredicate<? super ClientRequestContext,? super HttpStatus> statusFilter)	Adds the specified statusFilter for a RetryRule which will retry if a response status matches the specified statusFilter.
RetryRuleBuilder	onStatusClass(HttpStatusClass... statusClasses)	Adds the specified HttpStatusClasses for a RetryRule which will retry if a class of the response status is one of the specified HttpStatusClasses.
RetryRuleBuilder	onStatusClass(Iterable<HttpStatusClass> statusClasses)	Adds the specified HttpStatusClasses for a RetryRule which will retry if a class of the response status is one of the specified HttpStatusClasses.
RetryRuleBuilder	onTimeoutException()	Makes a RetryRule retry on a TimeoutException.
RetryRuleBuilder	onTotalDuration(BiPredicate<? super ClientRequestContext,? super Duration> totalDurationFilter)	Adds the specified totalDurationFilter for a RetryRule which will retry if the totalDurationFilter returns true.
RetryRuleBuilder	onUnprocessed()	Makes a RetryRule retry on an UnprocessedRequestException which means that the request has not been processed by the server.
RetryRule	thenBackoff()	Sets the default backoff and returns a newly created RetryRule.
RetryRule	thenBackoff(Backoff backoff)	Sets the specified Backoff and returns a newly created RetryRule.
RetryRule	thenNoRetry()	Returns a newly created RetryRule that never retries.

Methods inherited from class com.linecorp.armeria.client.AbstractRuleBuilder

exceptionFilter, grpcTrailersFilter, requestHeadersFilter, requiresResponseTrailers, responseHeadersFilter, responseTrailersFilter, totalDurationFilter

Methods inherited from class java.lang.Object

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

Method Details

thenBackoff

public RetryRule thenBackoff()

Sets the default backoff and returns a newly created RetryRule.

thenBackoff

public RetryRule thenBackoff(Backoff backoff)

Sets the specified Backoff and returns a newly created RetryRule.

thenNoRetry

public RetryRule thenNoRetry()

Returns a newly created RetryRule that never retries.

onResponseHeaders

public RetryRuleBuilder onResponseHeaders(BiPredicate<? super ClientRequestContext,? super ResponseHeaders> responseHeadersFilter)

Adds the specified responseHeadersFilter for a RetryRule which will retry if the responseHeadersFilter returns true.

Overrides:

onResponseHeaders in class AbstractRuleBuilder

onResponseTrailers

public RetryRuleBuilder onResponseTrailers(BiPredicate<? super ClientRequestContext,? super HttpHeaders> responseTrailersFilter)

Adds the specified responseTrailersFilter for a RetryRuleWithContent which will retry if the responseTrailersFilter returns true. Note that using this method makes the entire response buffered, which may lead to excessive memory usage.

Overrides:

onResponseTrailers in class AbstractRuleBuilder

onGrpcTrailers

public RetryRuleBuilder onGrpcTrailers(BiPredicate<? super ClientRequestContext,? super HttpHeaders> grpcTrailersFilter)

Adds the specified grpcTrailersFilter for a RetryRuleWithContent which will retry if the grpcTrailersFilter returns true. Note that using this method makes the entire response buffered, which may lead to excessive memory usage.

Overrides:

onGrpcTrailers in class AbstractRuleBuilder

onStatusClass

public RetryRuleBuilder onStatusClass(HttpStatusClass... statusClasses)

Adds the specified HttpStatusClasses for a RetryRule which will retry if a class of the response status is one of the specified HttpStatusClasses.

Overrides:

onStatusClass in class AbstractRuleBuilder

onStatusClass

public RetryRuleBuilder onStatusClass(Iterable<HttpStatusClass> statusClasses)

Adds the specified HttpStatusClasses for a RetryRule which will retry if a class of the response status is one of the specified HttpStatusClasses.

Overrides:

onStatusClass in class AbstractRuleBuilder

onServerErrorStatus

public RetryRuleBuilder onServerErrorStatus()

Adds the HttpStatusClass.SERVER_ERROR for a RetryRule which will retry if a class of the response status is HttpStatusClass.SERVER_ERROR.

Overrides:

onServerErrorStatus in class AbstractRuleBuilder

onStatus

public RetryRuleBuilder onStatus(HttpStatus... statuses)

Adds the specified HttpStatuses for a RetryRule which will retry if a response status is one of the specified HttpStatuses.

Overrides:

onStatus in class AbstractRuleBuilder

onStatus

public RetryRuleBuilder onStatus(Iterable<HttpStatus> statuses)

Adds the specified HttpStatuses for a RetryRule which will retry if a response status is one of the specified HttpStatuses.

Overrides:

onStatus in class AbstractRuleBuilder

onStatus

public RetryRuleBuilder onStatus(BiPredicate<? super ClientRequestContext,? super HttpStatus> statusFilter)

Adds the specified statusFilter for a RetryRule which will retry if a response status matches the specified statusFilter.

Overrides:

onStatus in class AbstractRuleBuilder

onException

public RetryRuleBuilder onException(Class<? extends Throwable> exception)

Adds the specified exception type for a RetryRule which will retry if an Exception is raised and it is an instance of the specified exception.

Overrides:

onException in class AbstractRuleBuilder

onException

public RetryRuleBuilder onException(BiPredicate<? super ClientRequestContext,? super Throwable> exceptionFilter)

Adds the specified exceptionFilter for a RetryRule which will retry if an Exception is raised and the specified exceptionFilter returns true.

Overrides:

onException in class AbstractRuleBuilder

onException

public RetryRuleBuilder onException()

Makes a RetryRule retry on any Exception.

Overrides:

onException in class AbstractRuleBuilder

onTimeoutException

public RetryRuleBuilder onTimeoutException()

Makes a RetryRule retry on a TimeoutException.

Overrides:

onTimeoutException in class AbstractRuleBuilder

onUnprocessed

public RetryRuleBuilder onUnprocessed()

Makes a RetryRule retry on an UnprocessedRequestException which means that the request has not been processed by the server. Therefore, you can safely retry the request without worrying about the idempotency of the request.

Overrides:

onUnprocessed in class AbstractRuleBuilder

onTotalDuration

public RetryRuleBuilder onTotalDuration(BiPredicate<? super ClientRequestContext,? super Duration> totalDurationFilter)

Adds the specified totalDurationFilter for a RetryRule which will retry if the totalDurationFilter returns true.

Overrides:

onTotalDuration in class AbstractRuleBuilder