com.sap.cloud.sdk.cloudplatform.resilience

Class ResilienceDecorator

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()

Method Summary

Modifier and Type	Method and Description
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> Callable<T>	decorateFutureSupplier(Supplier<Future<T>> futureSupplier, ResilienceConfiguration configuration) Deprecated. Not for public use. This method is expected to be temporarily retained only as a package private method. Instead use decorateCallable(Callable, ResilienceConfiguration) or decorateSupplier(Supplier, ResilienceConfiguration), depending on the expected error handling. Also consider the sibling methods featuring a fallback routine.
static <T> Callable<T>	decorateFutureSupplier(Supplier<Future<T>> futureSupplier, ResilienceConfiguration configuration, Function<? super Throwable,T> fallbackFunction) Deprecated. Not for public use. This method is expected to be temporarily retained only as a package private method. Instead use decorateCallable(Callable, ResilienceConfiguration) or decorateSupplier(Supplier, ResilienceConfiguration), depending on the expected error handling. Also consider the sibling methods featuring a fallback routine.
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	executeFutureSupplier(Supplier<Future<T>> futureSupplier, ResilienceConfiguration configuration) Deprecated. Not for public use. This method is expected to be temporarily retained only as a package private method. Instead use executeCallable(Callable, ResilienceConfiguration) or executeSupplier(Supplier, ResilienceConfiguration), depending on the expected error handling. Also consider the sibling methods featuring a fallback routine.
static <T> T	executeFutureSupplier(Supplier<Future<T>> futureSupplier, ResilienceConfiguration configuration, Function<? super Throwable,T> fallbackFunction) Deprecated. Not for public use. This method is expected to be temporarily retained only as a package private method. Instead use executeCallable(Callable, ResilienceConfiguration) or executeSupplier(Supplier, ResilienceConfiguration), depending on the expected error handling. Also consider the sibling methods featuring a fallback routine.
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 <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.

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.

Returns:

The value returned by the callable.

decorateFutureSupplier

@Nonnull
 @Deprecated
public static <T> Callable<T> decorateFutureSupplier(@Nonnull
                                                                           Supplier<Future<T>> futureSupplier,
                                                                           @Nonnull
                                                                           ResilienceConfiguration configuration)

Deprecated. Not for public use. This method is expected to be temporarily retained only as a package private method. Instead use decorateCallable(Callable, ResilienceConfiguration) or decorateSupplier(Supplier, ResilienceConfiguration), depending on the expected error handling. Also consider the sibling methods featuring a fallback routine.

Decorate a supplier for a future.

Type Parameters:

T - The return type of the call.

Parameters:

futureSupplier - The supplier of a future.

configuration - The configuration of the resilient call.

Returns:

A decorated callable.

executeFutureSupplier

@Nullable
 @Deprecated
public static <T> T executeFutureSupplier(@Nonnull
                                                                 Supplier<Future<T>> futureSupplier,
                                                                 @Nonnull
                                                                 ResilienceConfiguration configuration)
                                                          throws Exception

Deprecated. Not for public use. This method is expected to be temporarily retained only as a package private method. Instead use executeCallable(Callable, ResilienceConfiguration) or executeSupplier(Supplier, ResilienceConfiguration), depending on the expected error handling. Also consider the sibling methods featuring a fallback routine.

Decorate and execute a supplier for a future.

Type Parameters:

T - The return type of the call.

Parameters:

futureSupplier - The supplier of a future.

configuration - The configuration of the resilient call.

Returns:

The value returned by the callable.

Throws:

Exception

decorateFutureSupplier

@Nonnull
 @Deprecated
public static <T> Callable<T> decorateFutureSupplier(@Nonnull
                                                                           Supplier<Future<T>> futureSupplier,
                                                                           @Nonnull
                                                                           ResilienceConfiguration configuration,
                                                                           @Nullable
                                                                           Function<? super Throwable,T> fallbackFunction)

Deprecated. Not for public use. This method is expected to be temporarily retained only as a package private method. Instead use decorateCallable(Callable, ResilienceConfiguration) or decorateSupplier(Supplier, ResilienceConfiguration), depending on the expected error handling. Also consider the sibling methods featuring a fallback routine.

Decorate a supplier for a future.

Type Parameters:

T - The return type of the call.

Parameters:

futureSupplier - The supplier of a future.

configuration - The configuration of the resilient call.

fallbackFunction - In case of failure, execute this function.

Returns:

A decorated callable.

executeFutureSupplier

@Nullable
 @Deprecated
public static <T> T executeFutureSupplier(@Nonnull
                                                                 Supplier<Future<T>> futureSupplier,
                                                                 @Nonnull
                                                                 ResilienceConfiguration configuration,
                                                                 @Nullable
                                                                 Function<? super Throwable,T> fallbackFunction)

Deprecated. Not for public use. This method is expected to be temporarily retained only as a package private method. Instead use executeCallable(Callable, ResilienceConfiguration) or executeSupplier(Supplier, ResilienceConfiguration), depending on the expected error handling. Also consider the sibling methods featuring a fallback routine.

Decorate and execute a supplier for a future.

Type Parameters:

T - The return type of the call.

Parameters:

futureSupplier - The supplier of a future.

configuration - The configuration of the resilient call.

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