CircuitBreaker (resilience4j-circuitbreaker 0.13.0 API)

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 three states: CLOSED, OPEN and HALF_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) and onError(long, java.lang.Throwable) events. Before communicating with the backend, the the permission to do so must be obtained via the method isCallPermitted(). 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 blocked for a (configurable) time duration. isCallPermitted() throws a CircuitBreakerOpenException, if the CircuitBreaker is OPEN. After the time duration has elapsed, the CircuitBreaker state changes from OPEN to HALF_OPEN and allows 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 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

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`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.
`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.
`static io.vavr.CheckedRunnable`	`decorateCheckedRunnable(CircuitBreaker circuitBreaker, io.vavr.CheckedRunnable runnable)` Returns a runnable 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.
`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.
`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 java.lang.Runnable`	`decorateRunnable(CircuitBreaker circuitBreaker, 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> T`	`executeCallable(java.util.concurrent.Callable<T> callable)` Decorates and executes the decorated Callable.
`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 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.
`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.
`boolean`	`isCallPermitted()` Requests permission to call this circuitBreaker's backend.
`static CircuitBreaker`	`of(java.lang.String name, CircuitBreakerConfig circuitBreakerConfig)` 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`	`ofDefaults(java.lang.String name)` Creates a CircuitBreaker with a default CircuitBreaker configuration.
`void`	`onError(long durationInNanos, java.lang.Throwable throwable)` Records a failed call.
`void`	`onSuccess(long durationInNanos)` Records a successful call.
`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.

- Method Detail
  - isCallPermitted
```
boolean isCallPermitted()
```
    Requests permission to call this circuitBreaker's backend.
    
    Returns:
    
    boolean whether a call should be permitted
  - onError
```
void onError(long durationInNanos,
             java.lang.Throwable throwable)
```
    Records a failed call. This method must be invoked when a call failed.
    
    Parameters:
    
    durationInNanos - The elapsed time duration of the call
    
    throwable - The throwable which must be recorded
  - onSuccess
```
void onSuccess(long durationInNanos)
```
    Records a successful call.
    
    Parameters:
    
    durationInNanos - The elapsed time duration of the call 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
  - 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.
  - 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
  - executeRunnable
```
default void executeRunnable(java.lang.Runnable runnable)
```
    Decorates and executes the decorated Runnable.
    
    Parameters:
    
    runnable - the original Runnable
  - 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.
  - 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.
  - 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,
                         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.

Interface CircuitBreaker

Nested Class Summary

Method Summary

Method Detail

isCallPermitted

onError

onSuccess

reset

transitionToClosedState

transitionToOpenState

transitionToHalfOpenState

transitionToDisabledState

transitionToForcedOpenState

getName

getState

getCircuitBreakerConfig

getMetrics

getEventPublisher

executeSupplier

executeCallable

executeRunnable

executeCompletionStage

decorateCheckedSupplier

decorateCompletionStage

decorateCheckedRunnable

decorateCallable

decorateSupplier

decorateConsumer

decorateCheckedConsumer

decorateRunnable

decorateFunction

decorateCheckedFunction

ofDefaults

of

of