com.linecorp.armeria.client.circuitbreaker

Class CircuitBreakerClient

java.lang.Object

com.linecorp.armeria.common.util.AbstractUnwrappable<Client<T_I,T_O>>

com.linecorp.armeria.client.DecoratingClient<I,O,I,O>

com.linecorp.armeria.client.SimpleDecoratingClient<I,O>

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

com.linecorp.armeria.client.circuitbreaker.CircuitBreakerClient

All Implemented Interfaces:

Client<HttpRequest,HttpResponse>, HttpClient, Unwrappable

Direct Known Subclasses:

CircuitBreakerHttpClient

public class CircuitBreakerClient
extends AbstractCircuitBreakerClient<HttpRequest,HttpResponse>
implements HttpClient

An HttpClient decorator that handles failures of HTTP requests based on circuit breaker pattern.

Method Summary

Modifier and Type	Method and Description
static CircuitBreakerClientBuilder	builder(CircuitBreakerStrategy strategy) Returns a new CircuitBreakerClientBuilder with the specified CircuitBreakerStrategy.
static CircuitBreakerClientBuilder	builder(CircuitBreakerStrategyWithContent<HttpResponse> strategyWithContent) Returns a new CircuitBreakerClientBuilder with the specified CircuitBreakerStrategyWithContent.
protected HttpResponse	doExecute(ClientRequestContext ctx, HttpRequest req, CircuitBreaker circuitBreaker) Invoked when the CircuitBreaker is in closed state.
static Function<? super HttpClient,CircuitBreakerClient>	newDecorator(CircuitBreaker circuitBreaker, CircuitBreakerStrategy strategy) Creates a new decorator using the specified CircuitBreaker instance and CircuitBreakerStrategy.
static Function<? super HttpClient,CircuitBreakerClient>	newDecorator(CircuitBreakerMapping mapping, CircuitBreakerStrategy strategy) Creates a new decorator with the specified CircuitBreakerMapping and CircuitBreakerStrategy.
static Function<? super HttpClient,CircuitBreakerClient>	newPerHostAndMethodDecorator(Function<String,CircuitBreaker> factory, CircuitBreakerStrategy strategy) Creates a new decorator that binds one CircuitBreaker per host and HttpMethod with the specified CircuitBreakerStrategy.
static Function<? super HttpClient,CircuitBreakerClient>	newPerHostDecorator(Function<String,CircuitBreaker> factory, CircuitBreakerStrategy strategy) Creates a new decorator that binds one CircuitBreaker per host with the specified CircuitBreakerStrategy.
static Function<? super HttpClient,CircuitBreakerClient>	newPerMethodDecorator(Function<String,CircuitBreaker> factory, CircuitBreakerStrategy strategy) Creates a new decorator that binds one CircuitBreaker per HttpMethod with the specified CircuitBreakerStrategy.

Methods inherited from class com.linecorp.armeria.client.circuitbreaker.AbstractCircuitBreakerClient

execute, reportSuccessOrFailure, strategy, strategyWithContent

Methods inherited from class com.linecorp.armeria.common.util.AbstractUnwrappable

as, delegate, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.client.HttpClient

execute

Methods inherited from interface com.linecorp.armeria.client.Client

as

Method Detail

newDecorator

public static Function<? super HttpClient,CircuitBreakerClient> newDecorator(CircuitBreaker circuitBreaker,
                                                                             CircuitBreakerStrategy strategy)

Creates a new decorator using the specified CircuitBreaker instance and CircuitBreakerStrategy.

Since CircuitBreaker is a unit of failure detection, don't reuse the same instance for unrelated services.

newDecorator

public static Function<? super HttpClient,CircuitBreakerClient> newDecorator(CircuitBreakerMapping mapping,
                                                                             CircuitBreakerStrategy strategy)

Creates a new decorator with the specified CircuitBreakerMapping and CircuitBreakerStrategy.

Since CircuitBreaker is a unit of failure detection, don't reuse the same instance for unrelated services.

newPerMethodDecorator

public static Function<? super HttpClient,CircuitBreakerClient> newPerMethodDecorator(Function<String,CircuitBreaker> factory,
                                                                                      CircuitBreakerStrategy strategy)

Creates a new decorator that binds one CircuitBreaker per HttpMethod with the specified CircuitBreakerStrategy.

Since CircuitBreaker is a unit of failure detection, don't reuse the same instance for unrelated services.

Parameters:

factory - a function that takes an HttpMethod and creates a new CircuitBreaker

newPerHostDecorator

public static Function<? super HttpClient,CircuitBreakerClient> newPerHostDecorator(Function<String,CircuitBreaker> factory,
                                                                                    CircuitBreakerStrategy strategy)

Creates a new decorator that binds one CircuitBreaker per host with the specified CircuitBreakerStrategy.

Since CircuitBreaker is a unit of failure detection, don't reuse the same instance for unrelated services.

Parameters:

factory - a function that takes a host name and creates a new CircuitBreaker

newPerHostAndMethodDecorator

public static Function<? super HttpClient,CircuitBreakerClient> newPerHostAndMethodDecorator(Function<String,CircuitBreaker> factory,
                                                                                             CircuitBreakerStrategy strategy)

Creates a new decorator that binds one CircuitBreaker per host and HttpMethod with the specified CircuitBreakerStrategy.

Since CircuitBreaker is a unit of failure detection, don't reuse the same instance for unrelated services.

Parameters:

factory - a function that takes a host+method and creates a new CircuitBreaker

builder

public static CircuitBreakerClientBuilder builder(CircuitBreakerStrategy strategy)

Returns a new CircuitBreakerClientBuilder with the specified CircuitBreakerStrategy.

builder

public static CircuitBreakerClientBuilder builder(CircuitBreakerStrategyWithContent<HttpResponse> strategyWithContent)

Returns a new CircuitBreakerClientBuilder with the specified CircuitBreakerStrategyWithContent.

doExecute

protected HttpResponse doExecute(ClientRequestContext ctx,
                                 HttpRequest req,
                                 CircuitBreaker circuitBreaker)
                          throws Exception

Description copied from class: AbstractCircuitBreakerClient

Invoked when the CircuitBreaker is in closed state.

Specified by:

doExecute in class AbstractCircuitBreakerClient<HttpRequest,HttpResponse>

Throws:

Exception