Package com.linecorp.armeria.client.circuitbreaker

Class CircuitBreakerHttpClient

java.lang.Object

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

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

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

com.linecorp.armeria.client.circuitbreaker.CircuitBreakerHttpClient

All Implemented Interfaces:

Client<HttpRequest,HttpResponse>

public final class CircuitBreakerHttpClient
extends CircuitBreakerClient<HttpRequest,HttpResponse>

A Client decorator that handles failures of HTTP requests based on circuit breaker pattern.

Method Summary

Modifier and Type	Method	Description
protected HttpResponse	doExecute(ClientRequestContext ctx, HttpRequest req, CircuitBreaker circuitBreaker)	Invoked when the CircuitBreaker is in closed state.
static Function<Client<HttpRequest,HttpResponse>,CircuitBreakerHttpClient>	newDecorator(CircuitBreakerMapping mapping, CircuitBreakerStrategy strategy)	Creates a new decorator with the specified CircuitBreakerMapping and CircuitBreakerStrategy.
static Function<Client<HttpRequest,HttpResponse>,CircuitBreakerHttpClient>	newDecorator(CircuitBreaker circuitBreaker, CircuitBreakerStrategy strategy)	Creates a new decorator using the specified CircuitBreaker instance and CircuitBreakerStrategy.
static Function<Client<HttpRequest,HttpResponse>,CircuitBreakerHttpClient>	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<Client<HttpRequest,HttpResponse>,CircuitBreakerHttpClient>	newPerHostDecorator(Function<String,CircuitBreaker> factory, CircuitBreakerStrategy strategy)	Creates a new decorator that binds one CircuitBreaker per host with the specified CircuitBreakerStrategy.
static Function<Client<HttpRequest,HttpResponse>,CircuitBreakerHttpClient>	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.CircuitBreakerClient

execute, reportSuccessOrFailure, strategy, strategyWithContent

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

delegate, toString

Methods inherited from class java.lang.Object

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

Method Detail

newDecorator

public static Function<Client<HttpRequest,HttpResponse>,CircuitBreakerHttpClient> 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<Client<HttpRequest,HttpResponse>,CircuitBreakerHttpClient> 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<Client<HttpRequest,HttpResponse>,CircuitBreakerHttpClient> 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 a HttpMethod and creates a new CircuitBreaker

newPerHostDecorator

public static Function<Client<HttpRequest,HttpResponse>,CircuitBreakerHttpClient> 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<Client<HttpRequest,HttpResponse>,CircuitBreakerHttpClient> 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

doExecute

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

Description copied from class: CircuitBreakerClient

Invoked when the CircuitBreaker is in closed state.

Specified by:

doExecute in class CircuitBreakerClient<HttpRequest,HttpResponse>

Throws:

Exception