io.github.resilience4j.circuitbreaker

Interface CircuitBreaker

All Known Implementing Classes:

CircuitBreakerStateMachine

public interface CircuitBreaker

A CircuitBreaker instance is thread-safe can be used to decorate multiple requests.

A CircuitBreaker manages the state of a backend system. The CircuitBreaker is implemented via a finite state machine with five states: CLOSED, OPEN, HALF_OPEN, DISABLED AND FORCED_OPEN. The CircuitBreaker does not know anything about the backend's state by itself, but uses the information provided by the decorators via onSuccess(long, java.util.concurrent.TimeUnit) and onError(long, java.util.concurrent.TimeUnit, java.lang.Throwable) events. Before communicating with the backend, the permission to do so must be obtained via the method tryAcquirePermission().

The state of the CircuitBreaker changes from CLOSED to OPEN when the failure rate is above a (configurable) threshold. Then, all access to the backend is rejected for a (configurable) time duration. No further calls are permitted.

After the time duration has elapsed, the CircuitBreaker state changes from OPEN to HALF_OPEN and allows a number of calls to see if the backend is still unavailable or has become available again. If the failure rate is above the configured threshold, the state changes back to OPEN. If the failure rate is below or equal to the threshold, the state changes back to CLOSED.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CircuitBreaker.CircuitBreakerFuture<T> This class decorates future to add CircuitBreaking functionality around invocation.
static interface	CircuitBreaker.EventPublisher An EventPublisher can be used to register event consumers.
static interface	CircuitBreaker.Metrics
static class	CircuitBreaker.State States of the CircuitBreaker state machine.
static class	CircuitBreaker.StateTransition State transitions of the CircuitBreaker state machine.

Method Summary

Modifier and Type	Method and Description
void	acquirePermission() Try to obtain a permission to execute a call.
default <T> java.util.concurrent.Callable<T>	decorateCallable(java.util.concurrent.Callable<T> callable) Returns a callable which is decorated by a CircuitBreaker.
static <T> java.util.concurrent.Callable<T>	decorateCallable(CircuitBreaker circuitBreaker, java.util.concurrent.Callable<T> callable) Returns a callable which is decorated by a CircuitBreaker.
default <T> io.vavr.CheckedConsumer<T>	decorateCheckedConsumer(io.vavr.CheckedConsumer<T> consumer) Returns a consumer which is decorated by a CircuitBreaker.
static <T> io.vavr.CheckedConsumer<T>	decorateCheckedConsumer(CircuitBreaker circuitBreaker, io.vavr.CheckedConsumer<T> consumer) Returns a consumer which is decorated by a CircuitBreaker.
static <T,R> io.vavr.CheckedFunction1<T,R>	decorateCheckedFunction(CircuitBreaker circuitBreaker, io.vavr.CheckedFunction1<T,R> function) Returns a function which is decorated by a CircuitBreaker.
default io.vavr.CheckedRunnable	decorateCheckedRunnable(io.vavr.CheckedRunnable runnable) Returns a runnable which is decorated by a CircuitBreaker.
static io.vavr.CheckedRunnable	decorateCheckedRunnable(CircuitBreaker circuitBreaker, io.vavr.CheckedRunnable runnable) Returns a runnable which is decorated by a CircuitBreaker.
default <T> io.vavr.CheckedFunction0<T>	decorateCheckedSupplier(io.vavr.CheckedFunction0<T> checkedSupplier) Returns a supplier which is decorated by a CircuitBreaker.
static <T> io.vavr.CheckedFunction0<T>	decorateCheckedSupplier(CircuitBreaker circuitBreaker, io.vavr.CheckedFunction0<T> supplier) Returns a supplier which is decorated by a CircuitBreaker.
static <T> java.util.function.Supplier<java.util.concurrent.CompletionStage<T>>	decorateCompletionStage(CircuitBreaker circuitBreaker, java.util.function.Supplier<java.util.concurrent.CompletionStage<T>> supplier) Returns a supplier which is decorated by a CircuitBreaker.
default <T> java.util.function.Supplier<java.util.concurrent.CompletionStage<T>>	decorateCompletionStage(java.util.function.Supplier<java.util.concurrent.CompletionStage<T>> supplier) Returns a supplier which is decorated by a CircuitBreaker.
static <T> java.util.function.Consumer<T>	decorateConsumer(CircuitBreaker circuitBreaker, java.util.function.Consumer<T> consumer) Returns a consumer which is decorated by a CircuitBreaker.
default <T> java.util.function.Consumer<T>	decorateConsumer(java.util.function.Consumer<T> consumer) Returns a consumer which is decorated by a CircuitBreaker.
static <T> java.util.function.Supplier<io.vavr.control.Either<java.lang.Exception,T>>	decorateEitherSupplier(CircuitBreaker circuitBreaker, java.util.function.Supplier<io.vavr.control.Either<? extends java.lang.Exception,T>> supplier) Returns a supplier which is decorated by a CircuitBreaker.
default <T> java.util.function.Supplier<io.vavr.control.Either<java.lang.Exception,T>>	decorateEitherSupplier(java.util.function.Supplier<io.vavr.control.Either<? extends java.lang.Exception,T>> supplier) Returns a supplier which is decorated by a CircuitBreaker.
static <T,R> java.util.function.Function<T,R>	decorateFunction(CircuitBreaker circuitBreaker, java.util.function.Function<T,R> function) Returns a function which is decorated by a CircuitBreaker.
static <T> java.util.function.Supplier<java.util.concurrent.Future<T>>	decorateFuture(CircuitBreaker circuitBreaker, java.util.function.Supplier<java.util.concurrent.Future<T>> supplier) Returns a supplier of type Future which is decorated by a CircuitBreaker.
default <T> java.util.function.Supplier<java.util.concurrent.Future<T>>	decorateFuture(java.util.function.Supplier<java.util.concurrent.Future<T>> supplier) Returns a supplier of type Future which is decorated by a CircuitBreaker.
static java.lang.Runnable	decorateRunnable(CircuitBreaker circuitBreaker, java.lang.Runnable runnable) Returns a runnable which is decorated by a CircuitBreaker.
default java.lang.Runnable	decorateRunnable(java.lang.Runnable runnable) Returns a runnable which is decorated by a CircuitBreaker.
static <T> java.util.function.Supplier<T>	decorateSupplier(CircuitBreaker circuitBreaker, java.util.function.Supplier<T> supplier) Returns a supplier which is decorated by a CircuitBreaker.
default <T> java.util.function.Supplier<T>	decorateSupplier(java.util.function.Supplier<T> supplier) Returns a supplier which is decorated by a CircuitBreaker.
static <T> java.util.function.Supplier<io.vavr.control.Try<T>>	decorateTrySupplier(CircuitBreaker circuitBreaker, java.util.function.Supplier<io.vavr.control.Try<T>> supplier) Returns a supplier which is decorated by a CircuitBreaker.
default <T> java.util.function.Supplier<io.vavr.control.Try<T>>	decorateTrySupplier(java.util.function.Supplier<io.vavr.control.Try<T>> supplier) Returns a supplier which is decorated by a CircuitBreaker.
default <T> T	executeCallable(java.util.concurrent.Callable<T> callable) Decorates and executes the decorated Callable.
default void	executeCheckedRunnable(io.vavr.CheckedRunnable runnable) Decorates and executes the decorated Runnable.
default <T> T	executeCheckedSupplier(io.vavr.CheckedFunction0<T> checkedSupplier) Decorates and executes the decorated Supplier.
default <T> java.util.concurrent.CompletionStage<T>	executeCompletionStage(java.util.function.Supplier<java.util.concurrent.CompletionStage<T>> supplier) Decorates and executes the decorated CompletionStage.
default <T> io.vavr.control.Either<java.lang.Exception,T>	executeEitherSupplier(java.util.function.Supplier<io.vavr.control.Either<? extends java.lang.Exception,T>> supplier) Decorates and executes the decorated Supplier.
default void	executeRunnable(java.lang.Runnable runnable) Decorates and executes the decorated Runnable.
default <T> T	executeSupplier(java.util.function.Supplier<T> supplier) Decorates and executes the decorated Supplier.
default <T> io.vavr.control.Try<T>	executeTrySupplier(java.util.function.Supplier<io.vavr.control.Try<T>> supplier) Decorates and executes the decorated Supplier.
CircuitBreakerConfig	getCircuitBreakerConfig() Returns the CircuitBreakerConfig of this CircuitBreaker.
CircuitBreaker.EventPublisher	getEventPublisher() Returns an EventPublisher which can be used to register event consumers.
CircuitBreaker.Metrics	getMetrics() Returns the Metrics of this CircuitBreaker.
java.lang.String	getName() Returns the name of this CircuitBreaker.
CircuitBreaker.State	getState() Returns the state of this CircuitBreaker.
io.vavr.collection.Map<java.lang.String,java.lang.String>	getTags() Returns an unmodifiable map with tags assigned to this Retry.
static CircuitBreaker	of(java.lang.String name, CircuitBreakerConfig circuitBreakerConfig) Creates a CircuitBreaker with a custom CircuitBreaker configuration.
static CircuitBreaker	of(java.lang.String name, CircuitBreakerConfig circuitBreakerConfig, io.vavr.collection.Map<java.lang.String,java.lang.String> tags) Creates a CircuitBreaker with a custom CircuitBreaker configuration.
static CircuitBreaker	of(java.lang.String name, java.util.function.Supplier<CircuitBreakerConfig> circuitBreakerConfigSupplier) Creates a CircuitBreaker with a custom CircuitBreaker configuration.
static CircuitBreaker	of(java.lang.String name, java.util.function.Supplier<CircuitBreakerConfig> circuitBreakerConfigSupplier, io.vavr.collection.Map<java.lang.String,java.lang.String> tags) Creates a CircuitBreaker with a custom CircuitBreaker configuration.
static CircuitBreaker	ofDefaults(java.lang.String name) Creates a CircuitBreaker with a default CircuitBreaker configuration.
void	onError(long duration, java.util.concurrent.TimeUnit durationUnit, java.lang.Throwable throwable) Records a failed call.
void	onSuccess(long duration, java.util.concurrent.TimeUnit durationUnit) Records a successful call.
void	releasePermission() Releases a permission.
void	reset() Returns the circuit breaker to its original closed state, losing statistics.
void	transitionToClosedState() Transitions the state machine to CLOSED state.
void	transitionToDisabledState() Transitions the state machine to a DISABLED state, stopping state transition, metrics and event publishing.
void	transitionToForcedOpenState() Transitions the state machine to a FORCED_OPEN state, stopping state transition, metrics and event publishing.
void	transitionToHalfOpenState() Transitions the state machine to HALF_OPEN state.
void	transitionToOpenState() Transitions the state machine to OPEN state.
boolean	tryAcquirePermission() Acquires a permission to execute a call, only if one is available at the time of invocation.

Method Detail

decorateCheckedSupplier

static <T> io.vavr.CheckedFunction0<T> decorateCheckedSupplier(CircuitBreaker circuitBreaker,
                                                               io.vavr.CheckedFunction0<T> supplier)

Returns a supplier which is decorated by a CircuitBreaker.

Type Parameters:

T - the type of results supplied by this supplier

Parameters:

circuitBreaker - the CircuitBreaker

supplier - the original supplier

Returns:

a supplier which is decorated by a CircuitBreaker.

decorateCompletionStage

static <T> java.util.function.Supplier<java.util.concurrent.CompletionStage<T>> decorateCompletionStage(CircuitBreaker circuitBreaker,
                                                                                                        java.util.function.Supplier<java.util.concurrent.CompletionStage<T>> supplier)

Returns a supplier which is decorated by a CircuitBreaker.

Type Parameters:

T - the type of the returned CompletionStage's result

Parameters:

circuitBreaker - the CircuitBreaker

supplier - the original supplier

Returns:

a supplier which is decorated by a CircuitBreaker.

decorateCheckedRunnable

static io.vavr.CheckedRunnable decorateCheckedRunnable(CircuitBreaker circuitBreaker,
                                                       io.vavr.CheckedRunnable runnable)

Returns a runnable which is decorated by a CircuitBreaker.

Parameters:

circuitBreaker - the CircuitBreaker

runnable - the original runnable

Returns:

a runnable which is decorated by a CircuitBreaker.

decorateCallable

static <T> java.util.concurrent.Callable<T> decorateCallable(CircuitBreaker circuitBreaker,
                                                             java.util.concurrent.Callable<T> callable)

Returns a callable which is decorated by a CircuitBreaker.

Type Parameters:

T - the result type of callable

Parameters:

circuitBreaker - the CircuitBreaker

callable - the original Callable

Returns:

a supplier which is decorated by a CircuitBreaker.

decorateSupplier

static <T> java.util.function.Supplier<T> decorateSupplier(CircuitBreaker circuitBreaker,
                                                           java.util.function.Supplier<T> supplier)

Returns a supplier which is decorated by a CircuitBreaker.

Type Parameters:

T - the type of results supplied by this supplier

Parameters:

circuitBreaker - the CircuitBreaker

supplier - the original supplier

Returns:

a supplier which is decorated by a CircuitBreaker.

decorateEitherSupplier

static <T> java.util.function.Supplier<io.vavr.control.Either<java.lang.Exception,T>> decorateEitherSupplier(CircuitBreaker circuitBreaker,
                                                                                                             java.util.function.Supplier<io.vavr.control.Either<? extends java.lang.Exception,T>> supplier)

Returns a supplier which is decorated by a CircuitBreaker.

Type Parameters:

T - the type of results supplied by this supplier

Parameters:

circuitBreaker - the CircuitBreaker

supplier - the original supplier

Returns:

a supplier which is decorated by a CircuitBreaker.

decorateTrySupplier

static <T> java.util.function.Supplier<io.vavr.control.Try<T>> decorateTrySupplier(CircuitBreaker circuitBreaker,
                                                                                   java.util.function.Supplier<io.vavr.control.Try<T>> supplier)

Returns a supplier which is decorated by a CircuitBreaker.

Type Parameters:

T - the type of results supplied by this supplier

Parameters:

circuitBreaker - the CircuitBreaker

supplier - the original function

Returns:

a retryable function

decorateConsumer

static <T> java.util.function.Consumer<T> decorateConsumer(CircuitBreaker circuitBreaker,
                                                           java.util.function.Consumer<T> consumer)

Returns a consumer which is decorated by a CircuitBreaker.

Type Parameters:

T - the type of the input to the consumer

Parameters:

circuitBreaker - the CircuitBreaker

consumer - the original consumer

Returns:

a consumer which is decorated by a CircuitBreaker.

decorateCheckedConsumer

static <T> io.vavr.CheckedConsumer<T> decorateCheckedConsumer(CircuitBreaker circuitBreaker,
                                                              io.vavr.CheckedConsumer<T> consumer)

Returns a consumer which is decorated by a CircuitBreaker.

Type Parameters:

T - the type of the input to the consumer

Parameters:

circuitBreaker - the CircuitBreaker

consumer - the original consumer

Returns:

a consumer which is decorated by a CircuitBreaker.

decorateRunnable

static java.lang.Runnable decorateRunnable(CircuitBreaker circuitBreaker,
                                           java.lang.Runnable runnable)

Returns a runnable which is decorated by a CircuitBreaker.

Parameters:

circuitBreaker - the CircuitBreaker

runnable - the original runnable

Returns:

a runnable which is decorated by a CircuitBreaker.

decorateFunction

static <T,R> java.util.function.Function<T,R> decorateFunction(CircuitBreaker circuitBreaker,
                                                               java.util.function.Function<T,R> function)

Returns a function which is decorated by a CircuitBreaker.

Type Parameters:

T - the type of the input to the function

R - the type of the result of the function

Parameters:

circuitBreaker - the CircuitBreaker

function - the original function

Returns:

a function which is decorated by a CircuitBreaker.

decorateCheckedFunction

static <T,R> io.vavr.CheckedFunction1<T,R> decorateCheckedFunction(CircuitBreaker circuitBreaker,
                                                                   io.vavr.CheckedFunction1<T,R> function)

Returns a function which is decorated by a CircuitBreaker.

Type Parameters:

T - the type of the input to the function

R - the type of the result of the function

Parameters:

circuitBreaker - the CircuitBreaker

function - the original function

Returns:

a function which is decorated by a CircuitBreaker.

ofDefaults

static CircuitBreaker ofDefaults(java.lang.String name)

Creates a CircuitBreaker with a default CircuitBreaker configuration.

Parameters:

name - the name of the CircuitBreaker

Returns:

a CircuitBreaker with a default CircuitBreaker configuration.

of

static CircuitBreaker of(java.lang.String name,
                         CircuitBreakerConfig circuitBreakerConfig)

Creates a CircuitBreaker with a custom CircuitBreaker configuration.

Parameters:

name - the name of the CircuitBreaker

circuitBreakerConfig - a custom CircuitBreaker configuration

Returns:

a CircuitBreaker with a custom CircuitBreaker configuration.

of

static CircuitBreaker of(java.lang.String name,
                         CircuitBreakerConfig circuitBreakerConfig,
                         io.vavr.collection.Map<java.lang.String,java.lang.String> tags)

Creates a CircuitBreaker with a custom CircuitBreaker configuration.

The tags passed will be appended to the tags already configured for the registry. When tags (keys) of the two collide the tags passed with this method will override the tags of the registry.

Parameters:

name - the name of the CircuitBreaker

circuitBreakerConfig - a custom CircuitBreaker configuration

tags - tags added to the Retry

Returns:

a CircuitBreaker with a custom CircuitBreaker configuration.

of

static CircuitBreaker of(java.lang.String name,
                         java.util.function.Supplier<CircuitBreakerConfig> circuitBreakerConfigSupplier)

Creates a CircuitBreaker with a custom CircuitBreaker configuration.

Parameters:

name - the name of the CircuitBreaker

circuitBreakerConfigSupplier - a supplier of a custom CircuitBreaker configuration

Returns:

a CircuitBreaker with a custom CircuitBreaker configuration.

of

static CircuitBreaker of(java.lang.String name,
                         java.util.function.Supplier<CircuitBreakerConfig> circuitBreakerConfigSupplier,
                         io.vavr.collection.Map<java.lang.String,java.lang.String> tags)

Creates a CircuitBreaker with a custom CircuitBreaker configuration.

The tags passed will be appended to the tags already configured for the registry. When tags (keys) of the two collide the tags passed with this method will override the tags of the registry.

Parameters:

name - the name of the CircuitBreaker

circuitBreakerConfigSupplier - a supplier of a custom CircuitBreaker configuration

tags - tags added to the CircuitBreaker

Returns:

a CircuitBreaker with a custom CircuitBreaker configuration.

decorateFuture

static <T> java.util.function.Supplier<java.util.concurrent.Future<T>> decorateFuture(CircuitBreaker circuitBreaker,
                                                                                      java.util.function.Supplier<java.util.concurrent.Future<T>> supplier)

Returns a supplier of type Future which is decorated by a CircuitBreaker. The elapsed time includes Future.get() evaluation time even if the underlying call took less time to return. Any delays in evaluating Future by caller will add towards total time.

Type Parameters:

T - the type of the returned Future's result

Parameters:

circuitBreaker - the CircuitBreaker

supplier - the original supplier

Returns:

a supplier which is decorated by a CircuitBreaker.

tryAcquirePermission

boolean tryAcquirePermission()

Acquires a permission to execute a call, only if one is available at the time of invocation. If a call is not permitted, the number of not permitted calls is increased.

Returns false when the state is OPEN or FORCED_OPEN. Returns true when the state is CLOSED or DISABLED. Returns true when the state is HALF_OPEN and further test calls are allowed. Returns false when the state is HALF_OPEN and the number of test calls has been reached. If the state is HALF_OPEN, the number of allowed test calls is decreased. Important: Make sure to call onSuccess or onError after the call is finished. If the call is cancelled before it is invoked, you have to release the permission again.

Returns:

true if a permission was acquired and false otherwise

releasePermission

void releasePermission()

Releases a permission.

Should only be used when a permission was acquired but not used. Otherwise use onSuccess(long, TimeUnit) or onError(long, TimeUnit, Throwable) to signal a completed or failed call.

If the state is HALF_OPEN, the number of allowed test calls is increased by one.

acquirePermission

void acquirePermission()

Try to obtain a permission to execute a call. If a call is not permitted, the number of not permitted calls is increased.

Throws a CallNotPermittedException when the state is OPEN or FORCED_OPEN. Returns when the state is CLOSED or DISABLED. Returns when the state is HALF_OPEN and further test calls are allowed. Throws a CallNotPermittedException when the state is HALF_OPEN and the number of test calls has been reached. If the state is HALF_OPEN, the number of allowed test calls is decreased. Important: Make sure to call onSuccess or onError after the call is finished. If the call is cancelled before it is invoked, you have to release the permission again.

Throws:

CallNotPermittedException - when CircuitBreaker is OPEN or HALF_OPEN and no further test calls are permitted.

onError

void onError(long duration,
             java.util.concurrent.TimeUnit durationUnit,
             java.lang.Throwable throwable)

Records a failed call. This method must be invoked when a call failed.

Parameters:

duration - The elapsed time duration of the call

durationUnit - The duration unit

throwable - The throwable which must be recorded

onSuccess

void onSuccess(long duration,
               java.util.concurrent.TimeUnit durationUnit)

Records a successful call.

Parameters:

duration - The elapsed time duration of the call

durationUnit - The duration unit This method must be invoked when a call was successful.

reset

void reset()

Returns the circuit breaker to its original closed state, losing statistics.

Should only be used, when you want to want to fully reset the circuit breaker without creating a new one.

transitionToClosedState

void transitionToClosedState()

Transitions the state machine to CLOSED state.

Should only be used, when you want to force a state transition. State transition are normally done internally.

transitionToOpenState

void transitionToOpenState()

Transitions the state machine to OPEN state.

Should only be used, when you want to force a state transition. State transition are normally done internally.

transitionToHalfOpenState

void transitionToHalfOpenState()

Transitions the state machine to HALF_OPEN state.

Should only be used, when you want to force a state transition. State transition are normally done internally.

transitionToDisabledState

void transitionToDisabledState()

Transitions the state machine to a DISABLED state, stopping state transition, metrics and event publishing.

Should only be used, when you want to disable the circuit breaker allowing all calls to pass. To recover from this state you must force a new state transition

transitionToForcedOpenState

void transitionToForcedOpenState()

Transitions the state machine to a FORCED_OPEN state, stopping state transition, metrics and event publishing.

Should only be used, when you want to disable the circuit breaker allowing no call to pass. To recover from this state you must force a new state transition

getName

java.lang.String getName()

Returns the name of this CircuitBreaker.

Returns:

the name of this CircuitBreaker

getState

CircuitBreaker.State getState()

Returns the state of this CircuitBreaker.

Returns:

the state of this CircuitBreaker

getCircuitBreakerConfig

CircuitBreakerConfig getCircuitBreakerConfig()

Returns the CircuitBreakerConfig of this CircuitBreaker.

Returns:

the CircuitBreakerConfig of this CircuitBreaker

getMetrics

CircuitBreaker.Metrics getMetrics()

Returns the Metrics of this CircuitBreaker.

Returns:

the Metrics of this CircuitBreaker

getTags

io.vavr.collection.Map<java.lang.String,java.lang.String> getTags()

Returns an unmodifiable map with tags assigned to this Retry.

Returns:

the tags assigned to this Retry in an unmodifiable map

getEventPublisher

CircuitBreaker.EventPublisher getEventPublisher()

Returns an EventPublisher which can be used to register event consumers.

Returns:

an EventPublisher

executeSupplier

default <T> T executeSupplier(java.util.function.Supplier<T> supplier)

Decorates and executes the decorated Supplier.

Type Parameters:

T - the type of results supplied by this supplier

Parameters:

supplier - the original Supplier

Returns:

the result of the decorated Supplier.

decorateSupplier

default <T> java.util.function.Supplier<T> decorateSupplier(java.util.function.Supplier<T> supplier)

Returns a supplier which is decorated by a CircuitBreaker.

Type Parameters:

T - the type of results supplied by this supplier

Parameters:

supplier - the original supplier

Returns:

a supplier which is decorated by a CircuitBreaker.

executeEitherSupplier

default <T> io.vavr.control.Either<java.lang.Exception,T> executeEitherSupplier(java.util.function.Supplier<io.vavr.control.Either<? extends java.lang.Exception,T>> supplier)

Decorates and executes the decorated Supplier.

Type Parameters:

T - the type of results supplied by this supplier

Parameters:

supplier - the original Supplier

Returns:

the result of the decorated Supplier.

decorateTrySupplier

default <T> java.util.function.Supplier<io.vavr.control.Try<T>> decorateTrySupplier(java.util.function.Supplier<io.vavr.control.Try<T>> supplier)

Returns a supplier which is decorated by a CircuitBreaker.

Type Parameters:

T - the type of results supplied by this supplier

Parameters:

supplier - the original supplier

Returns:

a supplier which is decorated by a CircuitBreaker.

executeTrySupplier

default <T> io.vavr.control.Try<T> executeTrySupplier(java.util.function.Supplier<io.vavr.control.Try<T>> supplier)

Decorates and executes the decorated Supplier.

Type Parameters:

T - the type of results supplied by this supplier

Parameters:

supplier - the original Supplier

Returns:

the result of the decorated Supplier.

decorateEitherSupplier

default <T> java.util.function.Supplier<io.vavr.control.Either<java.lang.Exception,T>> decorateEitherSupplier(java.util.function.Supplier<io.vavr.control.Either<? extends java.lang.Exception,T>> supplier)

Returns a supplier which is decorated by a CircuitBreaker.

Type Parameters:

T - the type of results supplied by this supplier

Parameters:

supplier - the original supplier

Returns:

a supplier which is decorated by a CircuitBreaker.

executeCallable

default <T> T executeCallable(java.util.concurrent.Callable<T> callable)
                       throws java.lang.Exception

Decorates and executes the decorated Callable.

Type Parameters:

T - the result type of callable

Parameters:

callable - the original Callable

Returns:

the result of the decorated Callable.

Throws:

java.lang.Exception - if unable to compute a result

decorateCallable

default <T> java.util.concurrent.Callable<T> decorateCallable(java.util.concurrent.Callable<T> callable)

Returns a callable which is decorated by a CircuitBreaker.

Type Parameters:

T - the result type of callable

Parameters:

callable - the original Callable

Returns:

a supplier which is decorated by a CircuitBreaker.

executeRunnable

default void executeRunnable(java.lang.Runnable runnable)

Decorates and executes the decorated Runnable.

Parameters:

runnable - the original Runnable

decorateRunnable

default java.lang.Runnable decorateRunnable(java.lang.Runnable runnable)

Returns a runnable which is decorated by a CircuitBreaker.

Parameters:

runnable - the original runnable

Returns:

a runnable which is decorated by a CircuitBreaker.

executeCompletionStage

default <T> java.util.concurrent.CompletionStage<T> executeCompletionStage(java.util.function.Supplier<java.util.concurrent.CompletionStage<T>> supplier)

Decorates and executes the decorated CompletionStage.

Type Parameters:

T - the type of results supplied by this supplier

Parameters:

supplier - the original CompletionStage

Returns:

the decorated CompletionStage.

decorateCompletionStage

default <T> java.util.function.Supplier<java.util.concurrent.CompletionStage<T>> decorateCompletionStage(java.util.function.Supplier<java.util.concurrent.CompletionStage<T>> supplier)

Returns a supplier which is decorated by a CircuitBreaker.

Type Parameters:

T - the type of the returned CompletionStage's result

Parameters:

supplier - the original supplier

Returns:

a supplier which is decorated by a CircuitBreaker.

executeCheckedSupplier

default <T> T executeCheckedSupplier(io.vavr.CheckedFunction0<T> checkedSupplier)
                              throws java.lang.Throwable

Decorates and executes the decorated Supplier.

Type Parameters:

T - the type of results supplied by this supplier

Parameters:

checkedSupplier - the original Supplier

Returns:

the result of the decorated Supplier.

Throws:

java.lang.Throwable - if something goes wrong applying this function to the given arguments

decorateCheckedSupplier

default <T> io.vavr.CheckedFunction0<T> decorateCheckedSupplier(io.vavr.CheckedFunction0<T> checkedSupplier)

Returns a supplier which is decorated by a CircuitBreaker.

Type Parameters:

T - the type of results supplied by this supplier

Parameters:

checkedSupplier - the original supplier

Returns:

a supplier which is decorated by a CircuitBreaker.

decorateCheckedRunnable

default io.vavr.CheckedRunnable decorateCheckedRunnable(io.vavr.CheckedRunnable runnable)

Returns a runnable which is decorated by a CircuitBreaker.

Parameters:

runnable - the original runnable

Returns:

a runnable which is decorated by a CircuitBreaker.

executeCheckedRunnable

default void executeCheckedRunnable(io.vavr.CheckedRunnable runnable)
                             throws java.lang.Throwable

Decorates and executes the decorated Runnable.

Parameters:

runnable - the original runnable

Throws:

java.lang.Throwable

decorateConsumer

default <T> java.util.function.Consumer<T> decorateConsumer(java.util.function.Consumer<T> consumer)

Returns a consumer which is decorated by a CircuitBreaker.

Type Parameters:

T - the type of the input to the consumer

Parameters:

consumer - the original consumer

Returns:

a consumer which is decorated by a CircuitBreaker.

decorateCheckedConsumer

default <T> io.vavr.CheckedConsumer<T> decorateCheckedConsumer(io.vavr.CheckedConsumer<T> consumer)

Returns a consumer which is decorated by a CircuitBreaker.

Type Parameters:

T - the type of the input to the consumer

Parameters:

consumer - the original consumer

Returns:

a consumer which is decorated by a CircuitBreaker.

decorateFuture

default <T> java.util.function.Supplier<java.util.concurrent.Future<T>> decorateFuture(java.util.function.Supplier<java.util.concurrent.Future<T>> supplier)

Returns a supplier of type Future which is decorated by a CircuitBreaker. The elapsed time includes Future.get() evaluation time even if the underlying call took less time to return. Any delays in evaluating Future by caller will add towards total time.

Type Parameters:

T - the type of the returned CompletionStage's result

Parameters:

supplier - the original supplier

Returns:

a supplier which is decorated by a CircuitBreaker.