ResilienceDecorator (SAP Cloud SDK - Parent POM 3.38.0 API)

java.lang.Object
- com.sap.cloud.sdk.cloudplatform.resilience.ResilienceDecorator

```
public final class ResilienceDecorator
extends Object
```
Accessor class for decorating functions with resilient properties.

Constructor Summary

Constructors
Constructor and Description

ResilienceDecorator()

Constructors
Constructor and Description
`ResilienceDecorator()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`clearAllCacheEntries(ResilienceConfiguration configuration)` Clears the entire cache associated with the given `ResilienceConfiguration` if any exists, independent of the specified `ResilienceIsolationMode` and defined parameters.
`static void`	`clearCache(ResilienceConfiguration configuration)` Clears the cache associated with the given `ResilienceConfiguration` if any exists.
`static <T> Callable<T>`	`decorateCallable(Callable<T> callable, ResilienceConfiguration configuration)` Decorate an instance of a callable function.
`static <T> Callable<T>`	`decorateCallable(Callable<T> callable, ResilienceConfiguration configuration, Function<? super Throwable,T> fallbackFunction)` Decorate an instance of a callable function.
`static <T> Supplier<T>`	`decorateSupplier(Supplier<T> supplier, ResilienceConfiguration configuration)` Decorate an instance of a supplier function.
`static <T> Supplier<T>`	`decorateSupplier(Supplier<T> supplier, ResilienceConfiguration configuration, Function<? super Throwable,T> fallbackFunction)` Decorate an instance of a supplier function.
`static <T> T`	`executeCallable(Callable<T> callable, ResilienceConfiguration configuration)` Decorate and execute an instance of a callable function.
`static <T> T`	`executeCallable(Callable<T> callable, ResilienceConfiguration configuration, Function<? super Throwable,T> fallbackFunction)` Decorate and execute an instance of a callable function.
`static <T> T`	`executeSupplier(Supplier<T> supplier, ResilienceConfiguration configuration)` Decorate and execute an instance of a supplier function.
`static <T> T`	`executeSupplier(Supplier<T> supplier, ResilienceConfiguration configuration, Function<? super Throwable,T> fallbackFunction)` Decorate and execute an instance of a supplier function.
`static ResilienceDecorationStrategy`	`getDecorationStrategy()` The current instance of `ResilienceDecorationStrategy` to be used to guarantee resilient function properties.
`static void`	`invalidateCache(ResilienceConfiguration configuration)` Deprecated. Please use `clearAllCacheEntries(ResilienceConfiguration)` to clear all cache entries for all tenants and principals. You may also use `clearCache(ResilienceConfiguration)` to clear the cache with respect to tenant/principal isolation.
`static <T> CompletableFuture<T>`	`queueCallable(Callable<T> callable, ResilienceConfiguration configuration)` Decorate an instance of a callable function.
`static <T> CompletableFuture<T>`	`queueCallable(Callable<T> callable, ResilienceConfiguration configuration, Function<? super Throwable,T> fallbackFunction)` Decorate an instance of a callable function.
`static <T> CompletableFuture<T>`	`queueSupplier(Supplier<T> supplier, ResilienceConfiguration configuration)` Decorate an instance of a supplier function.
`static <T> CompletableFuture<T>`	`queueSupplier(Supplier<T> supplier, ResilienceConfiguration configuration, Function<? super Throwable,T> fallbackFunction)` Decorate an instance of a supplier function.
`static void`	`resetDecorationStrategy()` Resets the decoration strategy to its default.
`static void`	`setDecorationStrategy(ResilienceDecorationStrategy decorationStrategy)` The current instance of `ResilienceDecorationStrategy` to be used to guarantee resilient function properties.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ResilienceDecorator
```
public ResilienceDecorator()
```

Method Detail

resetDecorationStrategy
```
public static void resetDecorationStrategy()
```
Resets the decoration strategy to its default.

invalidateCache
```
@Deprecated
public static void invalidateCache(@Nonnull
                                               ResilienceConfiguration configuration)
```
Deprecated. Please use clearAllCacheEntries(ResilienceConfiguration) to clear all cache entries for all tenants and principals. You may also use clearCache(ResilienceConfiguration) to clear the cache with respect to tenant/principal isolation.

Resets 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.

clearCache
```
@Beta
public static 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, use clearAllCacheEntries(ResilienceConfiguration) instead.

Parameters:

configuration - The ResilienceConfiguration the cache is attached to.

clearAllCacheEntries
```
public static 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
public static <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
public static <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
public static <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
public static <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
public static <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
public static <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
public static <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
public static <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.

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
public static <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.

queueCallable

@Nonnull
public static <T> CompletableFuture<T> queueCallable(@Nonnull
                                                              Callable<T> callable,
                                                              @Nonnull
                                                              ResilienceConfiguration configuration)

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.
Returns:: An instance of Future being executed asynchronously.

queueSupplier

@Nonnull
public static <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.

queueSupplier

@Nonnull
public static <T> CompletableFuture<T> queueSupplier(@Nonnull
                                                              Supplier<T> supplier,
                                                              @Nonnull
                                                              ResilienceConfiguration configuration)

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.
Returns:: An instance of Future being executed asynchronously.

getDecorationStrategy
```
@Nonnull
public static ResilienceDecorationStrategy getDecorationStrategy()
```
The current instance of ResilienceDecorationStrategy to be used to guarantee resilient function properties.

setDecorationStrategy

public static void setDecorationStrategy(@Nonnull
                                         ResilienceDecorationStrategy decorationStrategy)

The current instance of ResilienceDecorationStrategy to be used to guarantee resilient function properties.

Class ResilienceDecorator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ResilienceDecorator

Method Detail

resetDecorationStrategy

invalidateCache

clearCache

clearAllCacheEntries

decorateSupplier

executeSupplier

decorateSupplier

executeSupplier

decorateCallable

executeCallable

decorateCallable

executeCallable

queueCallable

queueCallable

queueSupplier

queueSupplier

getDecorationStrategy

setDecorationStrategy