Package com.linecorp.armeria.client.circuitbreaker

Class KeyedCircuitBreakerMapping<K>

java.lang.Object

com.linecorp.armeria.client.circuitbreaker.KeyedCircuitBreakerMapping<K>

Type Parameters:

K - the key type

All Implemented Interfaces:

CircuitBreakerMapping

public final class KeyedCircuitBreakerMapping<K>
extends Object
implements CircuitBreakerMapping

A CircuitBreakerMapping that binds a CircuitBreaker to its key. KeyedCircuitBreakerMapping.KeySelector is used to resolve the key from a Request. If there is no circuit breaker bound to the key, a new one is created by using the given circuit breaker factory.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KeyedCircuitBreakerMapping.KeySelector<K>	Returns the mapping key of the given Request.

Constructor Summary

Constructors

Constructor	Description
KeyedCircuitBreakerMapping(KeyedCircuitBreakerMapping.KeySelector<K> keySelector, Function<K,CircuitBreaker> factory)	Creates a new KeyedCircuitBreakerMapping with the given KeyedCircuitBreakerMapping.KeySelector and CircuitBreaker factory.

Method Summary

Modifier and Type	Method	Description
CircuitBreaker	get(ClientRequestContext ctx, Request req)	Returns the CircuitBreaker mapped to the given parameters.

Methods inherited from class java.lang.Object

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

Constructor Details

KeyedCircuitBreakerMapping

public KeyedCircuitBreakerMapping(KeyedCircuitBreakerMapping.KeySelector<K> keySelector, Function<K,CircuitBreaker> factory)

Creates a new KeyedCircuitBreakerMapping with the given KeyedCircuitBreakerMapping.KeySelector and CircuitBreaker factory.

Parameters:

keySelector - A function that returns the key of the given Request.

factory - A function that takes a key and creates a new CircuitBreaker for the key.

Method Details

get

public CircuitBreaker get(ClientRequestContext ctx, Request req) throws Exception

Description copied from interface: CircuitBreakerMapping

Returns the CircuitBreaker mapped to the given parameters.

Specified by:

get in interface CircuitBreakerMapping

Throws:

Exception