Package com.linecorp.armeria.client.circuitbreaker

Class CircuitBreakerRuleWithContentBuilder<T extends Response>

java.lang.Object

com.linecorp.armeria.client.AbstractRuleBuilder

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

com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRuleWithContentBuilder<T>

Type Parameters:

T - the response type

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

A builder for creating a new CircuitBreakerRuleWithContent.

Method Summary

Modifier and Type	Method	Description
CircuitBreakerRuleWithContentBuilder<T>	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.
CircuitBreakerRuleWithContentBuilder<T>	onException(Class<? extends Throwable> exception)	Adds the specified exception type for a CircuitBreakerRuleWithContent.
CircuitBreakerRuleWithContentBuilder<T>	onException(BiPredicate<? super ClientRequestContext,? super Throwable> exceptionFilter)	Adds the specified exceptionFilter for a CircuitBreakerRuleWithContent.
CircuitBreakerRuleWithContentBuilder<T>	onResponse(BiFunction<? super ClientRequestContext,? super T,? extends CompletionStage<Boolean>> responseFilter)	Adds the specified responseFilter for a CircuitBreakerRuleWithContent.
CircuitBreakerRuleWithContentBuilder<T>	onResponseHeaders(BiPredicate<? super ClientRequestContext,? super ResponseHeaders> responseHeadersFilter)	Adds the specified responseHeadersFilter for a CircuitBreakerRuleWithContent.
CircuitBreakerRuleWithContentBuilder<T>	onResponseTrailers(BiPredicate<? super ClientRequestContext,? super HttpHeaders> responseTrailersFilter)	Adds the specified responseTrailersFilter for a CircuitBreakerRuleWithContent.
CircuitBreakerRuleWithContentBuilder<T>	onServerErrorStatus()	Adds the HttpStatusClass.SERVER_ERROR for a CircuitBreakerRuleWithContent.
CircuitBreakerRuleWithContentBuilder<T>	onStatus(HttpStatus... statuses)	Adds the specified HttpStatuses for a CircuitBreakerRuleWithContent.
CircuitBreakerRuleWithContentBuilder<T>	onStatus(Iterable<HttpStatus> statuses)	Adds the specified HttpStatuses for a CircuitBreakerRuleWithContent.
CircuitBreakerRuleWithContentBuilder<T>	onStatus(BiPredicate<? super ClientRequestContext,? super HttpStatus> statusFilter)	Adds the specified statusFilter for a CircuitBreakerRuleWithContent.
CircuitBreakerRuleWithContentBuilder<T>	onStatusClass(HttpStatusClass... statusClasses)	Adds the specified HttpStatusClasses for a CircuitBreakerRuleWithContent.
CircuitBreakerRuleWithContentBuilder<T>	onStatusClass(Iterable<HttpStatusClass> statusClasses)	Adds the specified HttpStatusClasses for a CircuitBreakerRuleWithContent.
CircuitBreakerRuleWithContentBuilder<T>	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.
CircuitBreakerRuleWithContent<T>	thenFailure()	Returns a newly created CircuitBreakerRuleWithContent that determines a Response as a failure when the rule matches.
CircuitBreakerRuleWithContent<T>	thenIgnore()	Returns a newly created CircuitBreakerRuleWithContent that ignores a Response when the rule matches.
CircuitBreakerRuleWithContent<T>	thenSuccess()	Returns a newly created CircuitBreakerRuleWithContent that determines a Response as a success when the rule matches.

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

thenSuccess

public CircuitBreakerRuleWithContent<T> thenSuccess()

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

thenFailure

public CircuitBreakerRuleWithContent<T> thenFailure()

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

thenIgnore

public CircuitBreakerRuleWithContent<T> thenIgnore()

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

onResponse

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

Adds the specified responseFilter for a CircuitBreakerRuleWithContent. If the specified responseFilter completes with 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:

onResponse in class AbstractRuleWithContentBuilder<T extends Response>

onResponseHeaders

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

Adds the specified responseHeadersFilter for a CircuitBreakerRuleWithContent. 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 CircuitBreakerRuleWithContentBuilder<T> onResponseTrailers(BiPredicate<? super ClientRequestContext,? super HttpHeaders> responseTrailersFilter)

Adds the specified responseTrailersFilter for a CircuitBreakerRuleWithContent. 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

onStatusClass

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

Adds the specified HttpStatusClasses for a CircuitBreakerRuleWithContent. 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 CircuitBreakerRuleWithContentBuilder<T> onStatusClass(Iterable<HttpStatusClass> statusClasses)

Adds the specified HttpStatusClasses for a CircuitBreakerRuleWithContent. 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 CircuitBreakerRuleWithContentBuilder<T> onServerErrorStatus()

Adds the HttpStatusClass.SERVER_ERROR for a CircuitBreakerRuleWithContent. 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 CircuitBreakerRuleWithContentBuilder<T> onStatus(HttpStatus... statuses)

Adds the specified HttpStatuses for a CircuitBreakerRuleWithContent. 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 CircuitBreakerRuleWithContentBuilder<T> onStatus(Iterable<HttpStatus> statuses)

Adds the specified HttpStatuses for a CircuitBreakerRuleWithContent. 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 CircuitBreakerRuleWithContentBuilder<T> onStatus(BiPredicate<? super ClientRequestContext,? super HttpStatus> statusFilter)

Adds the specified statusFilter for a CircuitBreakerRuleWithContent. 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 CircuitBreakerRuleWithContentBuilder<T> onException(Class<? extends Throwable> exception)

Adds the specified exception type for a CircuitBreakerRuleWithContent. 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 CircuitBreakerRuleWithContentBuilder<T> onException(BiPredicate<? super ClientRequestContext,? super Throwable> exceptionFilter)

Adds the specified exceptionFilter for a CircuitBreakerRuleWithContent. 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 CircuitBreakerRuleWithContentBuilder<T> 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

onUnprocessed

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