Package com.linecorp.armeria.client.circuitbreaker

Class AbstractCircuitBreakerClient<I extends Request,O extends Response>

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<I,O>

Type Parameters:

I - the Request type

O - the Response type

All Implemented Interfaces:

Client<I,O>, Unwrappable

Direct Known Subclasses:

CircuitBreakerClient, CircuitBreakerRpcClient

public abstract class AbstractCircuitBreakerClient<I extends Request,O extends Response>
extends SimpleDecoratingClient<I,O>

A Client decorator that handles failures of remote invocation based on circuit breaker pattern.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCircuitBreakerClient(Client<I,O> delegate, CircuitBreakerMapping mapping, CircuitBreakerStrategy strategy)	Creates a new instance that decorates the specified Client.
protected	AbstractCircuitBreakerClient(Client<I,O> delegate, CircuitBreakerMapping mapping, CircuitBreakerStrategyWithContent<O> strategyWithContent)	Creates a new instance that decorates the specified Client.

Method Summary

Modifier and Type	Method	Description
protected abstract O	doExecute(ClientRequestContext ctx, I req, CircuitBreaker circuitBreaker)	Invoked when the CircuitBreaker is in closed state.
O	execute(ClientRequestContext ctx, I req)	Sends a Request to a remote Endpoint, as specified in ClientRequestContext.endpoint().
protected static void	reportSuccessOrFailure(CircuitBreaker circuitBreaker, CompletionStage<Boolean> future)	Reports a success or a failure to the specified CircuitBreaker according to the completed value of the specified future.
protected CircuitBreakerStrategy	strategy()	Returns the CircuitBreakerStrategy.
protected CircuitBreakerStrategyWithContent<O>	strategyWithContent()	Returns the CircuitBreakerStrategyWithContent.

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

as

Constructor Details

AbstractCircuitBreakerClient

protected AbstractCircuitBreakerClient(Client<I,O> delegate, CircuitBreakerMapping mapping, CircuitBreakerStrategy strategy)

Creates a new instance that decorates the specified Client.

AbstractCircuitBreakerClient

protected AbstractCircuitBreakerClient(Client<I,O> delegate, CircuitBreakerMapping mapping, CircuitBreakerStrategyWithContent<O> strategyWithContent)

Creates a new instance that decorates the specified Client.

Method Details

strategy

protected final CircuitBreakerStrategy strategy()

Returns the CircuitBreakerStrategy.

Throws:

IllegalStateException - if the CircuitBreakerStrategy is not set

strategyWithContent

protected final CircuitBreakerStrategyWithContent<O> strategyWithContent()

Returns the CircuitBreakerStrategyWithContent.

Throws:

IllegalStateException - if the CircuitBreakerStrategyWithContent is not set

execute

public O execute(ClientRequestContext ctx, I req) throws Exception

Description copied from interface: Client

Sends a Request to a remote Endpoint, as specified in ClientRequestContext.endpoint().

Returns:

the Response to the specified Request

Throws:

Exception

doExecute

protected abstract O doExecute(ClientRequestContext ctx, I req, CircuitBreaker circuitBreaker) throws Exception

Invoked when the CircuitBreaker is in closed state.

Throws:

Exception

reportSuccessOrFailure

protected static void reportSuccessOrFailure(CircuitBreaker circuitBreaker, CompletionStage<Boolean> future)

Reports a success or a failure to the specified CircuitBreaker according to the completed value of the specified future. If the completed value is null, this doesn't do anything.