Index
All Classes and Interfaces|All Packages|Serialized Form
A
- abortOn(Class<? extends Throwable>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- abortOn(Class<? extends Throwable>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder
-
Equivalent to
abortOn(Collections.singleton(value)). - abortOn(Class<? extends Throwable>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder
-
Equivalent to
abortOn(Set.of(value)). - abortOn(Collection<Class<? extends Throwable>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- abortOn(Collection<Class<? extends Throwable>>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder
-
Sets the set of exception types considered success.
- abortOn(Collection<Class<? extends Throwable>>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder
-
Sets the set of exception types considered success.
- adaptCallable(Callable<T>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Deprecated, for removal: This API element is subject to removal in a future version.
- adaptCallable(Callable<T>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard
-
Adapts given
actionto an action guarded by this configured set of fault tolerance strategies. - adaptCallable(Callable<T>, TypeLiteral<T>) - Method in interface io.smallrye.faulttolerance.api.Guard
-
Adapts given
actionto an action guarded by this configured set of fault tolerance strategies. - adaptCallable(Callable<T>, Class<T>) - Method in interface io.smallrye.faulttolerance.api.Guard
-
Adapts given
actionto an action guarded by this configured set of fault tolerance strategies. - adaptRunnable(Runnable) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Deprecated, for removal: This API element is subject to removal in a future version.
- adaptSupplier(Supplier<T>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Deprecated, for removal: This API element is subject to removal in a future version.
- adaptSupplier(Supplier<T>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard
-
Adapts given
actionto an action guarded by this configured set of fault tolerance strategies. - adaptSupplier(Supplier<T>, TypeLiteral<T>) - Method in interface io.smallrye.faulttolerance.api.Guard
-
Adapts given
actionto an action guarded by this configured set of fault tolerance strategies. - adaptSupplier(Supplier<T>, Class<T>) - Method in interface io.smallrye.faulttolerance.api.Guard
-
Adapts given
actionto an action guarded by this configured set of fault tolerance strategies. - AlwaysOnException - Class in io.smallrye.faulttolerance.api
- AlwaysOnException() - Constructor for class io.smallrye.faulttolerance.api.AlwaysOnException
- applies() - Method in interface io.smallrye.faulttolerance.api.Spi
- ApplyFaultTolerance - Annotation Type in io.smallrye.faulttolerance.api
-
Deprecated, for removal: This API element is subject to removal in a future version.use
ApplyGuard - ApplyGuard - Annotation Type in io.smallrye.faulttolerance.api
-
An interceptor binding annotation to apply preconfigured fault tolerance.
- applyOn(Class<? extends Throwable>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.FallbackBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- applyOn(Class<? extends Throwable>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.FallbackBuilder
-
Equivalent to
applyOn(Set.of(value)). - applyOn(Collection<Class<? extends Throwable>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.FallbackBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- applyOn(Collection<Class<? extends Throwable>>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.FallbackBuilder
-
Sets the set of exception types considered failure.
- AsynchronousNonBlocking - Annotation Type in io.smallrye.faulttolerance.api
-
Alternative to MicroProfile Fault Tolerance's
@Asynchronousfor guarding non-blocking asynchronous methods (executed on the original thread).
B
- beforeRetry(Runnable) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- beforeRetry(Runnable) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder
-
Sets a before retry handler, which is called before each retry, but not before the original attempt.
- beforeRetry(Runnable) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder
-
Sets a before retry handler, which is called before each retry, but not before the original attempt.
- beforeRetry(Consumer<Throwable>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- beforeRetry(Consumer<Throwable>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder
-
Sets a before retry handler, which is called before each retry, but not before the original attempt.
- beforeRetry(Consumer<Throwable>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder
-
Sets a before retry handler, which is called before each retry, but not before the original attempt.
- BeforeRetry - Annotation Type in io.smallrye.faulttolerance.api
-
Defines a handler or method that should be called before any retry, but not before the initial attempt.
- BeforeRetry.DEFAULT - Class in io.smallrye.faulttolerance.api
- BeforeRetryHandler - Interface in io.smallrye.faulttolerance.api
-
For each retry attempt, a new instance of the handler is created by the CDI container.
- build() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- build() - Method in interface io.smallrye.faulttolerance.api.Guard.Builder
-
Returns a ready-to-use instance of
Guard. - build() - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder
-
Returns a ready-to-use instance of
TypedGuard.
C
- call(Callable<T>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Deprecated, for removal: This API element is subject to removal in a future version.
- call(Callable<T>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard
-
Calls given
actionand guards the call by this configured set of fault tolerance strategies. - call(Callable<T>, TypeLiteral<T>) - Method in interface io.smallrye.faulttolerance.api.Guard
-
Calls given
action, which returns giventype, and guards the call by this configured set of fault tolerance strategies. - call(Callable<T>, Class<T>) - Method in interface io.smallrye.faulttolerance.api.Guard
-
Calls given
action, which returns giventype, and guards the call by this configured set of fault tolerance strategies. - cast() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Deprecated, for removal: This API element is subject to removal in a future version.use
GuardorTypedGuard, which unifies synchronous and asynchronous invocations - castAsync(Class<?>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Deprecated, for removal: This API element is subject to removal in a future version.use
GuardorTypedGuard, which unifies synchronous and asynchronous invocations - circuitBreakerMaintenance() - Static method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Deprecated, for removal: This API element is subject to removal in a future version.
- circuitBreakerMaintenance() - Method in interface io.smallrye.faulttolerance.api.Spi
- CircuitBreakerMaintenance - Interface in io.smallrye.faulttolerance.api
-
Allows reading and observing current state of circuit breakers and resetting them to the initial (closed) state.
- CircuitBreakerName - Annotation Type in io.smallrye.faulttolerance.api
-
A
@CircuitBreakermethod can be annotated@CircuitBreakerNameto provide a name for the circuit breaker associated with the annotated method. - CircuitBreakerState - Enum in io.smallrye.faulttolerance.api
- CLOSED - Enum constant in enum io.smallrye.faulttolerance.api.CircuitBreakerState
- create() - Static method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Deprecated, for removal: This API element is subject to removal in a future version.
- create() - Static method in interface io.smallrye.faulttolerance.api.Guard
-
Creates a builder for producing a
Guardobject representing a set of configured fault tolerance strategies. - create(TypeLiteral<T>) - Static method in interface io.smallrye.faulttolerance.api.TypedGuard
-
Creates a builder for producing a
TypedGuardobject representing a set of configured fault tolerance strategies that guard giventype. - create(Class<T>) - Static method in interface io.smallrye.faulttolerance.api.TypedGuard
-
Creates a builder for producing a
TypedGuardobject representing a set of configured fault tolerance strategies that guard giventype. - createAsync() - Static method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Deprecated, for removal: This API element is subject to removal in a future version.
- createAsyncCallable(Callable<CompletionStage<T>>) - Static method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Deprecated, for removal: This API element is subject to removal in a future version.
- createAsyncRunnable(Runnable) - Static method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Deprecated, for removal: This API element is subject to removal in a future version.use
GuardorTypedGuard; there's no direct support for guardingRunnables, but adapting toSupplier<Void>by usingadaptSuppliershould be close enough - createAsyncSupplier(Supplier<CompletionStage<T>>) - Static method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Deprecated, for removal: This API element is subject to removal in a future version.
- createCallable(Callable<T>) - Static method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Deprecated, for removal: This API element is subject to removal in a future version.
- createRunnable(Runnable) - Static method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Deprecated, for removal: This API element is subject to removal in a future version.use
GuardorTypedGuard; there's no direct support for guardingRunnables, but adapting toSupplier<Void>by usingadaptSuppliershould be close enough - createSupplier(Supplier<T>) - Static method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Deprecated, for removal: This API element is subject to removal in a future version.
- currentState(String) - Method in interface io.smallrye.faulttolerance.api.CircuitBreakerMaintenance
-
Returns current state of the circuit breaker with given
name. - CustomBackoff - Annotation Type in io.smallrye.faulttolerance.api
-
Modifies a
@Retryannotation to use a custom backoff strategy instead of the default constant backoff. - CustomBackoffStrategy - Interface in io.smallrye.faulttolerance.api
-
For each invocation of a method annotated
@Retryand@CustomBackoff, an instance of custom backoff strategy is created and used for computing delays between individual retry attempts.
D
- DEFAULT() - Constructor for class io.smallrye.faulttolerance.api.BeforeRetry.DEFAULT
- delay(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- delay(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- delay(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.CircuitBreakerBuilder
-
Sets the delay after which an open circuit moves to half-open.
- delay(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder
-
Sets the delay between retries.
- delay(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.CircuitBreakerBuilder
-
Sets the delay after which an open circuit moves to half-open.
- delay(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder
-
Sets the delay between retries.
- done() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.BulkheadBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- done() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- done() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.FallbackBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- done() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RateLimitBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- done() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder.CustomBackoffBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- done() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- done() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder.ExponentialBackoffBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- done() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder.FibonacciBackoffBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- done() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.TimeoutBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- done() - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.BulkheadBuilder
-
Returns the original fault tolerance builder.
- done() - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.CircuitBreakerBuilder
-
Returns the original fault tolerance builder.
- done() - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RateLimitBuilder
-
Returns the original fault tolerance builder.
- done() - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder.CustomBackoffBuilder
-
Returns the original retry builder.
- done() - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder
-
Returns the original fault tolerance builder.
- done() - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder.ExponentialBackoffBuilder
-
Returns the original retry builder.
- done() - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder.FibonacciBackoffBuilder
-
Returns the original retry builder.
- done() - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.TimeoutBuilder
-
Returns the original fault tolerance builder.
- done() - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.BulkheadBuilder
-
Returns the original fault tolerance builder.
- done() - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.CircuitBreakerBuilder
-
Returns the original fault tolerance builder.
- done() - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.FallbackBuilder
-
Returns the original fault tolerance builder.
- done() - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RateLimitBuilder
-
Returns the original fault tolerance builder.
- done() - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder.CustomBackoffBuilder
-
Returns the original retry builder.
- done() - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder
-
Returns the original fault tolerance builder.
- done() - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder.ExponentialBackoffBuilder
-
Returns the original retry builder.
- done() - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder.FibonacciBackoffBuilder
-
Returns the original retry builder.
- done() - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.TimeoutBuilder
-
Returns the original fault tolerance builder.
- duration(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.TimeoutBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- duration(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.TimeoutBuilder
-
Sets the timeout duration.
- duration(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.TimeoutBuilder
-
Sets the timeout duration.
E
- enableSynchronousQueueing() - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.BulkheadBuilder
-
Enables bulkhead queueing for synchronous actions.
- enableSynchronousQueueing() - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.BulkheadBuilder
-
Enables bulkhead queueing for synchronous actions.
- enableVirtualThreadsQueueing() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.BulkheadBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.use
enableSynchronousQueueing() - exception() - Element in annotation type io.smallrye.faulttolerance.api.RetryWhen
-
Class of the predicate that will be used to determine whether the action should be retried if the action has thrown an exception.
- ExponentialBackoff - Annotation Type in io.smallrye.faulttolerance.api
-
Modifies a
@Retryannotation to use exponential backoff instead of the default constant backoff.
F
- factor() - Element in annotation type io.smallrye.faulttolerance.api.ExponentialBackoff
-
The multiplicative factor used when determining a delay between two retries.
- factor(int) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder.ExponentialBackoffBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- factor(int) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder.ExponentialBackoffBuilder
-
Sets the multiplicative factor used to determine delay between retries.
- factor(int) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder.ExponentialBackoffBuilder
-
Sets the multiplicative factor used to determine delay between retries.
- failOn(Class<? extends Throwable>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- failOn(Class<? extends Throwable>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.CircuitBreakerBuilder
-
Equivalent to
failOn(Set.of(value)). - failOn(Class<? extends Throwable>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.CircuitBreakerBuilder
-
Equivalent to
failOn(Set.of(value)). - failOn(Collection<Class<? extends Throwable>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- failOn(Collection<Class<? extends Throwable>>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.CircuitBreakerBuilder
-
Sets the set of exception types considered failure.
- failOn(Collection<Class<? extends Throwable>>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.CircuitBreakerBuilder
-
Sets the set of exception types considered failure.
- failureRatio(double) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- failureRatio(double) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.CircuitBreakerBuilder
-
Sets the failure ratio that, once reached, will move a closed circuit breaker to open.
- failureRatio(double) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.CircuitBreakerBuilder
-
Sets the failure ratio that, once reached, will move a closed circuit breaker to open.
- FaultTolerance<T> - Interface in io.smallrye.faulttolerance.api
-
Deprecated, for removal: This API element is subject to removal in a future version.use
GuardorTypedGuard - FaultTolerance.Builder<T,
R> - Interface in io.smallrye.faulttolerance.api -
Deprecated, for removal: This API element is subject to removal in a future version.use
Guard.BuilderorTypedGuard.Builder - FaultTolerance.Builder.BulkheadBuilder<T,
R> - Interface in io.smallrye.faulttolerance.api -
Deprecated, for removal: This API element is subject to removal in a future version.
- FaultTolerance.Builder.CircuitBreakerBuilder<T,
R> - Interface in io.smallrye.faulttolerance.api -
Deprecated, for removal: This API element is subject to removal in a future version.
- FaultTolerance.Builder.FallbackBuilder<T,
R> - Interface in io.smallrye.faulttolerance.api -
Deprecated, for removal: This API element is subject to removal in a future version.
- FaultTolerance.Builder.RateLimitBuilder<T,
R> - Interface in io.smallrye.faulttolerance.api -
Deprecated, for removal: This API element is subject to removal in a future version.
- FaultTolerance.Builder.RetryBuilder<T,
R> - Interface in io.smallrye.faulttolerance.api -
Deprecated, for removal: This API element is subject to removal in a future version.
- FaultTolerance.Builder.RetryBuilder.CustomBackoffBuilder<T,
R> - Interface in io.smallrye.faulttolerance.api -
Deprecated, for removal: This API element is subject to removal in a future version.
- FaultTolerance.Builder.RetryBuilder.ExponentialBackoffBuilder<T,
R> - Interface in io.smallrye.faulttolerance.api -
Deprecated, for removal: This API element is subject to removal in a future version.
- FaultTolerance.Builder.RetryBuilder.FibonacciBackoffBuilder<T,
R> - Interface in io.smallrye.faulttolerance.api -
Deprecated, for removal: This API element is subject to removal in a future version.
- FaultTolerance.Builder.TimeoutBuilder<T,
R> - Interface in io.smallrye.faulttolerance.api -
Deprecated, for removal: This API element is subject to removal in a future version.
- FibonacciBackoff - Annotation Type in io.smallrye.faulttolerance.api
-
Modifies a
@Retryannotation to use Fibonacci backoff instead of the default constant backoff. - FIXED - Enum constant in enum io.smallrye.faulttolerance.api.RateLimitType
-
Divides time into non-overlapping intervals of given length (time windows) and enforces the invocation limit for each interval independently.
G
- get() - Static method in interface io.smallrye.faulttolerance.api.CircuitBreakerMaintenance
-
Returns a
CircuitBreakerMaintenanceinstance that provides maintenance access to existing circuit breakers. - get() - Static method in class io.smallrye.faulttolerance.api.SpiAccess
- get(Supplier<T>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Deprecated, for removal: This API element is subject to removal in a future version.
- get(Supplier<T>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard
-
Calls given
actionand guards the call by this configured set of fault tolerance strategies. - get(Supplier<T>, TypeLiteral<T>) - Method in interface io.smallrye.faulttolerance.api.Guard
-
Calls given
action, which returns giventype, and guards the call by this configured set of fault tolerance strategies. - get(Supplier<T>, Class<T>) - Method in interface io.smallrye.faulttolerance.api.Guard
-
Calls given
action, which returns giventype, and guards the call by this configured set of fault tolerance strategies. - getRetryAfterMillis() - Method in exception class io.smallrye.faulttolerance.api.RateLimitException
-
Returns the number of milliseconds after which the user may retry the rejected invocation.
- Guard - Interface in io.smallrye.faulttolerance.api
-
Allows guarding an action with various fault tolerance strategies: bulkhead, circuit breaker, rate limit, retry.
- Guard.Builder - Interface in io.smallrye.faulttolerance.api
-
A builder for configuring fault tolerance strategies.
- Guard.Builder.BulkheadBuilder - Interface in io.smallrye.faulttolerance.api
-
Configures a bulkhead.
- Guard.Builder.CircuitBreakerBuilder - Interface in io.smallrye.faulttolerance.api
-
Configures a circuit breaker.
- Guard.Builder.RateLimitBuilder - Interface in io.smallrye.faulttolerance.api
-
Configures a rate limit.
- Guard.Builder.RetryBuilder - Interface in io.smallrye.faulttolerance.api
-
Configures a retry.
- Guard.Builder.RetryBuilder.CustomBackoffBuilder - Interface in io.smallrye.faulttolerance.api
-
Configures a custom backoff for retry.
- Guard.Builder.RetryBuilder.ExponentialBackoffBuilder - Interface in io.smallrye.faulttolerance.api
-
Configures an exponential backoff for retry.
- Guard.Builder.RetryBuilder.FibonacciBackoffBuilder - Interface in io.smallrye.faulttolerance.api
-
Configures a Fibonacci backoff for retry.
- Guard.Builder.TimeoutBuilder - Interface in io.smallrye.faulttolerance.api
-
Configures a timeout.
H
- HALF_OPEN - Enum constant in enum io.smallrye.faulttolerance.api.CircuitBreakerState
- handle(ExecutionContext) - Method in class io.smallrye.faulttolerance.api.BeforeRetry.DEFAULT
- handle(ExecutionContext) - Method in interface io.smallrye.faulttolerance.api.BeforeRetryHandler
-
Do what is necessary before the next retry attempt.
- handler(Function<Throwable, T>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.FallbackBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- handler(Function<Throwable, T>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.FallbackBuilder
-
Sets the fallback handler in the form of a
Functionthat transforms the exception to the fallback value. - handler(Supplier<T>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.FallbackBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- handler(Supplier<T>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.FallbackBuilder
-
Sets the fallback handler in the form of a fallback value
Supplier.
I
- init(long) - Method in interface io.smallrye.faulttolerance.api.CustomBackoffStrategy
-
Called once, after instantiation.
- io.smallrye.faulttolerance.api - package io.smallrye.faulttolerance.api
J
- jitter(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- jitter(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder
-
Sets the jitter bound.
- jitter(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder
-
Sets the jitter bound.
L
- limit(int) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.BulkheadBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- limit(int) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RateLimitBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- limit(int) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.BulkheadBuilder
-
Sets the concurrency limit the bulkhead will enforce.
- limit(int) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RateLimitBuilder
-
Sets the maximum number of invocations in a time window.
- limit(int) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.BulkheadBuilder
-
Sets the concurrency limit the bulkhead will enforce.
- limit(int) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RateLimitBuilder
-
Sets the maximum number of invocations in a time window.
M
- maxDelay() - Element in annotation type io.smallrye.faulttolerance.api.ExponentialBackoff
-
The maximum delay between retries.
- maxDelay() - Element in annotation type io.smallrye.faulttolerance.api.FibonacciBackoff
-
The maximum delay between retries.
- maxDelay(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder.ExponentialBackoffBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- maxDelay(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder.FibonacciBackoffBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- maxDelay(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder.ExponentialBackoffBuilder
-
Sets the maximum delay between retries.
- maxDelay(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder.FibonacciBackoffBuilder
-
Sets the maximum delay between retries.
- maxDelay(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder.ExponentialBackoffBuilder
-
Sets the maximum delay between retries.
- maxDelay(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder.FibonacciBackoffBuilder
-
Sets the maximum delay between retries.
- maxDelayUnit() - Element in annotation type io.smallrye.faulttolerance.api.ExponentialBackoff
-
The unit for
ExponentialBackoff.maxDelay(). - maxDelayUnit() - Element in annotation type io.smallrye.faulttolerance.api.FibonacciBackoff
-
The unit for
FibonacciBackoff.maxDelay(). - maxDuration(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- maxDuration(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder
-
Sets the maximum duration of all invocations, including possible retries.
- maxDuration(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder
-
Sets the maximum duration of all invocations, including possible retries.
- maxRetries(int) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- maxRetries(int) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder
-
Sets the maximum number of retries.
- maxRetries(int) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder
-
Sets the maximum number of retries.
- methodName() - Element in annotation type io.smallrye.faulttolerance.api.BeforeRetry
-
Specifies the name of the method to call before each retry.
- minSpacing() - Element in annotation type io.smallrye.faulttolerance.api.RateLimit
-
Minimum time between two consecutive invocations.
- minSpacing(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RateLimitBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- minSpacing(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RateLimitBuilder
-
Sets the minimum spacing between invocations.
- minSpacing(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RateLimitBuilder
-
Sets the minimum spacing between invocations.
- minSpacingUnit() - Element in annotation type io.smallrye.faulttolerance.api.RateLimit
-
The unit of the minimum time between two consecutive invocations.
N
- name(String) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- name(String) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.CircuitBreakerBuilder
-
Sets a circuit breaker name.
- name(String) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.CircuitBreakerBuilder
-
Sets a circuit breaker name.
- NeverOnResult - Class in io.smallrye.faulttolerance.api
- NeverOnResult() - Constructor for class io.smallrye.faulttolerance.api.NeverOnResult
- newAsyncBuilder(Class<?>, Function<FaultTolerance<T>, R>) - Method in interface io.smallrye.faulttolerance.api.Spi
-
Deprecated, for removal: This API element is subject to removal in a future version.
- newBuilder(Function<FaultTolerance<T>, R>) - Method in interface io.smallrye.faulttolerance.api.Spi
-
Deprecated, for removal: This API element is subject to removal in a future version.
- newGuardBuilder() - Method in interface io.smallrye.faulttolerance.api.Spi
- newTypedGuardBuilder(Type) - Method in interface io.smallrye.faulttolerance.api.Spi
- nextDelayInMillis(Throwable) - Method in interface io.smallrye.faulttolerance.api.CustomBackoffStrategy
-
Called to compute a delay before each retry attempt, including before the first retry.
O
- onAccepted(Runnable) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.BulkheadBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- onAccepted(Runnable) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.BulkheadBuilder
-
Sets a callback that will be invoked when this bulkhead accepts an invocation.
- onAccepted(Runnable) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.BulkheadBuilder
-
Sets a callback that will be invoked when this bulkhead accepts an invocation.
- onFailure(Runnable) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- onFailure(Runnable) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- onFailure(Runnable) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.CircuitBreakerBuilder
-
Sets a callback that will be invoked when this circuit breaker treats a finished invocation as failure.
- onFailure(Runnable) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder
-
Sets a callback that will be invoked when this retry strategy treats a finished invocation as failure, and no more retries will be attempted.
- onFailure(Runnable) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.CircuitBreakerBuilder
-
Sets a callback that will be invoked when this circuit breaker treats a finished invocation as failure.
- onFailure(Runnable) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder
-
Sets a callback that will be invoked when this retry strategy treats a finished invocation as failure, and no more retries will be attempted.
- onFinished(Runnable) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.BulkheadBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- onFinished(Runnable) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.TimeoutBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- onFinished(Runnable) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.BulkheadBuilder
-
Sets a callback that will be invoked when a finished invocation leaves this bulkhead.
- onFinished(Runnable) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.TimeoutBuilder
-
Sets a callback that will be invoked when an invocation finishes before the timeout.
- onFinished(Runnable) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.BulkheadBuilder
-
Sets a callback that will be invoked when a finished invocation leaves this bulkhead.
- onFinished(Runnable) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.TimeoutBuilder
-
Sets a callback that will be invoked when an invocation finishes before the timeout.
- onPermitted(Runnable) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RateLimitBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- onPermitted(Runnable) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RateLimitBuilder
-
Sets a callback that will be invoked when this rate limit permits an invocation.
- onPermitted(Runnable) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RateLimitBuilder
-
Sets a callback that will be invoked when this rate limit permits an invocation.
- onPrevented(Runnable) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- onPrevented(Runnable) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.CircuitBreakerBuilder
-
Sets a callback that will be invoked when this circuit breaker prevents an invocation, because it is in the open or half-open state.
- onPrevented(Runnable) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.CircuitBreakerBuilder
-
Sets a callback that will be invoked when this circuit breaker prevents an invocation, because it is in the open or half-open state.
- onRejected(Runnable) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.BulkheadBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- onRejected(Runnable) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RateLimitBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- onRejected(Runnable) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.BulkheadBuilder
-
Sets a callback that will be invoked when this bulkhead rejects an invocation.
- onRejected(Runnable) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RateLimitBuilder
-
Sets a callback that will be invoked when this rate limit rejects an invocation.
- onRejected(Runnable) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.BulkheadBuilder
-
Sets a callback that will be invoked when this bulkhead rejects an invocation.
- onRejected(Runnable) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RateLimitBuilder
-
Sets a callback that will be invoked when this rate limit rejects an invocation.
- onRetry(Runnable) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- onRetry(Runnable) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder
-
Sets a callback that will be invoked when a retry is attempted.
- onRetry(Runnable) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder
-
Sets a callback that will be invoked when a retry is attempted.
- onStateChange(String, Consumer<CircuitBreakerState>) - Method in interface io.smallrye.faulttolerance.api.CircuitBreakerMaintenance
-
Registers a
callbackto be called when the circuit breaker with givennamechanges state. - onStateChange(Consumer<CircuitBreakerState>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- onStateChange(Consumer<CircuitBreakerState>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.CircuitBreakerBuilder
-
Sets a callback that will be invoked upon each state change of this circuit breaker.
- onStateChange(Consumer<CircuitBreakerState>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.CircuitBreakerBuilder
-
Sets a callback that will be invoked upon each state change of this circuit breaker.
- onSuccess(Runnable) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- onSuccess(Runnable) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- onSuccess(Runnable) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.CircuitBreakerBuilder
-
Sets a callback that will be invoked when this circuit breaker treats a finished invocation as success.
- onSuccess(Runnable) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder
-
Sets a callback that will be invoked when this retry strategy treats a finished invocation as success, regardless of whether a retry was attempted or not.
- onSuccess(Runnable) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.CircuitBreakerBuilder
-
Sets a callback that will be invoked when this circuit breaker treats a finished invocation as success.
- onSuccess(Runnable) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder
-
Sets a callback that will be invoked when this retry strategy treats a finished invocation as success, regardless of whether a retry was attempted or not.
- onTimeout(Runnable) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.TimeoutBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- onTimeout(Runnable) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.TimeoutBuilder
-
Sets a callback that will be invoked when an invocation times out.
- onTimeout(Runnable) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.TimeoutBuilder
-
Sets a callback that will be invoked when an invocation times out.
- OPEN - Enum constant in enum io.smallrye.faulttolerance.api.CircuitBreakerState
P
- priority() - Method in interface io.smallrye.faulttolerance.api.Spi
Q
- queueSize(int) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.BulkheadBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- queueSize(int) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.BulkheadBuilder
-
Sets the maximum size of the bulkhead queue.
- queueSize(int) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.BulkheadBuilder
-
Sets the maximum size of the bulkhead queue.
R
- RateLimit - Annotation Type in io.smallrye.faulttolerance.api
-
Rate limit restricts the number of invocations in a time window of some length.
- RateLimitException - Exception Class in io.smallrye.faulttolerance.api
-
The exception thrown when an invocation exceeds the configured rate limit.
- RateLimitException() - Constructor for exception class io.smallrye.faulttolerance.api.RateLimitException
- RateLimitException(long) - Constructor for exception class io.smallrye.faulttolerance.api.RateLimitException
- RateLimitException(long, String) - Constructor for exception class io.smallrye.faulttolerance.api.RateLimitException
- RateLimitException(long, String, Throwable) - Constructor for exception class io.smallrye.faulttolerance.api.RateLimitException
- RateLimitException(long, Throwable) - Constructor for exception class io.smallrye.faulttolerance.api.RateLimitException
- RateLimitException(String) - Constructor for exception class io.smallrye.faulttolerance.api.RateLimitException
- RateLimitException(String, Throwable) - Constructor for exception class io.smallrye.faulttolerance.api.RateLimitException
- RateLimitException(Throwable) - Constructor for exception class io.smallrye.faulttolerance.api.RateLimitException
- RateLimitType - Enum in io.smallrye.faulttolerance.api
-
Type of the time window used for rate limiting.
- requestVolumeThreshold(int) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- requestVolumeThreshold(int) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.CircuitBreakerBuilder
-
Sets the size of the circuit breaker's rolling window.
- requestVolumeThreshold(int) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.CircuitBreakerBuilder
-
Sets the size of the circuit breaker's rolling window.
- reset(String) - Method in interface io.smallrye.faulttolerance.api.CircuitBreakerMaintenance
-
Resets the circuit breaker with given
nameto the initial (closed) state. - resetAll() - Method in interface io.smallrye.faulttolerance.api.CircuitBreakerMaintenance
-
Resets all circuit breakers in the application to the initial (closed) state.
- result() - Element in annotation type io.smallrye.faulttolerance.api.RetryWhen
-
Class of the predicate that will be used to determine whether the action should be retried if the action has returned a result.
- retryOn(Class<? extends Throwable>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- retryOn(Class<? extends Throwable>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder
-
Equivalent to
retryOn(Collections.singleton(value)). - retryOn(Class<? extends Throwable>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder
-
Equivalent to
retryOn(Set.of(value)). - retryOn(Collection<Class<? extends Throwable>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- retryOn(Collection<Class<? extends Throwable>>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder
-
Sets the set of exception types considered failure.
- retryOn(Collection<Class<? extends Throwable>>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder
-
Sets the set of exception types considered failure.
- RetryWhen - Annotation Type in io.smallrye.faulttolerance.api
-
Modifies a
@Retryannotation to retry when given predicate returnstrue. - ROLLING - Enum constant in enum io.smallrye.faulttolerance.api.RateLimitType
-
Enforces the limit continuously, instead of dividing time into independent windows.
- run(Runnable) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Deprecated, for removal: This API element is subject to removal in a future version.
S
- skipOn(Class<? extends Throwable>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- skipOn(Class<? extends Throwable>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.FallbackBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- skipOn(Class<? extends Throwable>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.CircuitBreakerBuilder
-
Equivalent to
skipOn(Set.of(value)). - skipOn(Class<? extends Throwable>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.CircuitBreakerBuilder
-
Equivalent to
skipOn(Set.of(value)). - skipOn(Class<? extends Throwable>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.FallbackBuilder
-
Equivalent to
skipOn(Set.of(value)). - skipOn(Collection<Class<? extends Throwable>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- skipOn(Collection<Class<? extends Throwable>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.FallbackBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- skipOn(Collection<Class<? extends Throwable>>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.CircuitBreakerBuilder
-
Sets the set of exception types considered success.
- skipOn(Collection<Class<? extends Throwable>>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.CircuitBreakerBuilder
-
Sets the set of exception types considered success.
- skipOn(Collection<Class<? extends Throwable>>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.FallbackBuilder
-
Sets the set of exception types considered success.
- SMOOTH - Enum constant in enum io.smallrye.faulttolerance.api.RateLimitType
-
Calculates the maximum rate of invocations from given time window length and given limit and enforces a uniform distribution of invocations over time under the calculated rate.
- Spi - Interface in io.smallrye.faulttolerance.api
-
This is an internal API.
- SpiAccess - Class in io.smallrye.faulttolerance.api
-
This is an internal API.
- SpiAccess() - Constructor for class io.smallrye.faulttolerance.api.SpiAccess
- strategy(Supplier<CustomBackoffStrategy>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder.CustomBackoffBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- strategy(Supplier<CustomBackoffStrategy>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder.CustomBackoffBuilder
-
Sets the custom backoff strategy in the form of a
SupplierofCustomBackoffStrategyinstances. - strategy(Supplier<CustomBackoffStrategy>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder.CustomBackoffBuilder
-
Sets the custom backoff strategy in the form of a
SupplierofCustomBackoffStrategyinstances. - successThreshold(int) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- successThreshold(int) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.CircuitBreakerBuilder
-
Sets the number of successful executions that, once reached, will move a half-open circuit breaker to closed.
- successThreshold(int) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.CircuitBreakerBuilder
-
Sets the number of successful executions that, once reached, will move a half-open circuit breaker to closed.
T
- test(Object) - Method in class io.smallrye.faulttolerance.api.NeverOnResult
- test(Throwable) - Method in class io.smallrye.faulttolerance.api.AlwaysOnException
- type() - Element in annotation type io.smallrye.faulttolerance.api.RateLimit
-
Type of time windows used for rate limiting.
- type(RateLimitType) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RateLimitBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- type(RateLimitType) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RateLimitBuilder
-
Sets the type of time windows used for rate limiting.
- type(RateLimitType) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RateLimitBuilder
-
Sets the type of time windows used for rate limiting.
- TypedGuard<T> - Interface in io.smallrye.faulttolerance.api
-
Allows guarding an action with various fault tolerance strategies: bulkhead, circuit breaker, fallback, rate limit, retry.
- TypedGuard.Builder<T> - Interface in io.smallrye.faulttolerance.api
-
A builder for configuring fault tolerance strategies.
- TypedGuard.Builder.BulkheadBuilder<T> - Interface in io.smallrye.faulttolerance.api
-
Configures a bulkhead.
- TypedGuard.Builder.CircuitBreakerBuilder<T> - Interface in io.smallrye.faulttolerance.api
-
Configures a circuit breaker.
- TypedGuard.Builder.FallbackBuilder<T> - Interface in io.smallrye.faulttolerance.api
-
Configures a fallback.
- TypedGuard.Builder.RateLimitBuilder<T> - Interface in io.smallrye.faulttolerance.api
-
Configures a rate limit.
- TypedGuard.Builder.RetryBuilder<T> - Interface in io.smallrye.faulttolerance.api
-
Configures a retry.
- TypedGuard.Builder.RetryBuilder.CustomBackoffBuilder<T> - Interface in io.smallrye.faulttolerance.api
-
Configures a custom backoff for retry.
- TypedGuard.Builder.RetryBuilder.ExponentialBackoffBuilder<T> - Interface in io.smallrye.faulttolerance.api
-
Configures an exponential backoff for retry.
- TypedGuard.Builder.RetryBuilder.FibonacciBackoffBuilder<T> - Interface in io.smallrye.faulttolerance.api
-
Configures a Fibonacci backoff for retry.
- TypedGuard.Builder.TimeoutBuilder<T> - Interface in io.smallrye.faulttolerance.api
-
Configures a timeout.
U
- Usage - Search tag in interface io.smallrye.faulttolerance.api.BeforeRetryHandler
- Section
V
- value() - Element in annotation type io.smallrye.faulttolerance.api.ApplyFaultTolerance
-
Deprecated, for removal: This API element is subject to removal in a future version.
- value() - Element in annotation type io.smallrye.faulttolerance.api.ApplyGuard
-
The identifier of a preconfigured
GuardorTypedGuardinstance. - value() - Element in annotation type io.smallrye.faulttolerance.api.BeforeRetry
-
Specify the before retry handler class to be used.
- value() - Element in annotation type io.smallrye.faulttolerance.api.CircuitBreakerName
- value() - Element in annotation type io.smallrye.faulttolerance.api.CustomBackoff
-
Class of the custom backoff strategy that will be used to compute retry delays.
- value() - Element in annotation type io.smallrye.faulttolerance.api.RateLimit
-
Maximum number of invocations in a time window.
- valueOf(String) - Static method in enum io.smallrye.faulttolerance.api.CircuitBreakerState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.smallrye.faulttolerance.api.RateLimitType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum io.smallrye.faulttolerance.api.CircuitBreakerState
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.smallrye.faulttolerance.api.RateLimitType
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- when(Predicate<Throwable>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- when(Predicate<Throwable>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.FallbackBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- when(Predicate<Throwable>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- when(Predicate<Throwable>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.CircuitBreakerBuilder
-
Sets a predicate to determine when an exception should be considered failure by the circuit breaker.
- when(Predicate<Throwable>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.CircuitBreakerBuilder
-
Sets a predicate to determine when an exception should be considered failure by the circuit breaker.
- when(Predicate<Throwable>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.FallbackBuilder
-
Sets a predicate to determine when an exception should be considered failure and fallback should be applied.
- whenException(Predicate<Throwable>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- whenException(Predicate<Throwable>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder
-
Sets a predicate to determine when an exception should be considered failure and retry should be attempted.
- whenException(Predicate<Throwable>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder
-
Sets a predicate to determine when an exception should be considered failure and retry should be attempted.
- whenResult(Predicate<Object>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- whenResult(Predicate<Object>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder
-
Sets a predicate to determine when a result should be considered failure and retry should be attempted.
- whenResult(Predicate<Object>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder
-
Sets a predicate to determine when a result should be considered failure and retry should be attempted.
- window() - Element in annotation type io.smallrye.faulttolerance.api.RateLimit
-
The time window length.
- window(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RateLimitBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- window(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RateLimitBuilder
-
Sets the time window length.
- window(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RateLimitBuilder
-
Sets the time window length.
- windowUnit() - Element in annotation type io.smallrye.faulttolerance.api.RateLimit
-
The unit of length of a time window.
- with(Consumer<FaultTolerance.Builder.BulkheadBuilder<T, R>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.BulkheadBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- with(Consumer<FaultTolerance.Builder.CircuitBreakerBuilder<T, R>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- with(Consumer<FaultTolerance.Builder.FallbackBuilder<T, R>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.FallbackBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- with(Consumer<FaultTolerance.Builder.RateLimitBuilder<T, R>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RateLimitBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- with(Consumer<FaultTolerance.Builder.RetryBuilder.CustomBackoffBuilder<T, R>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder.CustomBackoffBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- with(Consumer<FaultTolerance.Builder.RetryBuilder.ExponentialBackoffBuilder<T, R>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder.ExponentialBackoffBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- with(Consumer<FaultTolerance.Builder.RetryBuilder.FibonacciBackoffBuilder<T, R>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder.FibonacciBackoffBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- with(Consumer<FaultTolerance.Builder.RetryBuilder<T, R>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- with(Consumer<FaultTolerance.Builder.TimeoutBuilder<T, R>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.TimeoutBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- with(Consumer<FaultTolerance.Builder<T, R>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- with(Consumer<Guard.Builder.BulkheadBuilder>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.BulkheadBuilder
- with(Consumer<Guard.Builder.CircuitBreakerBuilder>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.CircuitBreakerBuilder
- with(Consumer<Guard.Builder.RateLimitBuilder>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RateLimitBuilder
- with(Consumer<Guard.Builder.RetryBuilder.CustomBackoffBuilder>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder.CustomBackoffBuilder
- with(Consumer<Guard.Builder.RetryBuilder.ExponentialBackoffBuilder>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder.ExponentialBackoffBuilder
- with(Consumer<Guard.Builder.RetryBuilder.FibonacciBackoffBuilder>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder.FibonacciBackoffBuilder
- with(Consumer<Guard.Builder.RetryBuilder>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder
- with(Consumer<Guard.Builder.TimeoutBuilder>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.TimeoutBuilder
- with(Consumer<Guard.Builder>) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder
-
Syntactic sugar for calling the builder methods conditionally without breaking the invocation chain.
- with(Consumer<TypedGuard.Builder.BulkheadBuilder<T>>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.BulkheadBuilder
- with(Consumer<TypedGuard.Builder.CircuitBreakerBuilder<T>>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.CircuitBreakerBuilder
- with(Consumer<TypedGuard.Builder.FallbackBuilder<T>>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.FallbackBuilder
- with(Consumer<TypedGuard.Builder.RateLimitBuilder<T>>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RateLimitBuilder
- with(Consumer<TypedGuard.Builder.RetryBuilder.CustomBackoffBuilder<T>>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder.CustomBackoffBuilder
- with(Consumer<TypedGuard.Builder.RetryBuilder.ExponentialBackoffBuilder<T>>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder.ExponentialBackoffBuilder
- with(Consumer<TypedGuard.Builder.RetryBuilder.FibonacciBackoffBuilder<T>>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder.FibonacciBackoffBuilder
- with(Consumer<TypedGuard.Builder.RetryBuilder<T>>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder
- with(Consumer<TypedGuard.Builder.TimeoutBuilder<T>>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.TimeoutBuilder
- with(Consumer<TypedGuard.Builder<T>>) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder
-
Syntactic sugar for calling the builder methods conditionally without breaking the invocation chain.
- withBulkhead() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- withBulkhead() - Method in interface io.smallrye.faulttolerance.api.Guard.Builder
-
Adds a bulkhead strategy.
- withBulkhead() - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder
-
Adds a bulkhead strategy.
- withCircuitBreaker() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- withCircuitBreaker() - Method in interface io.smallrye.faulttolerance.api.Guard.Builder
-
Adds a circuit breaker strategy.
- withCircuitBreaker() - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder
-
Adds a circuit breaker strategy.
- withCustomBackoff() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- withCustomBackoff() - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder
-
Configures retry to use a custom backoff instead of the default constant backoff.
- withCustomBackoff() - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder
-
Configures retry to use a custom backoff instead of the default constant backoff.
- withDescription(String) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- withDescription(String) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder
-
Assigns a description to the resulting set of configured fault tolerance strategies.
- withDescription(String) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder
-
Assigns a description to the resulting set of configured fault tolerance strategies.
- withExponentialBackoff() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- withExponentialBackoff() - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder
-
Configures retry to use an exponential backoff instead of the default constant backoff.
- withExponentialBackoff() - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder
-
Configures retry to use an exponential backoff instead of the default constant backoff.
- withFallback() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- withFallback() - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder
-
Adds a fallback strategy.
- withFibonacciBackoff() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- withFibonacciBackoff() - Method in interface io.smallrye.faulttolerance.api.Guard.Builder.RetryBuilder
-
Configures retry to use a Fibonacci backoff instead of the default constant backoff.
- withFibonacciBackoff() - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder.RetryBuilder
-
Configures retry to use a Fibonacci backoff instead of the default constant backoff.
- withRateLimit() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- withRateLimit() - Method in interface io.smallrye.faulttolerance.api.Guard.Builder
-
Adds a rate limit strategy.
- withRateLimit() - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder
-
Adds a rate limit strategy.
- withRetry() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- withRetry() - Method in interface io.smallrye.faulttolerance.api.Guard.Builder
-
Adds a retry strategy.
- withRetry() - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder
-
Adds a retry strategy.
- withThreadOffload(boolean) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- withThreadOffload(boolean) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder
-
Configures whether an asynchronous guarded action should be offloaded to another thread.
- withThreadOffload(boolean) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder
-
Configures whether an asynchronous guarded action should be offloaded to another thread.
- withThreadOffloadExecutor(Executor) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- withThreadOffloadExecutor(Executor) - Method in interface io.smallrye.faulttolerance.api.Guard.Builder
-
Configures the executor to use when offloading the guarded action to another thread.
- withThreadOffloadExecutor(Executor) - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder
-
Configures the executor to use when offloading the guarded action to another thread.
- withTimeout() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- withTimeout() - Method in interface io.smallrye.faulttolerance.api.Guard.Builder
-
Adds a timeout strategy.
- withTimeout() - Method in interface io.smallrye.faulttolerance.api.TypedGuard.Builder
-
Adds a timeout strategy.
All Classes and Interfaces|All Packages|Serialized Form
Guard.adaptCallable(Callable, Class)orGuard.adaptCallable(Callable, TypeLiteral)orTypedGuard.adaptCallable(Callable)