Package com.linecorp.armeria.client.retry

Class RetryRuleWithContentBuilder<T extends Response>

java.lang.Object

com.linecorp.armeria.client.AbstractRuleBuilder

com.linecorp.armeria.client.AbstractRuleWithContentBuilder<T>

com.linecorp.armeria.client.retry.RetryRuleWithContentBuilder<T>

public final class RetryRuleWithContentBuilder<T extends Response>
extends AbstractRuleWithContentBuilder<T>

A builder for creating a new RetryRuleWithContent.

Method Summary

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

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

responseFilter

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

exceptionFilter, requestHeadersFilter, responseHeadersFilter, responseTrailersFilter

Methods inherited from class java.lang.Object

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

Method Details

onResponse

public RetryRuleWithContentBuilder<T> onResponse(BiFunction<? super ClientRequestContext,? super T,? extends CompletionStage<Boolean>> responseFilter)

Adds the specified responseFilter for a RetryRuleWithContent which will retry if the specified responseFilter completes with true.

Overrides:

onResponse in class AbstractRuleWithContentBuilder<T extends Response>

thenBackoff

public RetryRuleWithContent<T> thenBackoff()

Sets the default backoff and returns a newly created RetryRuleWithContent.

thenBackoff

public RetryRuleWithContent<T> thenBackoff(Backoff backoff)

Sets the specified Backoff and returns a newly created RetryRuleWithContent.

thenNoRetry

public RetryRuleWithContent<T> thenNoRetry()

Returns a newly created RetryRuleWithContent that never retries.

onResponseHeaders

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

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

Overrides:

onResponseHeaders in class AbstractRuleBuilder

onResponseTrailers

public RetryRuleWithContentBuilder<T> 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

onStatusClass

public RetryRuleWithContentBuilder<T> onStatusClass(HttpStatusClass... statusClasses)

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

Overrides:

onStatusClass in class AbstractRuleBuilder

onStatusClass

public RetryRuleWithContentBuilder<T> onStatusClass(Iterable<HttpStatusClass> statusClasses)

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

Overrides:

onStatusClass in class AbstractRuleBuilder

onServerErrorStatus

public RetryRuleWithContentBuilder<T> onServerErrorStatus()

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

Overrides:

onServerErrorStatus in class AbstractRuleBuilder

onStatus

public RetryRuleWithContentBuilder<T> onStatus(HttpStatus... statuses)

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

Overrides:

onStatus in class AbstractRuleBuilder

onStatus

public RetryRuleWithContentBuilder<T> onStatus(Iterable<HttpStatus> statuses)

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

Overrides:

onStatus in class AbstractRuleBuilder

onStatus

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

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

Overrides:

onStatus in class AbstractRuleBuilder

onException

public RetryRuleWithContentBuilder<T> onException(Class<? extends Throwable> exception)

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

Overrides:

onException in class AbstractRuleBuilder

onException

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

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

Overrides:

onException in class AbstractRuleBuilder

onException

public RetryRuleWithContentBuilder<T> onException()

Makes a RetryRuleWithContent retry on any Exception.

Overrides:

onException in class AbstractRuleBuilder

onUnprocessed

public RetryRuleWithContentBuilder<T> onUnprocessed()

Makes a RetryRuleWithContent 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