Package 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

public final 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	Description
static CircuitBreakerClientBuilder	builder(CircuitBreakerRule rule)	Returns a new CircuitBreakerClientBuilder with the specified CircuitBreakerRule.
static CircuitBreakerClientBuilder	builder(CircuitBreakerRuleWithContent<HttpResponse> ruleWithContent)	Returns a new CircuitBreakerClientBuilder with the specified CircuitBreakerRuleWithContent.
static CircuitBreakerClientBuilder	builder(CircuitBreakerRuleWithContent<HttpResponse> ruleWithContent, int maxContentLength)	Returns a new CircuitBreakerClientBuilder with the specified CircuitBreakerRuleWithContent and the specified maxContentLength which is required to determine a Response as a success or failure.
protected HttpResponse	doExecute(ClientRequestContext ctx, HttpRequest req, CircuitBreakerCallback callback)	Invoked when the CircuitBreaker is in closed state.
static Function<? super HttpClient,CircuitBreakerClient>	newDecorator(CircuitBreakerClientHandler handler, CircuitBreakerRule rule)	Creates a new decorator with the specified CircuitBreakerClientHandler and CircuitBreakerRule.
static Function<? super HttpClient,CircuitBreakerClient>	newDecorator(CircuitBreakerClientHandler handler, CircuitBreakerRuleWithContent<HttpResponse> ruleWithContent)	Creates a new decorator with the specified CircuitBreakerClientHandler and CircuitBreakerRuleWithContent.
static Function<? super HttpClient,CircuitBreakerClient>	newDecorator(CircuitBreakerMapping mapping, CircuitBreakerRule rule)	Creates a new decorator with the specified CircuitBreakerMapping and CircuitBreakerRule.
static Function<? super HttpClient,CircuitBreakerClient>	newDecorator(CircuitBreakerMapping mapping, CircuitBreakerRuleWithContent<HttpResponse> ruleWithContent)	Creates a new decorator with the specified CircuitBreakerMapping and CircuitBreakerRuleWithContent.
static Function<? super HttpClient,CircuitBreakerClient>	newDecorator(CircuitBreaker circuitBreaker, CircuitBreakerRule rule)	Creates a new decorator using the specified CircuitBreaker instance and CircuitBreakerRule.
static Function<? super HttpClient,CircuitBreakerClient>	newDecorator(CircuitBreaker circuitBreaker, CircuitBreakerRuleWithContent<HttpResponse> ruleWithContent)	Creates a new decorator using the specified CircuitBreaker instance and CircuitBreakerRuleWithContent.
static Function<? super HttpClient,CircuitBreakerClient>	newPerHostAndMethodDecorator(BiFunction<String,String,? extends CircuitBreaker> factory, CircuitBreakerRule rule)	Deprecated. Use newDecorator(CircuitBreakerMapping, CircuitBreakerRule) with CircuitBreakerMapping.perHostAndMethod(BiFunction).
static Function<? super HttpClient,CircuitBreakerClient>	newPerHostAndMethodDecorator(BiFunction<String,String,? extends CircuitBreaker> factory, CircuitBreakerRuleWithContent<HttpResponse> ruleWithContent)	Deprecated. Use newDecorator(CircuitBreakerMapping, CircuitBreakerRuleWithContent) with CircuitBreakerMapping.perHostAndMethod(BiFunction).
static Function<? super HttpClient,CircuitBreakerClient>	newPerHostDecorator(Function<String,? extends CircuitBreaker> factory, CircuitBreakerRule rule)	Creates a new decorator that binds one CircuitBreaker per host with the specified CircuitBreakerRule.
static Function<? super HttpClient,CircuitBreakerClient>	newPerHostDecorator(Function<String,? extends CircuitBreaker> factory, CircuitBreakerRuleWithContent<HttpResponse> ruleWithContent)	Creates a new decorator that binds one CircuitBreaker per host with the specified CircuitBreakerRuleWithContent.
static Function<? super HttpClient,CircuitBreakerClient>	newPerMethodDecorator(Function<String,? extends CircuitBreaker> factory, CircuitBreakerRule rule)	Creates a new decorator that binds one CircuitBreaker per HttpMethod with the specified CircuitBreakerRule.
static Function<? super HttpClient,CircuitBreakerClient>	newPerMethodDecorator(Function<String,? extends CircuitBreaker> factory, CircuitBreakerRuleWithContent<HttpResponse> ruleWithContent)	Creates a new decorator that binds one CircuitBreaker per HttpMethod with the specified CircuitBreakerRuleWithContent.
static Function<? super HttpClient,CircuitBreakerClient>	newPerPathDecorator(Function<String,? extends CircuitBreaker> factory, CircuitBreakerRule rule)	Creates a new decorator that binds one CircuitBreaker per request path with the specified CircuitBreakerRule.
static Function<? super HttpClient,CircuitBreakerClient>	newPerPathDecorator(Function<String,? extends CircuitBreaker> factory, CircuitBreakerRuleWithContent<HttpResponse> ruleWithContent)	Creates a new decorator that binds one CircuitBreaker per request path with the specified CircuitBreakerRuleWithContent.

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

execute, toString

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

as, unwrap, unwrapAll

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.Client

as, unwrap

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

execute

Methods inherited from interface com.linecorp.armeria.common.util.Unwrappable

equalsIgnoreWrapper, unwrapAll

Method Details

newDecorator

public static Function<? super HttpClient,CircuitBreakerClient> newDecorator(CircuitBreaker circuitBreaker,
 CircuitBreakerRule rule)

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

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(CircuitBreaker circuitBreaker,
 CircuitBreakerRuleWithContent<HttpResponse> ruleWithContent)

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

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,
 CircuitBreakerRule rule)

Creates a new decorator with the specified CircuitBreakerMapping and CircuitBreakerRule.

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

newDecorator

@UnstableApi
public static Function<? super HttpClient,CircuitBreakerClient> newDecorator(CircuitBreakerClientHandler handler,
 CircuitBreakerRule rule)

Creates a new decorator with the specified CircuitBreakerClientHandler and CircuitBreakerRule.

newDecorator

public static Function<? super HttpClient,CircuitBreakerClient> newDecorator(CircuitBreakerMapping mapping,
 CircuitBreakerRuleWithContent<HttpResponse> ruleWithContent)

Creates a new decorator with the specified CircuitBreakerMapping and CircuitBreakerRuleWithContent.

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

newDecorator

@UnstableApi
public static Function<? super HttpClient,CircuitBreakerClient> newDecorator(CircuitBreakerClientHandler handler,
 CircuitBreakerRuleWithContent<HttpResponse> ruleWithContent)

Creates a new decorator with the specified CircuitBreakerClientHandler and CircuitBreakerRuleWithContent.

newPerMethodDecorator

public static Function<? super HttpClient,CircuitBreakerClient> newPerMethodDecorator(Function<String,? extends CircuitBreaker> factory,
 CircuitBreakerRule rule)

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

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.

newPerMethodDecorator

public static Function<? super HttpClient,CircuitBreakerClient> newPerMethodDecorator(Function<String,? extends CircuitBreaker> factory,
 CircuitBreakerRuleWithContent<HttpResponse> ruleWithContent)

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

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,? extends CircuitBreaker> factory,
 CircuitBreakerRule rule)

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

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.

newPerHostDecorator

public static Function<? super HttpClient,CircuitBreakerClient> newPerHostDecorator(Function<String,? extends CircuitBreaker> factory,
 CircuitBreakerRuleWithContent<HttpResponse> ruleWithContent)

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

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.

newPerPathDecorator

public static Function<? super HttpClient,CircuitBreakerClient> newPerPathDecorator(Function<String,? extends CircuitBreaker> factory,
 CircuitBreakerRule rule)

Creates a new decorator that binds one CircuitBreaker per request path with the specified CircuitBreakerRule.

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

Parameters:

factory - a function that takes a request path and creates a new CircuitBreaker.

newPerPathDecorator

public static Function<? super HttpClient,CircuitBreakerClient> newPerPathDecorator(Function<String,? extends CircuitBreaker> factory,
 CircuitBreakerRuleWithContent<HttpResponse> ruleWithContent)

Creates a new decorator that binds one CircuitBreaker per request path with the specified CircuitBreakerRuleWithContent.

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

Parameters:

factory - a function that takes a request path and creates a new CircuitBreaker.

newPerHostAndMethodDecorator

@Deprecated
public static Function<? super HttpClient,CircuitBreakerClient> newPerHostAndMethodDecorator(BiFunction<String,String,? extends CircuitBreaker> factory,
 CircuitBreakerRule rule)

Deprecated.

Use newDecorator(CircuitBreakerMapping, CircuitBreakerRule) with CircuitBreakerMapping.perHostAndMethod(BiFunction).

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

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.

newPerHostAndMethodDecorator

@Deprecated
public static Function<? super HttpClient,CircuitBreakerClient> newPerHostAndMethodDecorator(BiFunction<String,String,? extends CircuitBreaker> factory,
 CircuitBreakerRuleWithContent<HttpResponse> ruleWithContent)

Deprecated.

Use newDecorator(CircuitBreakerMapping, CircuitBreakerRuleWithContent) with CircuitBreakerMapping.perHostAndMethod(BiFunction).

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

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(CircuitBreakerRule rule)

Returns a new CircuitBreakerClientBuilder with the specified CircuitBreakerRule.

builder

public static CircuitBreakerClientBuilder builder(CircuitBreakerRuleWithContent<HttpResponse> ruleWithContent)

Returns a new CircuitBreakerClientBuilder with the specified CircuitBreakerRuleWithContent.

builder

public static CircuitBreakerClientBuilder builder(CircuitBreakerRuleWithContent<HttpResponse> ruleWithContent,
 int maxContentLength)

Returns a new CircuitBreakerClientBuilder with the specified CircuitBreakerRuleWithContent and the specified maxContentLength which is required to determine a Response as a success or failure.

Throws:

IllegalArgumentException - if the specified maxContentLength is equal to or less than 0

doExecute

protected HttpResponse doExecute(ClientRequestContext ctx,
 HttpRequest req,
 CircuitBreakerCallback callback)
                          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