A B C D E F G H I J L M N O P Q R S V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- abortOn(Class<? extends Throwable>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Equivalent to
abortOn(Collections.singleton(value)). - abortOn(Collection<Class<? extends Throwable>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Sets the set of exception types considered success.
- adaptCallable(Callable<T>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Adapts given
actionto an action guarded by this configured set of fault tolerance strategies. - adaptRunnable(Runnable) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Adapts given
actionto an action guarded by this configured set of fault tolerance strategies. - adaptSupplier(Supplier<T>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Adapts given
actionto an action guarded by this configured set of fault tolerance strategies. - applies() - Method in interface io.smallrye.faulttolerance.api.FaultToleranceSpi
- ApplyFaultTolerance - Annotation Type in io.smallrye.faulttolerance.api
-
A special interceptor binding annotation to apply preconfigured fault tolerance.
- applyOn(Class<? extends Throwable>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.FallbackBuilder
-
Equivalent to
applyOn(Collections.singleton(value)). - applyOn(Collection<Class<? extends Throwable>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.FallbackBuilder
-
Sets the set of exception types considered failure.
B
- build() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder
-
Returns a ready-to-use instance of
FaultToleranceor guardedCallable, depending on how this builder was created.
C
- call(Callable<T>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Calls given
actionand guards the call by this configured set of fault tolerance strategies. - circuitBreakerMaintenance() - Static method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Returns a
CircuitBreakerMaintenanceinstance that provides maintenance access to existing circuit breakers. - circuitBreakerMaintenance() - Method in interface io.smallrye.faulttolerance.api.FaultToleranceSpi
- CircuitBreakerMaintenance - Interface in io.smallrye.faulttolerance.api
-
Allows reading and observing current state of circuit breakers and reseting 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 - io.smallrye.faulttolerance.api.CircuitBreakerState
- create() - Static method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Returns a builder that, at the end, returns a
FaultToleranceobject representing a set of configured fault tolerance strategies. - createAsync() - Static method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Returns a builder that, at the end, returns a
FaultToleranceobject representing a set of configured fault tolerance strategies. - createAsyncCallable(Callable<CompletionStage<T>>) - Static method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Returns a builder that, at the end, returns a
Callableguarding the givenaction. - createAsyncRunnable(Runnable) - Static method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Returns a builder that, at the end, returns a
Runnableguarding the givenaction. - createAsyncSupplier(Supplier<CompletionStage<T>>) - Static method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Returns a builder that, at the end, returns a
Supplierguarding the givenaction. - createCallable(Callable<T>) - Static method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Returns a builder that, at the end, returns a
Callableguarding the givenaction. - createRunnable(Runnable) - Static method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Returns a builder that, at the end, returns a
Runnableguarding the givenaction. - createSupplier(Supplier<T>) - Static method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Returns a builder that, at the end, returns a
Supplierguarding the givenaction. - 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
- delay(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Sets the delay after which an open circuit moves to half-open.
- delay(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Sets the delay between retries.
- done() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.BulkheadBuilder
-
Returns the original fault tolerance builder.
- done() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Returns the original fault tolerance builder.
- done() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.FallbackBuilder
-
Returns the original fault tolerance builder.
- done() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder.CustomBackoffBuilder
-
Returns the original retry builder.
- done() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Returns the original fault tolerance builder.
- done() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder.ExponentialBackoffBuilder
-
Returns the original retry builder.
- done() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder.FibonacciBackoffBuilder
-
Returns the original retry builder.
- done() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.TimeoutBuilder
-
Returns the original fault tolerance builder.
- duration(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.TimeoutBuilder
-
Sets the timeout duration.
E
- ExponentialBackoff - Annotation Type in io.smallrye.faulttolerance.api
-
Modifies a
@Retryannotation to use exponential backoff instead of the default constant backoff.
F
- factor() - Method 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
-
Sets the multiplicative factor used to determine delay between retries.
- failOn(Class<? extends Throwable>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Equivalent to
failOn(Collections.singleton(value)). - failOn(Collection<Class<? extends Throwable>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Sets the set of exception types considered failure.
- failureRatio(double) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.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
-
Allows guarding an action with various fault tolerance strategies: bulkhead, circuit breaker, fallback, retry, and timeout.
- FaultTolerance.Builder<T,R> - Interface in io.smallrye.faulttolerance.api
-
A builder for configuring fault tolerance strategies.
- FaultTolerance.Builder.BulkheadBuilder<T,R> - Interface in io.smallrye.faulttolerance.api
-
Configures a bulkhead.
- FaultTolerance.Builder.CircuitBreakerBuilder<T,R> - Interface in io.smallrye.faulttolerance.api
-
Configures a circuit breaker.
- FaultTolerance.Builder.FallbackBuilder<T,R> - Interface in io.smallrye.faulttolerance.api
-
Configures a fallback.
- FaultTolerance.Builder.RetryBuilder<T,R> - Interface in io.smallrye.faulttolerance.api
-
Configures a retry.
- FaultTolerance.Builder.RetryBuilder.CustomBackoffBuilder<T,R> - Interface in io.smallrye.faulttolerance.api
-
Configures a custom backoff for retry.
- FaultTolerance.Builder.RetryBuilder.ExponentialBackoffBuilder<T,R> - Interface in io.smallrye.faulttolerance.api
-
Configures an exponential backoff for retry.
- FaultTolerance.Builder.RetryBuilder.FibonacciBackoffBuilder<T,R> - Interface in io.smallrye.faulttolerance.api
-
Configures a Fibonacci backoff for retry.
- FaultTolerance.Builder.TimeoutBuilder<T,R> - Interface in io.smallrye.faulttolerance.api
-
Configures a timeout.
- FaultToleranceSpi - Interface in io.smallrye.faulttolerance.api
-
This is an internal API.
- FaultToleranceSpiAccess - Class in io.smallrye.faulttolerance.api
-
This is an internal API.
- FaultToleranceSpiAccess() - Constructor for class io.smallrye.faulttolerance.api.FaultToleranceSpiAccess
- FibonacciBackoff - Annotation Type in io.smallrye.faulttolerance.api
-
Modifies a
@Retryannotation to use Fibonacci backoff instead of the default constant backoff.
G
- get() - Static method in class io.smallrye.faulttolerance.api.FaultToleranceSpiAccess
- get(Supplier<T>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Calls given
actionand guards the call by this configured set of fault tolerance strategies.
H
- HALF_OPEN - io.smallrye.faulttolerance.api.CircuitBreakerState
- handler(Function<Throwable, T>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.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
-
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
-
Sets the jitter bound.
L
- limit(int) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.BulkheadBuilder
-
Sets the concurrency limit the bulkhead will enforce.
M
- maxDelay() - Method in annotation type io.smallrye.faulttolerance.api.ExponentialBackoff
-
The maximum delay between retries.
- maxDelay() - Method 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
-
Sets the maximum delay between retries.
- maxDelay(long, ChronoUnit) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder.FibonacciBackoffBuilder
-
Sets the maximum delay between retries.
- maxDelayUnit() - Method in annotation type io.smallrye.faulttolerance.api.ExponentialBackoff
-
The unit for
ExponentialBackoff.maxDelay(). - maxDelayUnit() - Method 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
-
Sets the maximum duration of all invocations, including possible retries.
- maxRetries(int) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Sets the maximum number of retries.
N
- name(String) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Sets a circuit breaker name.
- newAsyncBuilder(Class<?>, Function<FaultTolerance<T>, R>) - Method in interface io.smallrye.faulttolerance.api.FaultToleranceSpi
- newBuilder(Function<FaultTolerance<T>, R>) - Method in interface io.smallrye.faulttolerance.api.FaultToleranceSpi
- 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
-
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
-
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.FaultTolerance.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
-
Sets a callback that will be invoked when a finished invocation leaves this bulkhead.
- onFinished(Runnable) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.TimeoutBuilder
-
Sets a callback that will be invoked when an invocation finishes before the timeout.
- onPrevented(Runnable) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.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
-
Sets a callback that will be invoked when this bulkhead rejects an invocation.
- onRetry(Runnable) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.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
-
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
-
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.FaultTolerance.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
-
Sets a callback that will be invoked when an invocation times out.
- OPEN - io.smallrye.faulttolerance.api.CircuitBreakerState
P
- priority() - Method in interface io.smallrye.faulttolerance.api.FaultToleranceSpi
Q
- queueSize(int) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.BulkheadBuilder
-
Sets the maximum size of the bulkhead queue.
R
- requestVolumeThreshold(int) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.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.
- retryOn(Class<? extends Throwable>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Equivalent to
retryOn(Collections.singleton(value)). - retryOn(Collection<Class<? extends Throwable>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Sets the set of exception types considered failure.
- run(Runnable) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance
-
Calls given
actionand guards the call by this configured set of fault tolerance strategies.
S
- skipOn(Class<? extends Throwable>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Equivalent to
skipOn(Collections.singleton(value)). - skipOn(Class<? extends Throwable>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.FallbackBuilder
-
Equivalent to
skipOn(Collections.singleton(value)). - skipOn(Collection<Class<? extends Throwable>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
-
Sets the set of exception types considered success.
- skipOn(Collection<Class<? extends Throwable>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.FallbackBuilder
-
Sets the set of exception types considered success.
- strategy(Supplier<CustomBackoffStrategy>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.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
-
Sets the number of successful executions that, once reached, will move a half-open circuit breaker to closed.
V
- value() - Method in annotation type io.smallrye.faulttolerance.api.ApplyFaultTolerance
-
The identifier of a preconfigured fault tolerance instance.
- value() - Method in annotation type io.smallrye.faulttolerance.api.CircuitBreakerName
- value() - Method in annotation type io.smallrye.faulttolerance.api.CustomBackoff
-
Class of the custom backoff strategy that will be used to compute retry delays.
- valueOf(String) - Static method in enum io.smallrye.faulttolerance.api.CircuitBreakerState
-
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.
W
- when(Predicate<Throwable>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.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.FaultTolerance.Builder.FallbackBuilder
-
Sets a predicate to determine when an exception should be considered failure and fallback should be applied.
- when(Predicate<Throwable>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Sets a predicate to determine when an exception should be considered failure and retry should be attempted.
- with(Consumer<FaultTolerance.Builder.BulkheadBuilder<T, R>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.BulkheadBuilder
- with(Consumer<FaultTolerance.Builder.CircuitBreakerBuilder<T, R>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.CircuitBreakerBuilder
- with(Consumer<FaultTolerance.Builder.FallbackBuilder<T, R>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.FallbackBuilder
- with(Consumer<FaultTolerance.Builder.RetryBuilder.CustomBackoffBuilder<T, R>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder.CustomBackoffBuilder
- with(Consumer<FaultTolerance.Builder.RetryBuilder.ExponentialBackoffBuilder<T, R>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder.ExponentialBackoffBuilder
- with(Consumer<FaultTolerance.Builder.RetryBuilder.FibonacciBackoffBuilder<T, R>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder.FibonacciBackoffBuilder
- with(Consumer<FaultTolerance.Builder.RetryBuilder<T, R>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
- with(Consumer<FaultTolerance.Builder.TimeoutBuilder<T, R>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.TimeoutBuilder
- with(Consumer<FaultTolerance.Builder<T, R>>) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder
-
Syntactic sugar for calling the builder methods conditionally without breaking the invocation chain.
- withBulkhead() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder
-
Adds a bulkhead strategy.
- withCircuitBreaker() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder
-
Adds a circuit breaker strategy.
- withCustomBackoff() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.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
-
Assigns a description to the resulting set of configured fault tolerance strategies.
- withExponentialBackoff() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.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
-
Adds a fallback strategy.
- withFibonacciBackoff() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder.RetryBuilder
-
Configures retry to use a Fibonacci backoff instead of the default constant backoff.
- withRetry() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder
-
Adds a retry strategy.
- withThreadOffload(boolean) - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder
-
Configures whether the guarded action should be offloaded to another thread.
- withTimeout() - Method in interface io.smallrye.faulttolerance.api.FaultTolerance.Builder
-
Adds a timeout strategy.
All Classes All Packages