Package com.linecorp.armeria.client

Class AbstractRuleBuilder<SELF extends AbstractRuleBuilder<SELF>>

java.lang.Object

com.linecorp.armeria.client.AbstractRuleBuilder<SELF>

Direct Known Subclasses:

AbstractRuleWithContentBuilder, CircuitBreakerRuleBuilder, RetryRuleBuilder

@UnstableApi
public abstract class AbstractRuleBuilder<SELF extends AbstractRuleBuilder<SELF>>
extends Object

A skeletal builder implementation for RetryRule, RetryRuleWithContent, CircuitBreakerRule and CircuitBreakerRuleWithContent.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractRuleBuilder(BiPredicate<? super ClientRequestContext,? super RequestHeaders> requestHeadersFilter)	Creates a new instance with the specified requestHeadersFilter.

Method Summary

Modifier and Type	Method	Description
protected final @Nullable BiPredicate<ClientRequestContext,Throwable>	exceptionFilter()	Returns the BiPredicate of an Exception.
protected final @Nullable BiPredicate<ClientRequestContext,HttpHeaders>	grpcTrailersFilter()	Returns the BiPredicate of gRPC trailers.
SELF	onException()	Adds any Exception.
SELF	onException(Class<? extends Throwable> exception)	Adds the specified exception type.
SELF	onException(BiPredicate<? super ClientRequestContext,? super Throwable> exceptionFilter)	Adds the specified exceptionFilter.
SELF	onGrpcTrailers(BiPredicate<? super ClientRequestContext,? super HttpHeaders> grpcTrailersFilter)	Adds the specified grpcTrailersFilter.
SELF	onResponseHeaders(BiPredicate<? super ClientRequestContext,? super ResponseHeaders> responseHeadersFilter)	Adds the specified responseHeadersFilter.
SELF	onResponseTrailers(BiPredicate<? super ClientRequestContext,? super HttpHeaders> responseTrailersFilter)	Adds the specified responseTrailersFilter.
SELF	onServerErrorStatus()	Adds the HttpStatusClass.SERVER_ERROR.
SELF	onStatus(HttpStatus... statuses)	Adds the specified HttpStatuses.
SELF	onStatus(Iterable<HttpStatus> statuses)	Adds the specified HttpStatuses.
SELF	onStatus(BiPredicate<? super ClientRequestContext,? super HttpStatus> statusFilter)	Adds the specified statusFilter.
SELF	onStatusClass(HttpStatusClass... statusClasses)	Adds the specified HttpStatusClasses.
SELF	onStatusClass(Iterable<HttpStatusClass> statusClasses)	Adds the specified HttpStatusClasses.
SELF	onTimeoutException()	Adds TimeoutException.
SELF	onTotalDuration(BiPredicate<? super ClientRequestContext,? super Duration> totalDurationFilter)	Adds the specified totalDurationFilter.
SELF	onUnprocessed()	Adds an UnprocessedRequestException.
protected final BiPredicate<ClientRequestContext,RequestHeaders>	requestHeadersFilter()	Returns the BiPredicate of a RequestHeaders.
protected final boolean	requiresResponseTrailers()	Returns whether this rule being built requires HTTP response trailers.
protected final @Nullable BiPredicate<ClientRequestContext,ResponseHeaders>	responseHeadersFilter()	Returns the BiPredicate of a ResponseHeaders.
protected final @Nullable BiPredicate<ClientRequestContext,HttpHeaders>	responseTrailersFilter()	Returns the BiPredicate of a response trailers.
protected final @Nullable BiPredicate<ClientRequestContext,Duration>	totalDurationFilter()	Returns then Predicate of total duration.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractRuleBuilder

protected AbstractRuleBuilder(BiPredicate<? super ClientRequestContext,? super RequestHeaders> requestHeadersFilter)

Creates a new instance with the specified requestHeadersFilter.

Method Details

onResponseHeaders

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

Adds the specified responseHeadersFilter.

When this is used for a CircuitBreakerRule, and the specified responseHeadersFilter returns true, a Response is reported as a success or failure to a CircuitBreaker or ignored depending on the build methods(#thenSuccess(), #thenFailure() and #thenIgnore()).

onResponseTrailers

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

Adds the specified responseTrailersFilter. Note that using this method makes the entire response buffered, which may lead to excessive memory usage.

When this is used for a CircuitBreakerRule, and the specified responseTrailersFilter returns true, a Response is reported as a success or failure to a CircuitBreaker or ignored depending on the build methods(#thenSuccess(), #thenFailure() and #thenIgnore()).

onGrpcTrailers

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

Adds the specified grpcTrailersFilter. Note that using this method makes the entire response buffered, which may lead to excessive memory usage.

When this is used for a CircuitBreakerRule, and the specified grpcTrailersFilter returns true, a Response is reported as a success or failure to a CircuitBreaker or ignored depending on the build methods(#thenSuccess(), #thenFailure() and #thenIgnore()).

onStatusClass

public SELF onStatusClass(HttpStatusClass... statusClasses)

Adds the specified HttpStatusClasses.

When this is used for a CircuitBreakerRule, and the response status is one of the specified HttpStatusClasses, a Response is reported as a success or failure to a CircuitBreaker or ignored depending on the build methods(#thenSuccess(), #thenFailure() and #thenIgnore()).

onStatusClass

public SELF onStatusClass(Iterable<HttpStatusClass> statusClasses)

Adds the specified HttpStatusClasses.

When this is used for a CircuitBreakerRule, and the response status is one of the specified HttpStatusClasses, a Response is reported as a success or failure to a CircuitBreaker or ignored depending on the build methods(#thenSuccess(), #thenFailure() and #thenIgnore()).

onServerErrorStatus

public SELF onServerErrorStatus()

Adds the HttpStatusClass.SERVER_ERROR.

When this is used for a CircuitBreakerRule, and the response status is HttpStatusClass.SERVER_ERROR, a Response is reported as a success or failure to a CircuitBreaker or ignored depending on the build methods(#thenSuccess(), #thenFailure() and #thenIgnore()).

onStatus

public SELF onStatus(HttpStatus... statuses)

Adds the specified HttpStatuses.

When this is used for a CircuitBreakerRule, and the response status is one of the specified HttpStatuses, a Response is reported as a success or failure to a CircuitBreaker or ignored depending on the build methods(#thenSuccess(), #thenFailure() and #thenIgnore()).

onStatus

public SELF onStatus(Iterable<HttpStatus> statuses)

Adds the specified HttpStatuses.

When this is used for a CircuitBreakerRule, and the response status is one of the specified HttpStatuses, a Response is reported as a success or failure to a CircuitBreaker or ignored depending on the build methods(#thenSuccess(), #thenFailure() and #thenIgnore()).

onStatus

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

Adds the specified statusFilter.

When this is used for a CircuitBreakerRule, and the response status matches the specified statusFilter, a Response is reported as a success or failure to a CircuitBreaker or ignored depending on the build methods(#thenSuccess(), #thenFailure() and #thenIgnore()).

onException

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

Adds the specified exception type.

When this is used for a CircuitBreakerRule, and the raised exception is an instance of the specified exception, a Response is reported as a success or failure to a CircuitBreaker or ignored depending on the build methods(#thenSuccess(), #thenFailure() and #thenIgnore()).

onException

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

Adds the specified exceptionFilter.

When this is used for a CircuitBreakerRule, and the specified exceptionFilter returns true for the raised exception, a Response is reported as a success or failure to a CircuitBreaker or ignored depending on the build methods(#thenSuccess(), #thenFailure() and #thenIgnore()).

onException

public SELF onException()

Adds any Exception.

When this is used for a CircuitBreakerRule, a Response is reported as a success or failure to a CircuitBreaker or ignored depending on the build methods(#thenSuccess(), #thenFailure() and #thenIgnore()).

onTimeoutException

public SELF onTimeoutException()

Adds TimeoutException.

When this is used for a CircuitBreakerRule, a Response is reported as a success or failure to a CircuitBreaker or ignored depending on the build methods(#thenSuccess(), #thenFailure() and #thenIgnore()).

onUnprocessed

public SELF onUnprocessed()

Adds an UnprocessedRequestException.

When this is used for a CircuitBreakerRule, a Response is reported as a success or failure to a CircuitBreaker or ignored depending on the build methods(#thenSuccess(), #thenFailure() and #thenIgnore()).

onTotalDuration

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

Adds the specified totalDurationFilter.

When this is used for a CircuitBreakerRule, and the specified totalDurationFilter returns true, a Response is reported as a success or failure to a CircuitBreaker or ignored depending on the build methods(#thenSuccess(), #thenFailure() and #thenIgnore()).

requestHeadersFilter

protected final BiPredicate<ClientRequestContext,RequestHeaders> requestHeadersFilter()

Returns the BiPredicate of a RequestHeaders.

responseHeadersFilter

@Nullable
protected final @Nullable BiPredicate<ClientRequestContext,ResponseHeaders> responseHeadersFilter()

Returns the BiPredicate of a ResponseHeaders.

responseTrailersFilter

@Nullable
protected final @Nullable BiPredicate<ClientRequestContext,HttpHeaders> responseTrailersFilter()

Returns the BiPredicate of a response trailers.

exceptionFilter

@Nullable
protected final @Nullable BiPredicate<ClientRequestContext,Throwable> exceptionFilter()

Returns the BiPredicate of an Exception.

grpcTrailersFilter

@Nullable
protected final @Nullable BiPredicate<ClientRequestContext,HttpHeaders> grpcTrailersFilter()

Returns the BiPredicate of gRPC trailers.

totalDurationFilter

@Nullable
protected final @Nullable BiPredicate<ClientRequestContext,Duration> totalDurationFilter()

Returns then Predicate of total duration.

requiresResponseTrailers

protected final boolean requiresResponseTrailers()

Returns whether this rule being built requires HTTP response trailers.