ResilienceDecorationStrategy (Cloud Platform

All Known Implementing Classes:

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

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`clearAllCacheEntries(ResilienceConfiguration configuration)` Clears the entire cache associated with the given `ResilienceConfiguration` if any exists, independent of the specified `ResilienceIsolationMode` and defined parameters.
`default void`	`clearCache(ResilienceConfiguration configuration)` Clears the cache associated with the given `ResilienceConfiguration` if any exists.
`default void`	`clearCache(ResilienceConfiguration configuration, CacheFilter filter)` Clears the cache associated with the given `ResilienceConfiguration` by respecting the provided `CacheFilter`.
`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 <T> CompletableFuture<T>`	`queueCallable(Callable<T> callable, ResilienceConfiguration configuration, Function<? super Throwable,T> fallbackFunction)` Decorate an instance of a callable function.
`default <T> CompletableFuture<T>`	`queueSupplier(Supplier<T> supplier, ResilienceConfiguration configuration, Function<? super Throwable,T> fallbackFunction)` Decorate an instance of a supplier function.

Method Detail

clearCache
```
default void clearCache(@Nonnull
                        ResilienceConfiguration configuration)
```
Clears the cache associated with the given ResilienceConfiguration if any exists. This method respects tenant/principal isolation according to the ResilienceIsolationMode as well as parameter isolation.
To clear all cache entries for all tenants, principals, and parameters, clearAllCacheEntries(ResilienceConfiguration) can be used instead.

Parameters:

configuration - The ResilienceConfiguration the cache is attached to.

clearCache
```
default void clearCache(@Nonnull
                        ResilienceConfiguration configuration,
                        @Nonnull
                        CacheFilter filter)
```
Clears the cache associated with the given ResilienceConfiguration by respecting the provided CacheFilter.

Parameters:

configuration - The ResilienceConfiguration the cache is attached to.

filter - A CacheFilter to apply in order to select entries that should be cleared from the cache.

clearAllCacheEntries
```
default void clearAllCacheEntries(@Nonnull
                                  ResilienceConfiguration configuration)
```
Clears the entire cache associated with the given ResilienceConfiguration if any exists, independent of the specified ResilienceIsolationMode and defined parameters. Be aware that this operation affects all tenants and principals.
Use clearCache(ResilienceConfiguration) to respect the tenant/principal and parameter isolation.

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)

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.
Returns:: An instance of Future being executed asynchronously with the static ThreadContextExecutors executor.

queueSupplier

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

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.
Returns:: An instance of Future being executed asynchronously with the static ThreadContextExecutors executor.

Interface ResilienceDecorationStrategy

Method Summary

Method Detail

clearCache

clearCache

clearAllCacheEntries

decorateSupplier

executeSupplier

decorateSupplier

executeSupplier

decorateCallable

executeCallable

decorateCallable

executeCallable

queueCallable

queueSupplier