Resilience4j 2.3.0 · io.github.resilience4j.circuitbreaker.CircuitBreakerConfig

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	CircuitBreakerConfig.Builder
public static enum	CircuitBreakerConfig.SlidingWindowSynchronizationStrategy
public static enum	CircuitBreakerConfig.SlidingWindowType
public static class	CircuitBreakerConfig.TransitionCheckResult Result of the `getTransitionOnResult()` function with which one can tell the circuit breaker to transition to a different state if the result of a call meet the desired criteria.

Field Summary

Modifier and Type	Field and Description
private boolean	automaticTransitionFromOpenToHalfOpenEnabled
private transient Clock	clock
private transient Function<Clock, Long>	currentTimestampFunction
private static final Clock	DEFAULT_CLOCK
public static final int	DEFAULT_FAILURE_RATE_THRESHOLD
private static final Predicate<Throwable>	DEFAULT_IGNORE_EXCEPTION_PREDICATE
public static final int	DEFAULT_MINIMUM_NUMBER_OF_CALLS
public static final int	DEFAULT_PERMITTED_CALLS_IN_HALF_OPEN_STATE
private static final Predicate<Throwable>	DEFAULT_RECORD_EXCEPTION_PREDICATE
private static final Predicate<Object>	DEFAULT_RECORD_RESULT_PREDICATE
public static final int	DEFAULT_SLIDING_WINDOW_SIZE
public static final CircuitBreakerConfig.SlidingWindowSynchronizationStrategy	DEFAULT_SLIDING_WINDOW_SYNCHRONIZATION_STRATEGY
public static final CircuitBreakerConfig.SlidingWindowType	DEFAULT_SLIDING_WINDOW_TYPE
public static final int	DEFAULT_SLOW_CALL_DURATION_THRESHOLD
public static final int	DEFAULT_SLOW_CALL_RATE_THRESHOLD
private static final Function<Clock, Long>	DEFAULT_TIMESTAMP_FUNCTION
private static final TimeUnit	DEFAULT_TIMESTAMP_UNIT
private static final Function<Either<Object, Throwable>, CircuitBreakerConfig.TransitionCheckResult>	DEFAULT_TRANSITION_ON_RESULT
public static final int	DEFAULT_WAIT_DURATION_IN_HALF_OPEN_STATE
public static final int	DEFAULT_WAIT_DURATION_IN_OPEN_STATE
public static final boolean	DEFAULT_WRITABLE_STACK_TRACE_ENABLED
private float	failureRateThreshold
private transient Predicate<Throwable>	ignoreExceptionPredicate
private Class<? extends Throwable>[]	ignoreExceptions
private Duration	maxWaitDurationInHalfOpenState
private int	minimumNumberOfCalls
private int	permittedNumberOfCallsInHalfOpenState
private transient Predicate<Throwable>	recordExceptionPredicate
private Class<? extends Throwable>[]	recordExceptions
private transient Predicate<Object>	recordResultPredicate
private static final long	serialVersionUID
private int	slidingWindowSize
private CircuitBreakerConfig.SlidingWindowSynchronizationStrategy	slidingWindowSynchronizationStrategy
private CircuitBreakerConfig.SlidingWindowType	slidingWindowType
private Duration	slowCallDurationThreshold
private float	slowCallRateThreshold
private TimeUnit	timestampUnit
private transient Function<Either<Object, Throwable>, CircuitBreakerConfig.TransitionCheckResult>	transitionOnResult
private transient IntervalFunction	waitIntervalFunctionInOpenState
private boolean	writableStackTraceEnabled

Access	Constructor and Description
private	CircuitBreakerConfig()

Access

Constructor and Description

private

CircuitBreakerConfig()

Modifier and Type	Method and Description
public static CircuitBreakerConfig.Builder	Returns: a `Builder` custom() Returns a builder to create a custom CircuitBreakerConfig.
public static CircuitBreakerConfig.Builder	Returns: a `Builder` from(CircuitBreakerConfig baseConfig) Returns a builder to create a custom CircuitBreakerConfig based on another CircuitBreakerConfig.
public Clock	getClock()
public Function<Clock, Long>	getCurrentTimestampFunction()
public float	getFailureRateThreshold()
public Predicate<Throwable>	getIgnoreExceptionPredicate()
public Duration	getMaxWaitDurationInHalfOpenState()
public int	getMinimumNumberOfCalls()
public int	getPermittedNumberOfCallsInHalfOpenState()
public Predicate<Throwable>	getRecordExceptionPredicate()
public Predicate<Object>	getRecordResultPredicate()
public int	getSlidingWindowSize()
public CircuitBreakerConfig.SlidingWindowSynchronizationStrategy	getSlidingWindowSynchronizationStrategy()
public CircuitBreakerConfig.SlidingWindowType	getSlidingWindowType()
public Duration	getSlowCallDurationThreshold()
public float	getSlowCallRateThreshold()
public TimeUnit	getTimestampUnit()
public Function<Either<Object, Throwable>, CircuitBreakerConfig.TransitionCheckResult>	getTransitionOnResult()
public IntervalFunction	Returns: the CircuitBreakerConfig.Builder getWaitIntervalFunctionInOpenState() Returns an interval function which controls how long the CircuitBreaker should stay open, before it switches to half open.
public boolean	isAutomaticTransitionFromOpenToHalfOpenEnabled()
public boolean	isWritableStackTraceEnabled()
public static CircuitBreakerConfig	Returns: a default CircuitBreaker configuration. ofDefaults() Creates a default CircuitBreaker configuration.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Modifier and Type

Method and Description

public static CircuitBreakerConfig.Builder

Returns:

a Builder

custom()

Returns a builder to create a custom CircuitBreakerConfig.

public static CircuitBreakerConfig.Builder

Returns:

a Builder

from(CircuitBreakerConfig baseConfig)

Returns a builder to create a custom CircuitBreakerConfig based on another CircuitBreakerConfig.