Package com.linecorp.armeria.client.circuitbreaker

Class CircuitBreakerRuleBuilder

java.lang.Object

com.linecorp.armeria.client.AbstractRuleBuilder

com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleBuilder

public final class CircuitBreakerRuleBuilder
extends AbstractRuleBuilder

A builder for creating a new CircuitBreakerRule.

Method Summary

Modifier and Type	Method	Description
CircuitBreakerRuleBuilder	onException()	Reports a Response as a success or failure to a CircuitBreaker, or ignores it according to the build methods(thenSuccess(), thenFailure() and thenIgnore()), if an Exception is raised.
CircuitBreakerRuleBuilder	onException(Class<? extends Throwable> exception)	Adds the specified exception type for a CircuitBreakerRule.
CircuitBreakerRuleBuilder	onException(BiPredicate<? super ClientRequestContext,? super Throwable> exceptionFilter)	Adds the specified exceptionFilter for a CircuitBreakerRule.
CircuitBreakerRuleBuilder	onGrpcTrailers(BiPredicate<? super ClientRequestContext,? super HttpHeaders> grpcTrailersFilter)	Adds the specified grpcTrailersFilter for a CircuitBreakerRule.
CircuitBreakerRuleBuilder	onResponseHeaders(BiPredicate<? super ClientRequestContext,? super ResponseHeaders> responseHeadersFilter)	Adds the specified responseHeadersFilter for a CircuitBreakerRule.
CircuitBreakerRuleBuilder	onResponseTrailers(BiPredicate<? super ClientRequestContext,? super HttpHeaders> responseTrailersFilter)	Adds the specified responseTrailersFilter for a CircuitBreakerRule.
CircuitBreakerRuleBuilder	onServerErrorStatus()	Adds the HttpStatusClass.SERVER_ERROR for a CircuitBreakerRule.
CircuitBreakerRuleBuilder	onStatus(HttpStatus... statuses)	Adds the specified HttpStatuses for a CircuitBreakerRule.
CircuitBreakerRuleBuilder	onStatus(Iterable<HttpStatus> statuses)	Adds the specified HttpStatuses for a CircuitBreakerRule.
CircuitBreakerRuleBuilder	onStatus(BiPredicate<? super ClientRequestContext,? super HttpStatus> statusFilter)	Adds the specified statusFilter for a CircuitBreakerRule.
CircuitBreakerRuleBuilder	onStatusClass(HttpStatusClass... statusClasses)	Adds the specified HttpStatusClasses for a CircuitBreakerRule.
CircuitBreakerRuleBuilder	onStatusClass(Iterable<HttpStatusClass> statusClasses)	Adds the specified HttpStatusClasses for a CircuitBreakerRule.
CircuitBreakerRuleBuilder	onTimeoutException()	Reports a Response as a success or failure to a CircuitBreaker, or ignores it according to the build methods(thenSuccess(), thenFailure() and thenIgnore()), if a TimeoutException is raised.
CircuitBreakerRuleBuilder	onUnprocessed()	Reports a Response as a success or failure to a CircuitBreaker, or ignores it according to the build methods(thenSuccess(), thenFailure() and thenIgnore()), if an UnprocessedRequestException, which means that the request has not been processed by the server, is raised.
CircuitBreakerRule	thenFailure()	Returns a newly created CircuitBreakerRule that determines a Response as a failure when the rule matches.
CircuitBreakerRule	thenIgnore()	Returns a newly created CircuitBreakerRule that ignores a Response when the rule matches.
CircuitBreakerRule	thenSuccess()	Returns a newly created CircuitBreakerRule that determines a Response as a success when the rule matches.

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

exceptionFilter, grpcTrailersFilter, requestHeadersFilter, requiresResponseTrailers, responseHeadersFilter, responseTrailersFilter

Methods inherited from class java.lang.Object

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

Method Details

thenSuccess

public CircuitBreakerRule thenSuccess()

Returns a newly created CircuitBreakerRule that determines a Response as a success when the rule matches.

thenFailure

public CircuitBreakerRule thenFailure()

Returns a newly created CircuitBreakerRule that determines a Response as a failure when the rule matches.

thenIgnore

public CircuitBreakerRule thenIgnore()

Returns a newly created CircuitBreakerRule that ignores a Response when the rule matches.

onResponseHeaders

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

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

Overrides:

onResponseHeaders in class AbstractRuleBuilder

onResponseTrailers

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

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

Overrides:

onResponseTrailers in class AbstractRuleBuilder

onGrpcTrailers

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

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

Overrides:

onGrpcTrailers in class AbstractRuleBuilder

onStatusClass

public CircuitBreakerRuleBuilder onStatusClass(HttpStatusClass... statusClasses)

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

Overrides:

onStatusClass in class AbstractRuleBuilder

onStatusClass

public CircuitBreakerRuleBuilder onStatusClass(Iterable<HttpStatusClass> statusClasses)

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

Overrides:

onStatusClass in class AbstractRuleBuilder

onServerErrorStatus

public CircuitBreakerRuleBuilder onServerErrorStatus()

Adds the HttpStatusClass.SERVER_ERROR for a CircuitBreakerRule. If the class of the response status is HttpStatusClass.SERVER_ERROR, depending on the build methods(thenSuccess(), thenFailure() and thenIgnore()), a Response is reported as a success or failure to a CircuitBreaker or ignored.

Overrides:

onServerErrorStatus in class AbstractRuleBuilder

onStatus

public CircuitBreakerRuleBuilder onStatus(HttpStatus... statuses)

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

Overrides:

onStatus in class AbstractRuleBuilder

onStatus

public CircuitBreakerRuleBuilder onStatus(Iterable<HttpStatus> statuses)

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

Overrides:

onStatus in class AbstractRuleBuilder

onStatus

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

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

Overrides:

onStatus in class AbstractRuleBuilder

onException

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

Adds the specified exception type for a CircuitBreakerRule. If an Exception is raised and it is an instance of the specified exception, depending on the build methods(thenSuccess(), thenFailure() and thenIgnore()), a Response is reported as a success or failure to a CircuitBreaker or ignored.

Overrides:

onException in class AbstractRuleBuilder

onException

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

Adds the specified exceptionFilter for a CircuitBreakerRule. If an Exception is raised and the specified exceptionFilter returns true, depending on the build methods(thenSuccess(), thenFailure() and thenIgnore()), a Response is reported as a success or failure to a CircuitBreaker or ignored.

Overrides:

onException in class AbstractRuleBuilder

onException

public CircuitBreakerRuleBuilder onException()

Reports a Response as a success or failure to a CircuitBreaker, or ignores it according to the build methods(thenSuccess(), thenFailure() and thenIgnore()), if an Exception is raised.

Overrides:

onException in class AbstractRuleBuilder

onTimeoutException

public CircuitBreakerRuleBuilder onTimeoutException()

Reports a Response as a success or failure to a CircuitBreaker, or ignores it according to the build methods(thenSuccess(), thenFailure() and thenIgnore()), if a TimeoutException is raised.

Overrides:

onTimeoutException in class AbstractRuleBuilder

onUnprocessed

public CircuitBreakerRuleBuilder onUnprocessed()

Reports a Response as a success or failure to a CircuitBreaker, or ignores it according to the build methods(thenSuccess(), thenFailure() and thenIgnore()), if an UnprocessedRequestException, which means that the request has not been processed by the server, is raised.

Overrides:

onUnprocessed in class AbstractRuleBuilder