Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- acquirePermission() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Try to obtain a permission to execute a call.
- acquirePermission() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
- addCircuitBreakerConfig(String, CircuitBreakerConfig) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.Builder
-
Configures a CircuitBreakerRegistry with a custom CircuitBreaker configuration.
- addRegistryEventConsumer(RegistryEventConsumer<CircuitBreaker>) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.Builder
-
Configures a CircuitBreakerRegistry with a CircuitBreaker registry event consumer.
- allowPublish - Variable in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.State
- automaticTransitionFromOpenToHalfOpenEnabled(boolean) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
-
Enables automatic transition from OPEN to HALF_OPEN state once the waitDurationInOpenState has passed.
B
- BUFFERED - Static variable in class io.github.resilience4j.circuitbreaker.utils.MetricNames
- build() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
-
Builds a CircuitBreakerConfig
- build() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.Builder
-
Builds a CircuitBreakerRegistry
- Builder() - Constructor for class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
- Builder() - Constructor for class io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.Builder
- Builder(CircuitBreakerConfig) - Constructor for class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
C
- CallNotPermittedException - Exception in io.github.resilience4j.circuitbreaker
-
A
CallNotPermittedException
signals that the CircuitBreaker is HALF_OPEN or OPEN and a call is not permitted to be executed. - cancel(boolean) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreaker.CircuitBreakerFuture
- circuitBreaker(String) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
-
Returns a managed
CircuitBreaker
or creates a new one with the default CircuitBreaker configuration. - circuitBreaker(String) - Method in class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
-
Returns a managed
CircuitBreaker
or creates a new one with the default CircuitBreaker configuration. - circuitBreaker(String, CircuitBreakerConfig) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
-
Returns a managed
CircuitBreaker
or creates a new one with a custom CircuitBreaker configuration. - circuitBreaker(String, CircuitBreakerConfig) - Method in class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
-
Returns a managed
CircuitBreaker
or creates a new one with a custom CircuitBreaker configuration. - circuitBreaker(String, CircuitBreakerConfig, Map<String, String>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
-
Returns a managed
CircuitBreaker
or creates a new one with a custom CircuitBreaker configuration. - circuitBreaker(String, CircuitBreakerConfig, Map<String, String>) - Method in class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
- circuitBreaker(String, String) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
-
Returns a managed
CircuitBreaker
or creates a new one. - circuitBreaker(String, String) - Method in class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
-
Returns a managed
CircuitBreaker
or creates a new one. - circuitBreaker(String, String, Map<String, String>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
-
Returns a managed
CircuitBreaker
or creates a new one. - circuitBreaker(String, String, Map<String, String>) - Method in class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
- circuitBreaker(String, Supplier<CircuitBreakerConfig>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
-
Returns a managed
CircuitBreaker
or creates a new one with a custom CircuitBreaker configuration. - circuitBreaker(String, Supplier<CircuitBreakerConfig>) - Method in class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
-
Returns a managed
CircuitBreaker
or creates a new one with a custom CircuitBreaker configuration. - circuitBreaker(String, Supplier<CircuitBreakerConfig>, Map<String, String>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
-
Returns a managed
CircuitBreaker
or creates a new one with a custom CircuitBreaker configuration. - circuitBreaker(String, Supplier<CircuitBreakerConfig>, Map<String, String>) - Method in class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
- circuitBreaker(String, Map<String, String>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
-
Returns a managed
CircuitBreaker
or creates a new one with the default CircuitBreaker configuration. - circuitBreaker(String, Map<String, String>) - Method in class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
- CircuitBreaker - Interface in io.github.resilience4j.circuitbreaker
-
A CircuitBreaker instance is thread-safe can be used to decorate multiple requests.
- CircuitBreaker.CircuitBreakerFuture<T> - Class in io.github.resilience4j.circuitbreaker
-
This class decorates future to add CircuitBreaking functionality around invocation.
- CircuitBreaker.EventPublisher - Interface in io.github.resilience4j.circuitbreaker
-
An EventPublisher can be used to register event consumers.
- CircuitBreaker.Metrics - Interface in io.github.resilience4j.circuitbreaker
- CircuitBreaker.State - Enum Class in io.github.resilience4j.circuitbreaker
-
States of the CircuitBreaker state machine.
- CircuitBreaker.StateTransition - Enum Class in io.github.resilience4j.circuitbreaker
-
State transitions of the CircuitBreaker state machine.
- CircuitBreakerConfig - Class in io.github.resilience4j.circuitbreaker
-
A
CircuitBreakerConfig
configures aCircuitBreaker
- CircuitBreakerConfig.Builder - Class in io.github.resilience4j.circuitbreaker
- CircuitBreakerConfig.SlidingWindowType - Enum Class in io.github.resilience4j.circuitbreaker
- CircuitBreakerConfig.TransitionCheckResult - Class in io.github.resilience4j.circuitbreaker
-
Result of the
CircuitBreakerConfig.getTransitionOnResult()
function with which one can tell the circuit breaker to transition to a different state if the result of a call meet the desired criteria. - CircuitBreakerEvent - Interface in io.github.resilience4j.circuitbreaker.event
-
An event which is created by a CircuitBreaker.
- CircuitBreakerEvent.Type - Enum Class in io.github.resilience4j.circuitbreaker.event
-
Event types which are created by a CircuitBreaker.
- CircuitBreakerOnCallNotPermittedEvent - Class in io.github.resilience4j.circuitbreaker.event
-
A CircuitBreakerEvent which informs that a call was not permitted, because the CircuitBreaker is OPEN.
- CircuitBreakerOnCallNotPermittedEvent(String) - Constructor for class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnCallNotPermittedEvent
- CircuitBreakerOnErrorEvent - Class in io.github.resilience4j.circuitbreaker.event
-
A CircuitBreakerEvent which informs that an error has been recorded
- CircuitBreakerOnErrorEvent(String, Duration, Throwable) - Constructor for class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnErrorEvent
- CircuitBreakerOnFailureRateExceededEvent - Class in io.github.resilience4j.circuitbreaker.event
- CircuitBreakerOnFailureRateExceededEvent(String, float) - Constructor for class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnFailureRateExceededEvent
- CircuitBreakerOnIgnoredErrorEvent - Class in io.github.resilience4j.circuitbreaker.event
-
A CircuitBreakerEvent which informs that an error has been ignored
- CircuitBreakerOnIgnoredErrorEvent(String, Duration, Throwable) - Constructor for class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnIgnoredErrorEvent
- CircuitBreakerOnResetEvent - Class in io.github.resilience4j.circuitbreaker.event
-
A CircuitBreakerEvent which informs about a reset.
- CircuitBreakerOnResetEvent(String) - Constructor for class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnResetEvent
- CircuitBreakerOnSlowCallRateExceededEvent - Class in io.github.resilience4j.circuitbreaker.event
- CircuitBreakerOnSlowCallRateExceededEvent(String, float) - Constructor for class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnSlowCallRateExceededEvent
- CircuitBreakerOnStateTransitionEvent - Class in io.github.resilience4j.circuitbreaker.event
-
A CircuitBreakerEvent which informs about a state transition.
- CircuitBreakerOnStateTransitionEvent(String, CircuitBreaker.StateTransition) - Constructor for class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnStateTransitionEvent
- CircuitBreakerOnSuccessEvent - Class in io.github.resilience4j.circuitbreaker.event
-
A CircuitBreakerEvent which informs that a success has been recorded
- CircuitBreakerOnSuccessEvent(String, Duration) - Constructor for class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnSuccessEvent
- CircuitBreakerRegistry - Interface in io.github.resilience4j.circuitbreaker
-
The
CircuitBreakerRegistry
is a factory to create CircuitBreaker instances which stores all CircuitBreaker instances in a registry. - CircuitBreakerRegistry.Builder - Class in io.github.resilience4j.circuitbreaker
- CircuitBreakerResultUtils - Class in io.github.resilience4j.circuitbreaker.utils
- CircuitBreakerResultUtils.TransitionCheckThrowableBuilder<T extends Throwable> - Class in io.github.resilience4j.circuitbreaker.utils
- CircuitBreakerStateMachine - Class in io.github.resilience4j.circuitbreaker.internal
-
A CircuitBreaker finite state machine.
- CircuitBreakerStateMachine(String) - Constructor for class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
-
Creates a circuitBreaker with default config.
- CircuitBreakerStateMachine(String, CircuitBreakerConfig) - Constructor for class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
-
Creates a circuitBreaker.
- CircuitBreakerStateMachine(String, CircuitBreakerConfig, SchedulerFactory) - Constructor for class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
-
Creates a circuitBreaker.
- CircuitBreakerStateMachine(String, CircuitBreakerConfig, Clock) - Constructor for class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
-
Creates a circuitBreaker.
- CircuitBreakerStateMachine(String, CircuitBreakerConfig, Clock, Map<String, String>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
-
Creates a circuitBreaker.
- CircuitBreakerStateMachine(String, CircuitBreakerConfig, Map<String, String>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
-
Creates a circuitBreaker.
- CircuitBreakerStateMachine(String, Supplier<CircuitBreakerConfig>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
-
Creates a circuitBreaker.
- CircuitBreakerStateMachine(String, Supplier<CircuitBreakerConfig>, Map<String, String>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
-
Creates a circuitBreaker.
- CircuitBreakerUtil - Class in io.github.resilience4j.circuitbreaker.utils
- CLOSED - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.State
-
A CLOSED breaker is operating normally and allowing requests through.
- CLOSED_TO_CLOSED - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- CLOSED_TO_DISABLED - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- CLOSED_TO_FORCED_OPEN - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- CLOSED_TO_METRICS_ONLY - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- CLOSED_TO_OPEN - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- COUNT_BASED - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.SlidingWindowType
- createCallNotPermittedException(CircuitBreaker) - Static method in exception io.github.resilience4j.circuitbreaker.CallNotPermittedException
-
Static method to construct a
CallNotPermittedException
with a CircuitBreaker. - currentTimestampFunction(Function<Clock, Long>, TimeUnit) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
-
Configures a function that returns current timestamp for CircuitBreaker.
- custom() - Static method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
-
Returns a builder to create a custom CircuitBreakerConfig.
- custom() - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
-
Returns a builder to create a custom CircuitBreakerRegistry.
D
- decorateCallable(CircuitBreaker, Callable<T>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns a callable which is decorated by a CircuitBreaker.
- decorateCallable(Callable<T>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns a callable which is decorated by a CircuitBreaker.
- decorateCheckedConsumer(CircuitBreaker, CheckedConsumer<T>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns a consumer which is decorated by a CircuitBreaker.
- decorateCheckedConsumer(CheckedConsumer<T>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns a consumer which is decorated by a CircuitBreaker.
- decorateCheckedFunction(CircuitBreaker, CheckedFunction<T, R>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns a function which is decorated by a CircuitBreaker.
- decorateCheckedRunnable(CircuitBreaker, CheckedRunnable) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns a runnable which is decorated by a CircuitBreaker.
- decorateCheckedRunnable(CheckedRunnable) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns a runnable which is decorated by a CircuitBreaker.
- decorateCheckedSupplier(CircuitBreaker, CheckedSupplier<T>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns a supplier which is decorated by a CircuitBreaker.
- decorateCheckedSupplier(CheckedSupplier<T>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns a supplier which is decorated by a CircuitBreaker.
- decorateCompletionStage(CircuitBreaker, Supplier<CompletionStage<T>>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns a supplier which is decorated by a CircuitBreaker.
- decorateCompletionStage(Supplier<CompletionStage<T>>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns a supplier which is decorated by a CircuitBreaker.
- decorateConsumer(CircuitBreaker, Consumer<T>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns a consumer which is decorated by a CircuitBreaker.
- decorateConsumer(Consumer<T>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns a consumer which is decorated by a CircuitBreaker.
- decorateFunction(CircuitBreaker, Function<T, R>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns a function which is decorated by a CircuitBreaker.
- decorateFuture(CircuitBreaker, Supplier<Future<T>>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns a supplier of type Future which is decorated by a CircuitBreaker.
- decorateFuture(Supplier<Future<T>>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns a supplier of type Future which is decorated by a CircuitBreaker.
- decorateRunnable(CircuitBreaker, Runnable) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns a runnable which is decorated by a CircuitBreaker.
- decorateRunnable(Runnable) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns a runnable which is decorated by a CircuitBreaker.
- decorateSupplier(CircuitBreaker, Supplier<T>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns a supplier which is decorated by a CircuitBreaker.
- decorateSupplier(Supplier<T>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns a supplier which is decorated by a CircuitBreaker.
- DEFAULT_FAILURE_RATE_THRESHOLD - Static variable in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- DEFAULT_MINIMUM_NUMBER_OF_CALLS - Static variable in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- DEFAULT_PERMITTED_CALLS_IN_HALF_OPEN_STATE - Static variable in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- DEFAULT_PREFIX - Static variable in class io.github.resilience4j.circuitbreaker.utils.MetricNames
- DEFAULT_SLIDING_WINDOW_SIZE - Static variable in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- DEFAULT_SLIDING_WINDOW_TYPE - Static variable in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- DEFAULT_SLOW_CALL_DURATION_THRESHOLD - Static variable in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- DEFAULT_SLOW_CALL_RATE_THRESHOLD - Static variable in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- DEFAULT_WAIT_DURATION_IN_HALF_OPEN_STATE - Static variable in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- DEFAULT_WAIT_DURATION_IN_OPEN_STATE - Static variable in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- DEFAULT_WRITABLE_STACK_TRACE_ENABLED - Static variable in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- DISABLED - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.State
-
A DISABLED breaker is not operating (no state transition, no events) and allowing all requests through.
- DISABLED - Enum constant in enum class io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent.Type
-
A CircuitBreakerEvent which informs the CircuitBreaker has been disabled
- DISABLED_TO_CLOSED - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- DISABLED_TO_DISABLED - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- DISABLED_TO_FORCED_OPEN - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- DISABLED_TO_HALF_OPEN - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- DISABLED_TO_METRICS_ONLY - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- DISABLED_TO_OPEN - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
E
- enableAutomaticTransitionFromOpenToHalfOpen() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
-
Enables automatic transition from OPEN to HALF_OPEN state once the waitDurationInOpenState has passed.
- ERROR - Enum constant in enum class io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent.Type
-
A CircuitBreakerEvent which informs that an error has been recorded
- executeCallable(Callable<T>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Decorates and executes the decorated Callable.
- executeCheckedRunnable(CheckedRunnable) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Decorates and executes the decorated Runnable.
- executeCheckedSupplier(CheckedSupplier<T>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Decorates and executes the decorated Supplier.
- executeCompletionStage(Supplier<CompletionStage<T>>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Decorates and executes the decorated CompletionStage.
- executeRunnable(Runnable) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Decorates and executes the decorated Runnable.
- executeSupplier(Supplier<T>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Decorates and executes the decorated Supplier.
F
- FAILED - Static variable in class io.github.resilience4j.circuitbreaker.utils.MetricNames
- FAILURE_RATE - Static variable in class io.github.resilience4j.circuitbreaker.utils.MetricNames
- FAILURE_RATE_EXCEEDED - Enum constant in enum class io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent.Type
-
A CircuitBreakerEvent which informs the CircuitBreaker failure rate has been breached
- failureRateThreshold(float) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
-
Configures the failure rate threshold in percentage.
- FORCED_OPEN - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.State
-
A FORCED_OPEN breaker is not operating (no state transition, no events) and not allowing any requests through.
- FORCED_OPEN - Enum constant in enum class io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent.Type
-
A CircuitBreakerEvent which informs the CircuitBreaker has been forced open
- FORCED_OPEN_TO_CLOSED - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- FORCED_OPEN_TO_DISABLED - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- FORCED_OPEN_TO_FORCED_OPEN - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- FORCED_OPEN_TO_HALF_OPEN - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- FORCED_OPEN_TO_METRICS_ONLY - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- FORCED_OPEN_TO_OPEN - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- forcePublish - Variable in enum class io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent.Type
- from(CircuitBreakerConfig) - Static method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
-
Returns a builder to create a custom CircuitBreakerConfig based on another CircuitBreakerConfig.
G
- get() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreaker.CircuitBreakerFuture
- get(long, TimeUnit) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreaker.CircuitBreakerFuture
- getAllCircuitBreakers() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
-
Returns all managed
CircuitBreaker
instances. - getAllCircuitBreakers() - Method in class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
-
Returns all managed
CircuitBreaker
instances. - getCausingCircuitBreakerName() - Method in exception io.github.resilience4j.circuitbreaker.CallNotPermittedException
-
Returns the name of
CircuitBreaker
that caused this exception. - getCircuitBreakerConfig() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns the CircuitBreakerConfig of this CircuitBreaker.
- getCircuitBreakerConfig() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
-
Get the config of this CircuitBreaker.
- getCircuitBreakerName() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnCallNotPermittedEvent
- getCircuitBreakerName() - Method in interface io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent
-
Returns the name of the CircuitBreaker which has created the event.
- getCircuitBreakerName() - Method in exception io.github.resilience4j.circuitbreaker.ResultRecordedAsFailureException
- getCreationTime() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnCallNotPermittedEvent
- getCreationTime() - Method in interface io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent
-
Returns the creation time of CircuitBreaker event.
- getCurrentTimestamp() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns the current time with respect to the CircuitBreaker currentTimeFunction.
- getCurrentTimestamp() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
- getCurrentTimestampFunction() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- getElapsedDuration() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnErrorEvent
- getElapsedDuration() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnIgnoredErrorEvent
- getElapsedDuration() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnSuccessEvent
- getEventPublisher() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns an EventPublisher which can be used to register event consumers.
- getEventPublisher() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
- getEventType() - Method in interface io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent
-
Returns the type of the CircuitBreaker event.
- getEventType() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnCallNotPermittedEvent
- getEventType() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnErrorEvent
- getEventType() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnFailureRateExceededEvent
- getEventType() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnIgnoredErrorEvent
- getEventType() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnResetEvent
- getEventType() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnSlowCallRateExceededEvent
- getEventType() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnStateTransitionEvent
- getEventType() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnSuccessEvent
- getFailureRate() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics
-
Returns the current failure rate in percentage.
- getFailureRate() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnFailureRateExceededEvent
- getFailureRateThreshold() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- getFromState() - Method in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- getFromState() - Method in exception io.github.resilience4j.circuitbreaker.IllegalStateTransitionException
- getIgnoreExceptionPredicate() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- getInstance() - Static method in class io.github.resilience4j.circuitbreaker.internal.SchedulerFactory
- getMaxWaitDurationInHalfOpenState() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- getMetrics() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns the Metrics of this CircuitBreaker.
- getMetrics() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
- getMinimumNumberOfCalls() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- getName() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns the name of this CircuitBreaker.
- getName() - Method in exception io.github.resilience4j.circuitbreaker.IllegalStateTransitionException
- getName() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
-
Get the name of this CircuitBreaker.
- getNumberOfBufferedCalls() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics
-
Returns the current total number of buffered calls in the ring buffer.
- getNumberOfFailedCalls() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics
-
Returns the current number of failed buffered calls in the ring buffer.
- getNumberOfNotPermittedCalls() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics
-
Returns the current number of not permitted calls, when the state is OPEN.
- getNumberOfSlowCalls() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics
-
Returns the current total number of calls which were slower than a certain threshold.
- getNumberOfSlowFailedCalls() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics
-
Returns the current number of failed calls which were slower than a certain threshold.
- getNumberOfSlowSuccessfulCalls() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics
-
Returns the current number of successful calls which were slower than a certain threshold.
- getNumberOfSuccessfulCalls() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics
-
Returns the current number of successful buffered calls in the ring buffer.
- getOrder() - Method in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.State
- getPermittedNumberOfCallsInHalfOpenState() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- getRecordExceptionPredicate() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- getRecordResultPredicate() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- getResult() - Method in exception io.github.resilience4j.circuitbreaker.ResultRecordedAsFailureException
- getScheduler() - Method in class io.github.resilience4j.circuitbreaker.internal.SchedulerFactory
- getSlidingWindowSize() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- getSlidingWindowType() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- getSlowCallDurationThreshold() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- getSlowCallRate() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics
-
Returns the current percentage of calls which were slower than a certain threshold.
- getSlowCallRate() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnSlowCallRateExceededEvent
- getSlowCallRateThreshold() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- getState() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns the state of this CircuitBreaker.
- getState() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
-
Get the state of this CircuitBreaker.
- getStateTransition() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnStateTransitionEvent
- getTags() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns an unmodifiable map with tags assigned to this Retry.
- getTags() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
- getThrowable() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnErrorEvent
- getThrowable() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnIgnoredErrorEvent
- getTimestampUnit() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns the timeUnit of current timestamp.
- getTimestampUnit() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- getTimestampUnit() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
- getToState() - Method in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- getToState() - Method in exception io.github.resilience4j.circuitbreaker.IllegalStateTransitionException
- getTransitionOnResult() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- getWaitDuration() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.TransitionCheckResult
- getWaitIntervalFunctionInOpenState() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
-
Returns an interval function which controls how long the CircuitBreaker should stay open, before it switches to half open.
- getWaitUntil() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.TransitionCheckResult
H
- HALF_OPEN - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.State
-
A HALF_OPEN breaker has completed its wait interval and will allow requests
- HALF_OPEN_TO_CLOSED - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- HALF_OPEN_TO_DISABLED - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- HALF_OPEN_TO_FORCED_OPEN - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- HALF_OPEN_TO_HALF_OPEN - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- HALF_OPEN_TO_METRICS_ONLY - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- HALF_OPEN_TO_OPEN - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
I
- ifFailedWith(Class<T>) - Static method in class io.github.resilience4j.circuitbreaker.utils.CircuitBreakerResultUtils
- IGNORED_ERROR - Enum constant in enum class io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent.Type
-
A CircuitBreakerEvent which informs that an error has been ignored
- ignoreException(Predicate<Throwable>) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
-
Configures a Predicate which evaluates if an exception should be ignored and neither count as a failure nor success.
- ignoreExceptions(Class<? extends Throwable>...) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
-
Configures a list of error classes that are ignored and thus neither count as a failure nor success.
- IllegalStateTransitionException - Exception in io.github.resilience4j.circuitbreaker
-
A
IllegalStateTransitionException
signals that someone tried to trigger an illegal state transition.. - InMemoryCircuitBreakerRegistry - Class in io.github.resilience4j.circuitbreaker.internal
-
Backend circuitBreaker manager.
- InMemoryCircuitBreakerRegistry() - Constructor for class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
-
The constructor with default default.
- InMemoryCircuitBreakerRegistry(CircuitBreakerConfig) - Constructor for class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
-
The constructor with custom default config.
- InMemoryCircuitBreakerRegistry(CircuitBreakerConfig, RegistryEventConsumer<CircuitBreaker>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
- InMemoryCircuitBreakerRegistry(CircuitBreakerConfig, RegistryEventConsumer<CircuitBreaker>, Map<String, String>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
- InMemoryCircuitBreakerRegistry(CircuitBreakerConfig, List<RegistryEventConsumer<CircuitBreaker>>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
- InMemoryCircuitBreakerRegistry(CircuitBreakerConfig, Map<String, String>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
-
The constructor with custom default config.
- InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
- InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig>, RegistryEventConsumer<CircuitBreaker>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
- InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig>, RegistryEventConsumer<CircuitBreaker>, Map<String, String>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
- InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig>, List<RegistryEventConsumer<CircuitBreaker>>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
- InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig>, List<RegistryEventConsumer<CircuitBreaker>>, Map<String, String>, RegistryStore<CircuitBreaker>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
- InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig>, Map<String, String>) - Constructor for class io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry
- io.github.resilience4j.circuitbreaker - package io.github.resilience4j.circuitbreaker
- io.github.resilience4j.circuitbreaker.event - package io.github.resilience4j.circuitbreaker.event
- io.github.resilience4j.circuitbreaker.internal - package io.github.resilience4j.circuitbreaker.internal
- io.github.resilience4j.circuitbreaker.utils - package io.github.resilience4j.circuitbreaker.utils
- isAutomaticTransitionFromOpenToHalfOpenEnabled() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- isCallPermitted(CircuitBreaker) - Static method in class io.github.resilience4j.circuitbreaker.utils.CircuitBreakerUtil
-
Indicates whether Circuit Breaker allows any calls or not.
- isCancelled() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreaker.CircuitBreakerFuture
- isDone() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreaker.CircuitBreakerFuture
- isFailedWith(Either<Object, Throwable>, Class<? extends Throwable>) - Static method in class io.github.resilience4j.circuitbreaker.utils.CircuitBreakerResultUtils
- isInternalTransition(CircuitBreaker.StateTransition) - Static method in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- isTransitionToOpen() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.TransitionCheckResult
- isWritableStackTraceEnabled() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
M
- maxWaitDurationInHalfOpenState(Duration) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
-
Configures CircuitBreaker with a fixed wait duration which controls how long the CircuitBreaker should stay in Half Open state, before it switches to open.
- MetricNames - Class in io.github.resilience4j.circuitbreaker.utils
- METRICS_ONLY - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.State
-
A METRICS_ONLY breaker is collecting metrics, publishing events and allowing all requests through but is not transitioning to other states.
- METRICS_ONLY_TO_CLOSED - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- METRICS_ONLY_TO_DISABLED - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- METRICS_ONLY_TO_FORCED_OPEN - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- METRICS_ONLY_TO_METRICS_ONLY - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- minimumNumberOfCalls(int) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
-
Configures the minimum number of calls which are required (per sliding window period) before the CircuitBreaker can calculate the error rate.
N
- NOT_PERMITTED - Enum constant in enum class io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent.Type
-
A CircuitBreakerEvent which informs that a call was not permitted because the CircuitBreaker state is OPEN
- NOT_PERMITTED - Static variable in class io.github.resilience4j.circuitbreaker.utils.MetricNames
- noTransition() - Static method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.TransitionCheckResult
-
Return this result if you do not want any transition to happen.
O
- of(CircuitBreakerConfig) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
-
Creates a CircuitBreakerRegistry with a custom default CircuitBreaker configuration.
- of(CircuitBreakerConfig, RegistryEventConsumer<CircuitBreaker>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
-
Creates a CircuitBreakerRegistry with a custom default CircuitBreaker configuration and a CircuitBreaker registry event consumer.
- of(CircuitBreakerConfig, List<RegistryEventConsumer<CircuitBreaker>>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
-
Creates a CircuitBreakerRegistry with a custom default CircuitBreaker configuration and a list of CircuitBreaker registry event consumers.
- of(String, CircuitBreakerConfig) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Creates a CircuitBreaker with a custom CircuitBreaker configuration.
- of(String, CircuitBreakerConfig, Map<String, String>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Creates a CircuitBreaker with a custom CircuitBreaker configuration.
- of(String, Supplier<CircuitBreakerConfig>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Creates a CircuitBreaker with a custom CircuitBreaker configuration.
- of(String, Supplier<CircuitBreakerConfig>, Map<String, String>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Creates a CircuitBreaker with a custom CircuitBreaker configuration.
- of(Map<String, CircuitBreakerConfig>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
-
Creates a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations.
- of(Map<String, CircuitBreakerConfig>, RegistryEventConsumer<CircuitBreaker>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
-
Creates a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations and a CircuitBreaker registry event consumer.
- of(Map<String, CircuitBreakerConfig>, RegistryEventConsumer<CircuitBreaker>, Map<String, String>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
-
Creates a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations and a CircuitBreaker registry event consumer.
- of(Map<String, CircuitBreakerConfig>, List<RegistryEventConsumer<CircuitBreaker>>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
-
Creates a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations and a list of CircuitBreaker registry event consumers.
- of(Map<String, CircuitBreakerConfig>, Map<String, String>) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
-
Creates a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations.
- ofDefaults() - Static method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
-
Creates a default CircuitBreaker configuration.
- ofDefaults() - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
-
Creates a CircuitBreakerRegistry with a default CircuitBreaker configuration.
- ofDefaults(String) - Static method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Creates a CircuitBreaker with a default CircuitBreaker configuration.
- onCallNotPermitted(EventConsumer<CircuitBreakerOnCallNotPermittedEvent>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.EventPublisher
- onError(long, TimeUnit, Throwable) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Records a failed call.
- onError(long, TimeUnit, Throwable) - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
- onError(EventConsumer<CircuitBreakerOnErrorEvent>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.EventPublisher
- onFailureRateExceeded(EventConsumer<CircuitBreakerOnFailureRateExceededEvent>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.EventPublisher
- onIgnoredError(EventConsumer<CircuitBreakerOnIgnoredErrorEvent>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.EventPublisher
- onReset(EventConsumer<CircuitBreakerOnResetEvent>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.EventPublisher
- onResult(long, TimeUnit, Object) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
This method must be invoked when a call returned a result and the result predicate should decide if the call was successful or not.
- onResult(long, TimeUnit, Object) - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
- onSlowCallRateExceeded(EventConsumer<CircuitBreakerOnSlowCallRateExceededEvent>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.EventPublisher
- onStateTransition(EventConsumer<CircuitBreakerOnStateTransitionEvent>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.EventPublisher
- onSuccess(long, TimeUnit) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Records a successful call.
- onSuccess(long, TimeUnit) - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
- onSuccess(EventConsumer<CircuitBreakerOnSuccessEvent>) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker.EventPublisher
- OPEN - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.State
-
An OPEN breaker has tripped and will not allow requests through.
- OPEN_TO_CLOSED - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- OPEN_TO_DISABLED - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- OPEN_TO_FORCED_OPEN - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- OPEN_TO_HALF_OPEN - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- OPEN_TO_METRICS_ONLY - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- OPEN_TO_OPEN - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
P
- permittedNumberOfCallsInHalfOpenState(int) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
-
Configures the number of permitted calls when the CircuitBreaker is half open.
R
- recordException(Predicate<Throwable>) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
-
Configures a Predicate which evaluates if an exception should be recorded as a failure and thus increase the failure rate.
- recordExceptions(Class<? extends Throwable>...) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
-
Configures a list of error classes that are recorded as a failure and thus increase the failure rate.
- recordResult(Predicate<Object>) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
-
Configures a Predicate which evaluates if the result of the protected function call should be recorded as a failure and thus increase the failure rate.
- releasePermission() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Releases a permission.
- releasePermission() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
- reset() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Returns the circuit breaker to its original closed state, losing statistics.
- reset() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
- RESET - Enum constant in enum class io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent.Type
-
A CircuitBreakerEvent which informs the CircuitBreaker has been reset
- ResultRecordedAsFailureException - Exception in io.github.resilience4j.circuitbreaker
-
A
ResultRecordedAsFailureException
signals that a result has been recorded as a circuit breaker failure. - ResultRecordedAsFailureException(String, Object) - Constructor for exception io.github.resilience4j.circuitbreaker.ResultRecordedAsFailureException
S
- SchedulerFactory - Class in io.github.resilience4j.circuitbreaker.internal
- slidingWindow(int, int, CircuitBreakerConfig.SlidingWindowType) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
-
Configures the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed.
- slidingWindowSize(int) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
-
Configures the size of the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed.
- slidingWindowType(CircuitBreakerConfig.SlidingWindowType) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
-
Configures the type of the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed.
- SLOW - Static variable in class io.github.resilience4j.circuitbreaker.utils.MetricNames
- SLOW_CALL_RATE - Static variable in class io.github.resilience4j.circuitbreaker.utils.MetricNames
- SLOW_CALL_RATE_EXCEEDED - Enum constant in enum class io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent.Type
-
A CircuitBreakerEvent which informs the CircuitBreaker show call rate has been breached
- SLOW_FAILED - Static variable in class io.github.resilience4j.circuitbreaker.utils.MetricNames
- SLOW_SUCCESS - Static variable in class io.github.resilience4j.circuitbreaker.utils.MetricNames
- slowCallDurationThreshold(Duration) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
-
Configures the duration threshold above which calls are considered as slow and increase the slow calls percentage.
- slowCallRateThreshold(float) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
-
Configures a threshold in percentage.
- STATE - Static variable in class io.github.resilience4j.circuitbreaker.utils.MetricNames
- STATE_TRANSITION - Enum constant in enum class io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent.Type
-
A CircuitBreakerEvent which informs the state of the CircuitBreaker has been changed
- SUCCESS - Enum constant in enum class io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent.Type
-
A CircuitBreakerEvent which informs that a success has been recorded
- SUCCESSFUL - Static variable in class io.github.resilience4j.circuitbreaker.utils.MetricNames
T
- thenOpen() - Method in class io.github.resilience4j.circuitbreaker.utils.CircuitBreakerResultUtils.TransitionCheckThrowableBuilder
- thenOpenFor(Function<T, Duration>) - Method in class io.github.resilience4j.circuitbreaker.utils.CircuitBreakerResultUtils.TransitionCheckThrowableBuilder
- thenOpenUntil(Function<T, Instant>) - Method in class io.github.resilience4j.circuitbreaker.utils.CircuitBreakerResultUtils.TransitionCheckThrowableBuilder
- TIME_BASED - Enum constant in enum class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.SlidingWindowType
- toString() - Method in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- toString() - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig
- toString() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnCallNotPermittedEvent
- toString() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnErrorEvent
- toString() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnFailureRateExceededEvent
- toString() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnIgnoredErrorEvent
- toString() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnResetEvent
- toString() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnSlowCallRateExceededEvent
- toString() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnStateTransitionEvent
- toString() - Method in class io.github.resilience4j.circuitbreaker.event.CircuitBreakerOnSuccessEvent
- toString() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
- transitionBetween(String, CircuitBreaker.State, CircuitBreaker.State) - Static method in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
- transitionOnResult(Function<Either<Object, Throwable>, CircuitBreakerConfig.TransitionCheckResult>) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
-
Configures a function which can decide if the circuit breaker should transition to a different state base on the result of the protected function.
- transitionToClosedState() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Transitions the state machine to CLOSED state.
- transitionToClosedState() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
- transitionToDisabledState() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Transitions the state machine to a DISABLED state, stopping state transition, metrics and event publishing.
- transitionToDisabledState() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
- transitionToForcedOpenState() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Transitions the state machine to a FORCED_OPEN state, stopping state transition, metrics and event publishing.
- transitionToForcedOpenState() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
- transitionToHalfOpenState() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Transitions the state machine to HALF_OPEN state.
- transitionToHalfOpenState() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
- transitionToMetricsOnlyState() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Transitions the state machine to METRICS_ONLY state, stopping all state transitions but continues to capture metrics and publish events.
- transitionToMetricsOnlyState() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
- transitionToOpen() - Static method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.TransitionCheckResult
-
This will make the circuit breaker call
CircuitBreaker.transitionToOpenState()
- transitionToOpenAndWaitFor(Duration) - Static method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.TransitionCheckResult
-
This will make the circuit breaker call
CircuitBreaker.transitionToOpenStateFor(Duration)
- transitionToOpenAndWaitUntil(Instant) - Static method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.TransitionCheckResult
-
This will make the circuit breaker call
CircuitBreaker.transitionToOpenStateUntil(Instant)
- transitionToOpenState() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Transitions the state machine to OPEN state.
- transitionToOpenState() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
- transitionToOpenStateFor(Duration) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Same as
CircuitBreaker.transitionToOpenState()
but waits in open state for the given amount of time instead of relaying on configurations to determine it. - transitionToOpenStateFor(Duration) - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
- transitionToOpenStateUntil(Instant) - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Same as
CircuitBreaker.transitionToOpenState()
but waits in open state until the given in time instead of relaying on configurations to determine it. - transitionToOpenStateUntil(Instant) - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
- tryAcquirePermission() - Method in interface io.github.resilience4j.circuitbreaker.CircuitBreaker
-
Acquires a permission to execute a call, only if one is available at the time of invocation.
- tryAcquirePermission() - Method in class io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine
V
- valueOf(String) - Static method in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.State
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.SlidingWindowType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent.Type
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.State
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.resilience4j.circuitbreaker.CircuitBreaker.StateTransition
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.SlidingWindowType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- waitDurationInOpenState(Duration) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
-
Configures an interval function with a fixed wait duration which controls how long the CircuitBreaker should stay open, before it switches to half open.
- waitIntervalFunctionInOpenState(IntervalFunction) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
-
Configures an interval function which controls how long the CircuitBreaker should stay open, before it switches to half open.
- withCircuitBreakerConfig(CircuitBreakerConfig) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.Builder
-
Configures a CircuitBreakerRegistry with a custom default CircuitBreaker configuration.
- withRegistryStore(RegistryStore<CircuitBreaker>) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.Builder
- withTags(Map<String, String>) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.Builder
-
Configures a CircuitBreakerRegistry with Tags.
- writableStackTraceEnabled(boolean) - Method in class io.github.resilience4j.circuitbreaker.CircuitBreakerConfig.Builder
-
Enables writable stack traces.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form