ResilienceDecorationStrategy (SAP Cloud SDK

All Known Implementing Classes:

NoResilienceDecorationStrategy, Resilience4jDecorationStrategy
```
public interface ResilienceDecorationStrategy
```
Generic interface to decorate functions with non-functional requirements.

Field Summary

Fields
Modifier and Type	Field and Description
`static ExecutorService`	`DEFAULT_EXECUTOR_SERVICE` The default executor service to manage queued Callables and Suppliers.
`static ThreadFactory`	`DEFAULT_THREAD_FACTORY` The default thread factory instance.
`static String`	`DEFAULT_THREAD_NAME_FORMAT` The default thread name format.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default <T> Callable<T>`	`decorateCallable(Callable<T> callable, ResilienceConfiguration configuration)` Decorate an instance of a callable function.
`<T> Callable<T>`	`decorateCallable(Callable<T> callable, ResilienceConfiguration configuration, Function<? super Throwable,T> fallbackFunction)` Decorate an instance of a callable function.
`default <T> Supplier<T>`	`decorateSupplier(Supplier<T> supplier, ResilienceConfiguration configuration)` Decorate an instance of a supplier function.
`<T> Supplier<T>`	`decorateSupplier(Supplier<T> supplier, ResilienceConfiguration configuration, Function<? super Throwable,T> fallbackFunction)` Decorate an instance of a supplier function.
`default <T> T`	`executeCallable(Callable<T> callable, ResilienceConfiguration configuration)` Decorate and execute an instance of a callable function.
`default <T> T`	`executeCallable(Callable<T> callable, ResilienceConfiguration configuration, Function<? super Throwable,T> fallbackFunction)` Decorate and execute an instance of a callable function.
`default <T> T`	`executeSupplier(Supplier<T> supplier, ResilienceConfiguration configuration)` Decorate and execute an instance of a supplier function.
`default <T> T`	`executeSupplier(Supplier<T> supplier, ResilienceConfiguration configuration, Function<? super Throwable,T> fallbackFunction)` Decorate and execute an instance of a supplier function.
`default void`	`invalidateCache(ResilienceConfiguration configuration)` Clears the cache associated with the given `ResilienceConfiguration` if any exists.
`default <T> CompletableFuture<T>`	`queueCallable(Callable<T> callable, ResilienceConfiguration configuration, Function<? super Throwable,T> fallbackFunction, Executor executor)` Decorate an instance of a callable function.
`default <T> CompletableFuture<T>`	`queueSupplier(Supplier<T> supplier, ResilienceConfiguration configuration, Function<? super Throwable,T> fallbackFunction, Executor executor)` Decorate an instance of a supplier function.

Field Detail
- DEFAULT_THREAD_NAME_FORMAT
```
static final String DEFAULT_THREAD_NAME_FORMAT
```
  The default thread name format.
  
  See Also:
  
  Constant Field Values
- DEFAULT_THREAD_FACTORY
```
static final ThreadFactory DEFAULT_THREAD_FACTORY
```
  The default thread factory instance.
- DEFAULT_EXECUTOR_SERVICE
```
static final ExecutorService DEFAULT_EXECUTOR_SERVICE
```
  The default executor service to manage queued Callables and Suppliers.

Method Detail

invalidateCache
```
default void invalidateCache(@Nonnull
                             ResilienceConfiguration configuration)
```
Clears the cache associated with the given ResilienceConfiguration if any exists. Be aware that the cache will be cleared for all tenants and principals.

Parameters:

configuration - The ResilienceConfiguration the cache is attached to.

decorateSupplier

@Nonnull
default <T> Supplier<T> decorateSupplier(@Nonnull
                                                  Supplier<T> supplier,
                                                  @Nonnull
                                                  ResilienceConfiguration configuration)

Decorate an instance of a supplier function.

Type Parameters:: T - The return type of the call.
Parameters:: supplier - The supplier.; configuration - The configuration of the resilient call.
Returns:: A decorated supplier.

executeSupplier

@Nullable
default <T> T executeSupplier(@Nonnull
                                        Supplier<T> supplier,
                                        @Nonnull
                                        ResilienceConfiguration configuration)

Decorate and execute an instance of a supplier function.

Type Parameters:: T - The return type of the call.
Parameters:: supplier - The supplier.; configuration - The configuration of the resilient call.
Returns:: The value of the supplier.

decorateSupplier

@Nonnull
<T> Supplier<T> decorateSupplier(@Nonnull
                                          Supplier<T> supplier,
                                          @Nonnull
                                          ResilienceConfiguration configuration,
                                          @Nullable
                                          Function<? super Throwable,T> fallbackFunction)

Decorate an instance of a supplier function.

Type Parameters:: T - The return type of the call.
Parameters:: supplier - The supplier.; configuration - The configuration of the resilient call.; fallbackFunction - In case of failure, execute this function.
Returns:: A decorated supplier.

executeSupplier

@Nullable
default <T> T executeSupplier(@Nonnull
                                        Supplier<T> supplier,
                                        @Nonnull
                                        ResilienceConfiguration configuration,
                                        @Nullable
                                        Function<? super Throwable,T> fallbackFunction)

Decorate and execute an instance of a supplier function.

Type Parameters:: T - The return type of the call.
Parameters:: supplier - The supplier.; configuration - The configuration of the resilient call.; fallbackFunction - In case of failure, execute this function.
Returns:: The value of the supplier.

decorateCallable

@Nonnull
default <T> Callable<T> decorateCallable(@Nonnull
                                                  Callable<T> callable,
                                                  @Nonnull
                                                  ResilienceConfiguration configuration)

Decorate an instance of a callable function.

Type Parameters:: T - The return type of the call.
Parameters:: callable - The callable.; configuration - The configuration of the resilient call.
Returns:: A decorated callable.

executeCallable

@Nullable
default <T> T executeCallable(@Nonnull
                                        Callable<T> callable,
                                        @Nonnull
                                        ResilienceConfiguration configuration)
                                 throws Exception

Decorate and execute an instance of a callable function.

Type Parameters:: T - The return type of the call.
Parameters:: callable - The callable.; configuration - The configuration of the resilient call.
Returns:: The value returned by the callable.
Throws:: Exception - Exception that can be thrown by the callable.

decorateCallable

@Nonnull
<T> Callable<T> decorateCallable(@Nonnull
                                          Callable<T> callable,
                                          @Nonnull
                                          ResilienceConfiguration configuration,
                                          @Nullable
                                          Function<? super Throwable,T> fallbackFunction)

Decorate an instance of a callable function.

Type Parameters:: T - The return type of the call.
Parameters:: callable - The callable.; configuration - The configuration of the resilient call.; fallbackFunction - In case of failure, execute this function.
Returns:: A decorated callable.

executeCallable

@Nullable
default <T> T executeCallable(@Nonnull
                                        Callable<T> callable,
                                        @Nonnull
                                        ResilienceConfiguration configuration,
                                        @Nullable
                                        Function<? super Throwable,T> fallbackFunction)

Decorate and execute an instance of a callable function. This method assumes that fallbackFunction handles any exceptions thrown by callable, and fallbackFunction does not throw any exceptions itself. If fallbackFunction throws any exception, then it will be wrapped in a ResilienceRuntimeException.

Type Parameters:: T - The return type of the call.
Parameters:: callable - The callable.; configuration - The configuration of the resilient call.; fallbackFunction - (Optional) In case of failure, execute this function.
Returns:: The value returned by the callable.

queueCallable

@Nonnull
default <T> CompletableFuture<T> queueCallable(@Nonnull
                                                        Callable<T> callable,
                                                        @Nonnull
                                                        ResilienceConfiguration configuration,
                                                        @Nullable
                                                        Function<? super Throwable,T> fallbackFunction,
                                                        @Nullable
                                                        Executor executor)

Decorate an instance of a callable function. Automatically schedule the asynchronous execution.

Type Parameters:: T - The return type of the call.
Parameters:: callable - The callable.; configuration - The configuration of the resilient call.; fallbackFunction - (Optional) In case of failure, execute this function.; executor - (Optional) The thread executor to schedule the asynchronous operation with.
Returns:: An instance of Future being executed asynchronously with the provided (or default) executor.

queueSupplier

@Nonnull
default <T> CompletableFuture<T> queueSupplier(@Nonnull
                                                        Supplier<T> supplier,
                                                        @Nonnull
                                                        ResilienceConfiguration configuration,
                                                        @Nullable
                                                        Function<? super Throwable,T> fallbackFunction,
                                                        @Nullable
                                                        Executor executor)

Decorate an instance of a supplier function. Automatically schedule the asynchronous execution.

Type Parameters:: T - The return type of the call.
Parameters:: supplier - The supplier.; configuration - The configuration of the resilient call.; fallbackFunction - (Optional) In case of failure, execute this function.; executor - (Optional) The thread executor to schedule the asynchronous operation with.
Returns:: An instance of Future being executed asynchronously with the provided (or default) executor.

Interface ResilienceDecorationStrategy

Field Summary

Method Summary

Field Detail

DEFAULT_THREAD_NAME_FORMAT

DEFAULT_THREAD_FACTORY

DEFAULT_EXECUTOR_SERVICE

Method Detail

invalidateCache

decorateSupplier

executeSupplier

decorateSupplier

executeSupplier

decorateCallable

executeCallable

decorateCallable

executeCallable

queueCallable

queueSupplier