Package com.linecorp.armeria.client.circuitbreaker

Interface CircuitBreakerMapping

All Superinterfaces:

ClientCircuitBreakerGenerator<CircuitBreaker>

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface CircuitBreakerMapping
extends ClientCircuitBreakerGenerator<CircuitBreaker>

Returns a CircuitBreaker instance from remote invocation parameters.

Method Summary

Modifier and Type	Method	Description
static CircuitBreakerMappingBuilder	builder()	Returns a builder that builds a CircuitBreakerMapping by setting host, method and/or path.
CircuitBreaker	get(ClientRequestContext ctx, Request req)	Returns the CircuitBreaker mapped to the given parameters.
static CircuitBreakerMapping	ofDefault()	Returns the default CircuitBreakerMapping.
static CircuitBreakerMapping	perHost(Function<String,? extends CircuitBreaker> factory)	Creates a new CircuitBreakerMapping which maps CircuitBreakers with the remote host name.
static CircuitBreakerMapping	perHostAndMethod(BiFunction<String,String,? extends CircuitBreaker> factory)	Creates a new CircuitBreakerMapping which maps CircuitBreakers with the remote host and method name.
static CircuitBreakerMapping	perMethod(Function<String,? extends CircuitBreaker> factory)	Creates a new CircuitBreakerMapping which maps CircuitBreakers with method name.
static CircuitBreakerMapping	perPath(Function<String,? extends CircuitBreaker> factory)	Creates a new CircuitBreakerMapping which maps CircuitBreakers with the request path.

Method Details

ofDefault

static CircuitBreakerMapping ofDefault()

Returns the default CircuitBreakerMapping.

builder

static CircuitBreakerMappingBuilder builder()

Returns a builder that builds a CircuitBreakerMapping by setting host, method and/or path.

perMethod

static CircuitBreakerMapping perMethod(Function<String,? extends CircuitBreaker> factory)

Creates a new CircuitBreakerMapping which maps CircuitBreakers with method name.

Parameters:

factory - the function that takes a method name and creates a new CircuitBreaker

perHost

static CircuitBreakerMapping perHost(Function<String,? extends CircuitBreaker> factory)

Creates a new CircuitBreakerMapping which maps CircuitBreakers with the remote host name.

Parameters:

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

perPath

static CircuitBreakerMapping perPath(Function<String,? extends CircuitBreaker> factory)

Creates a new CircuitBreakerMapping which maps CircuitBreakers with the request path.

Parameters:

factory - the function that takes a path and creates a new CircuitBreaker

perHostAndMethod

static CircuitBreakerMapping perHostAndMethod(BiFunction<String,String,? extends CircuitBreaker> factory)

Creates a new CircuitBreakerMapping which maps CircuitBreakers with the remote host and method name.

Parameters:

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

get

CircuitBreaker get(ClientRequestContext ctx,
 Request req)
            throws Exception

Returns the CircuitBreaker mapped to the given parameters.

Specified by:

get in interface ClientCircuitBreakerGenerator<CircuitBreaker>

Throws:

Exception