Package com.linecorp.armeria.client.circuitbreaker

Class CircuitBreakerRpcClientBuilder

java.lang.Object

com.linecorp.armeria.client.circuitbreaker.AbstractCircuitBreakerClientBuilder<RpcRequest,RpcResponse>

com.linecorp.armeria.client.circuitbreaker.CircuitBreakerRpcClientBuilder

public final class CircuitBreakerRpcClientBuilder
extends AbstractCircuitBreakerClientBuilder<RpcRequest,RpcResponse>

Builds a new CircuitBreakerRpcClient or its decorator function.

Method Summary

Modifier and Type	Method	Description
CircuitBreakerRpcClient	build(RpcClient delegate)	Returns a newly-created CircuitBreakerRpcClient based on the properties of this builder.
CircuitBreakerRpcClientBuilder	handler(CircuitBreakerClientHandler handler)	Sets the CircuitBreakerClientHandler.
CircuitBreakerRpcClientBuilder	mapping(CircuitBreakerMapping mapping)	Sets the CircuitBreakerMapping.
Function<? super RpcClient,CircuitBreakerRpcClient>	newDecorator()	Returns a newly-created decorator that decorates an RpcClient with a new CircuitBreakerRpcClient based on the properties of this builder.
CircuitBreakerRpcClientBuilder	recover(BiFunction<? super ClientRequestContext,? super RpcRequest,? extends RpcResponse> 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 CircuitBreakerRpcClient build(RpcClient delegate)

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

newDecorator

public Function<? super RpcClient,CircuitBreakerRpcClient> newDecorator()

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

mapping

public CircuitBreakerRpcClientBuilder 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<RpcRequest,RpcResponse>

Returns:

this to support method chaining.

handler

public CircuitBreakerRpcClientBuilder 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<RpcRequest,RpcResponse>

Returns:

this to support method chaining.

recover

public CircuitBreakerRpcClientBuilder recover(BiFunction<? super ClientRequestContext,? super RpcRequest,? extends RpcResponse> 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<RpcRequest,RpcResponse>

Returns:

this to support method chaining.