Package com.linecorp.armeria.client.circuitbreaker

Class CircuitBreakerClientBuilder

java.lang.Object

com.linecorp.armeria.client.circuitbreaker.AbstractCircuitBreakerClientBuilder<HttpRequest,HttpResponse>

com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClientBuilder

public final class CircuitBreakerClientBuilder
extends AbstractCircuitBreakerClientBuilder<HttpRequest,HttpResponse>

Builds a new CircuitBreakerClient or its decorator function.

Method Summary

Modifier and Type	Method	Description
CircuitBreakerClient	build(HttpClient delegate)	Returns a newly-created CircuitBreakerClient based on the properties of this builder.
CircuitBreakerClientBuilder	handler(CircuitBreakerClientHandler handler)	Sets the CircuitBreakerClientHandler.
CircuitBreakerClientBuilder	mapping(CircuitBreakerMapping mapping)	Sets the CircuitBreakerMapping.
Function<? super HttpClient,CircuitBreakerClient>	newDecorator()	Returns a newly-created decorator that decorates an HttpClient with a new CircuitBreakerClient based on the properties of this builder.
CircuitBreakerClientBuilder	recover(BiFunction<? super ClientRequestContext,? super HttpRequest,? extends HttpResponse> fallback)	Sets the BiFunction.

Methods inherited from class java.lang.Object

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

Method Details

build

public CircuitBreakerClient build(HttpClient delegate)

Returns a newly-created CircuitBreakerClient based on the properties of this builder.

newDecorator

public Function<? super HttpClient,CircuitBreakerClient> newDecorator()

Returns a newly-created decorator that decorates an HttpClient with a new CircuitBreakerClient based on the properties of this builder.

mapping

public CircuitBreakerClientBuilder mapping(CircuitBreakerMapping mapping)

Description copied from class: AbstractCircuitBreakerClientBuilder

Sets the CircuitBreakerMapping. If unspecified, CircuitBreakerMapping.ofDefault() will be used. Note that the CircuitBreakerClientHandler set by calling AbstractCircuitBreakerClientBuilder.handler(CircuitBreakerClientHandler) will be overwritten by calling this method.

Overrides:

mapping in class AbstractCircuitBreakerClientBuilder<HttpRequest,HttpResponse>

Returns:

this to support method chaining.

handler

@UnstableApi
public CircuitBreakerClientBuilder handler(CircuitBreakerClientHandler handler)

Description copied from class: AbstractCircuitBreakerClientBuilder

Sets the CircuitBreakerClientHandler. Note that the CircuitBreakerMapping set by calling AbstractCircuitBreakerClientBuilder.mapping(CircuitBreakerMapping) will be overwritten by calling this method.

Overrides:

handler in class AbstractCircuitBreakerClientBuilder<HttpRequest,HttpResponse>

Returns:

this to support method chaining.

recover

public CircuitBreakerClientBuilder recover(BiFunction<? super ClientRequestContext,? super HttpRequest,? extends HttpResponse> fallback)

Description copied from class: AbstractCircuitBreakerClientBuilder

Sets the BiFunction. This is invoked when adding the fallback strategy.

For example:

 CircuitBreakerClient
   .builder(...)
   .recover((ctx, req) -> {
       // fallback logic
       return HttpResponse.of(...);
   });
 

Overrides:

recover in class AbstractCircuitBreakerClientBuilder<HttpRequest,HttpResponse>

Returns:

this to support method chaining.