Package com.sap.cloud.sdk.cloudplatform.resilience

Class ResilienceConfiguration

java.lang.Object

com.sap.cloud.sdk.cloudplatform.resilience.ResilienceConfiguration

public class ResilienceConfiguration
extends Object

This type provides options to configure the resilience function decoration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ResilienceConfiguration.BulkheadConfiguration	Provides options specific to bulkheads.
static final class	ResilienceConfiguration.CacheConfiguration	Provides options specific to caching.
static final class	ResilienceConfiguration.CircuitBreakerConfiguration	Provides options specific to circuit breakers.
static final class	ResilienceConfiguration.RateLimiterConfiguration	Provides options specific to rate limits.
static final class	ResilienceConfiguration.RetryConfiguration	Provides options specific to retries, which will reattempt failed requests a limited amount of times.
static final class	ResilienceConfiguration.TimeLimiterConfiguration	Provides options specific to timeouts.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ResilienceConfiguration(String identifier)	Constructor for resilience configuration.

Method Summary

Modifier and Type	Method	Description
ResilienceConfiguration.BulkheadConfiguration	bulkheadConfiguration()
ResilienceConfiguration	bulkheadConfiguration(ResilienceConfiguration.BulkheadConfiguration bulkheadConfiguration)
ResilienceConfiguration.CacheConfiguration	cacheConfiguration()
ResilienceConfiguration	cacheConfiguration(ResilienceConfiguration.CacheConfiguration cacheConfiguration)
protected boolean	canEqual(Object other)
ResilienceConfiguration.CircuitBreakerConfiguration	circuitBreakerConfiguration()
ResilienceConfiguration	circuitBreakerConfiguration(ResilienceConfiguration.CircuitBreakerConfiguration circuitBreakerConfiguration)
static ResilienceConfiguration	empty(Class<?> serviceClass)	Factory function to create a resilience configuration with all resilience features disabled by default.
static ResilienceConfiguration	empty(String identifier)	Factory function to create a resilience configuration with all resilience features disabled by default.
boolean	equals(Object o)
int	hashCode()
String	identifier()
ResilienceIsolationMode	isolationMode()
ResilienceConfiguration	isolationMode(ResilienceIsolationMode isolationMode)
static ResilienceConfiguration	of(Class<?> serviceClass)	Factory function to create a resilience configuration with only a subset of resilience features enabled by default.
static ResilienceConfiguration	of(String identifier)	Factory function to create a resilience configuration with default values for the given identifier.
ResilienceConfiguration.RateLimiterConfiguration	rateLimiterConfiguration()
ResilienceConfiguration	rateLimiterConfiguration(ResilienceConfiguration.RateLimiterConfiguration rateLimiterConfiguration)
ResilienceConfiguration.RetryConfiguration	retryConfiguration()
ResilienceConfiguration	retryConfiguration(ResilienceConfiguration.RetryConfiguration retryConfiguration)
ResilienceConfiguration.TimeLimiterConfiguration	timeLimiterConfiguration()
ResilienceConfiguration	timeLimiterConfiguration(ResilienceConfiguration.TimeLimiterConfiguration timeLimiterConfiguration)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ResilienceConfiguration

protected ResilienceConfiguration(@Nonnull
 String identifier)

Constructor for resilience configuration.

Parameters:

identifier - A unique identifier for this configuration.

Method Details

of

@Nonnull
public static ResilienceConfiguration of(@Nonnull
 String identifier)

Factory function to create a resilience configuration with default values for the given identifier.

By default the following resilience features are active with default values:

Timeouts	Enabled
Circuit Breaker	Enabled
Bulkhead	Enabled
Caching	Disabled
Retries	Disabled
Rate Limiter	Disabled

Parameters:

identifier - A unique identifier for this configuration.

Returns:

A resilience configuration.

of

@Nonnull
public static ResilienceConfiguration of(@Nonnull
 Class<?> serviceClass)

Factory function to create a resilience configuration with only a subset of resilience features enabled by default.

By default the following resilience features are active with default values:

Timeouts	Enabled
Circuit Breaker	Enabled
Bulkhead	Enabled
Caching	Disabled
Retries	Disabled
Rate Limiter	Disabled

Parameters:

serviceClass - The invoking caller class.

Returns:

An new instance of resilience configuration.

empty

@Nonnull
public static ResilienceConfiguration empty(@Nonnull
 String identifier)

Factory function to create a resilience configuration with all resilience features disabled by default. Enable them explicitly through the setters to only add the functionality that is needed.

Parameters:

identifier - A unique identifier for this configuration.

Returns:

An empty resilience configuration.

empty

@Nonnull
public static ResilienceConfiguration empty(@Nonnull
 Class<?> serviceClass)

Factory function to create a resilience configuration with all resilience features disabled by default. Enable them explicitly through the setters to only add the functionality that is needed.

Parameters:

serviceClass - The invoking caller class.

Returns:

An empty resilience configuration.

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(@Nullable
 Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

identifier

@Nonnull
public String identifier()

isolationMode

@Nonnull
public ResilienceIsolationMode isolationMode()

timeLimiterConfiguration

@Nonnull
public ResilienceConfiguration.TimeLimiterConfiguration timeLimiterConfiguration()

circuitBreakerConfiguration

@Nonnull
public ResilienceConfiguration.CircuitBreakerConfiguration circuitBreakerConfiguration()

bulkheadConfiguration

@Nonnull
public ResilienceConfiguration.BulkheadConfiguration bulkheadConfiguration()

cacheConfiguration

@Nonnull
public ResilienceConfiguration.CacheConfiguration cacheConfiguration()

retryConfiguration

@Nonnull
public ResilienceConfiguration.RetryConfiguration retryConfiguration()

rateLimiterConfiguration

@Nonnull
public ResilienceConfiguration.RateLimiterConfiguration rateLimiterConfiguration()

isolationMode

@Nonnull
public ResilienceConfiguration isolationMode(@Nonnull
 ResilienceIsolationMode isolationMode)

Returns:

this.

timeLimiterConfiguration

@Nonnull
public ResilienceConfiguration timeLimiterConfiguration(@Nonnull
 ResilienceConfiguration.TimeLimiterConfiguration timeLimiterConfiguration)

Returns:

this.

circuitBreakerConfiguration

@Nonnull
public ResilienceConfiguration circuitBreakerConfiguration(@Nonnull
 ResilienceConfiguration.CircuitBreakerConfiguration circuitBreakerConfiguration)

Returns:

this.

bulkheadConfiguration

@Nonnull
public ResilienceConfiguration bulkheadConfiguration(@Nonnull
 ResilienceConfiguration.BulkheadConfiguration bulkheadConfiguration)

Returns:

this.

cacheConfiguration

@Nonnull
public ResilienceConfiguration cacheConfiguration(@Nonnull
 ResilienceConfiguration.CacheConfiguration cacheConfiguration)

Returns:

this.

retryConfiguration

@Nonnull
public ResilienceConfiguration retryConfiguration(@Nonnull
 ResilienceConfiguration.RetryConfiguration retryConfiguration)

Returns:

this.

rateLimiterConfiguration

@Nonnull
public ResilienceConfiguration rateLimiterConfiguration(@Nonnull
 ResilienceConfiguration.RateLimiterConfiguration rateLimiterConfiguration)

Returns:

this.