Class CircuitBreakerConfig<R>

java.lang.Object

dev.failsafe.PolicyConfig<R>

dev.failsafe.FailurePolicyConfig<R>

dev.failsafe.DelayablePolicyConfig<R>

dev.failsafe.CircuitBreakerConfig<R>

Type Parameters:

R - result type

public class CircuitBreakerConfig<R>
extends DelayablePolicyConfig<R>

Configuration for a CircuitBreaker.

This class is threadsafe.

See Also:

• CircuitBreakerBuilder

Field Summary

Fields

Modifier and Type	Field	Description
(package private) EventListener<CircuitBreakerStateChangedEvent>	closeListener
(package private) int	failureExecutionThreshold
(package private) int	failureRateThreshold
(package private) int	failureThreshold
(package private) int	failureThresholdingCapacity
(package private) Duration	failureThresholdingPeriod
(package private) EventListener<CircuitBreakerStateChangedEvent>	halfOpenListener
(package private) EventListener<CircuitBreakerStateChangedEvent>	openListener
(package private) int	successThreshold
(package private) int	successThresholdingCapacity

Fields inherited from class DelayablePolicyConfig

delay, delayException, delayFn, delayResult

Fields inherited from class FailurePolicyConfig

exceptionsChecked, failureConditions

Fields inherited from class PolicyConfig

failureListener, successListener

Constructor Summary

Constructors

Constructor	Description
CircuitBreakerConfig()
CircuitBreakerConfig(CircuitBreakerConfig<R> config)

Method Summary

Modifier and Type	Method	Description
EventListener<CircuitBreakerStateChangedEvent>	getCloseListener()	Returns the close event listener.
Duration	getDelay()	Returns the delay before allowing another execution on the circuit.
int	getFailureExecutionThreshold()	Used with time based thresholding.
int	getFailureRateThreshold()	Used with time based thresholding.
int	getFailureThreshold()	Gets the number of failures that must occur within the failure thresholding capacity when in a CLOSED or HALF_OPEN state in order to open the circuit.
int	getFailureThresholdingCapacity()	Returns the rolling capacity for storing execution results when performing failure thresholding in the CLOSED or HALF_OPEN states.
Duration	getFailureThresholdingPeriod()	Used with time based thresholding.
EventListener<CircuitBreakerStateChangedEvent>	getHalfOpenListener()	Returns the half-open event listener.
EventListener<CircuitBreakerStateChangedEvent>	getOpenListener()	Returns the open event listener.
int	getSuccessThreshold()	Gets the number of successes that must occur within the success thresholding capacity when in a HALF_OPEN state in order to open the circuit.
int	getSuccessThresholdingCapacity()	Returns the rolling capacity for storing execution results when performing success thresholding in the HALF_OPEN state.

Methods inherited from class DelayablePolicyConfig

getDelayException, getDelayFn, getDelayResult

Methods inherited from class FailurePolicyConfig

getFailureConditions, isExceptionsChecked

Methods inherited from class PolicyConfig

getFailureListener, getSuccessListener

Methods inherited from class Object

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

Field Details

failureThreshold

int failureThreshold

failureRateThreshold

int failureRateThreshold

failureThresholdingCapacity

int failureThresholdingCapacity

failureExecutionThreshold

int failureExecutionThreshold

failureThresholdingPeriod

Duration failureThresholdingPeriod

successThreshold

int successThreshold

successThresholdingCapacity

int successThresholdingCapacity

openListener

EventListener<CircuitBreakerStateChangedEvent> openListener

halfOpenListener

EventListener<CircuitBreakerStateChangedEvent> halfOpenListener

closeListener

EventListener<CircuitBreakerStateChangedEvent> closeListener

Constructor Details

CircuitBreakerConfig

CircuitBreakerConfig()

CircuitBreakerConfig

CircuitBreakerConfig(CircuitBreakerConfig<R> config)

Method Details

getDelay

public Duration getDelay()

Returns the delay before allowing another execution on the circuit. Defaults to 1 minute.

Overrides:

getDelay in class DelayablePolicyConfig<R>

See Also:

• CircuitBreakerBuilder.withDelay(Duration)
• CircuitBreaker.getRemainingDelay()

getFailureThreshold

public int getFailureThreshold()

Gets the number of failures that must occur within the failure thresholding capacity when in a CLOSED or HALF_OPEN state in order to open the circuit. Returns 1 by default.

See Also:

• CircuitBreakerBuilder.withFailureThreshold(int)
• CircuitBreakerBuilder.withFailureThreshold(int, int)

getFailureThresholdingCapacity

public int getFailureThresholdingCapacity()

Returns the rolling capacity for storing execution results when performing failure thresholding in the CLOSED or HALF_OPEN states. 1 by default. Only the most recent executions that fit within this capacity contribute to thresholding decisions.

See Also:

• CircuitBreakerBuilder.withFailureThreshold(int)
• CircuitBreakerBuilder.withFailureThreshold(int, int)

getFailureRateThreshold

public int getFailureRateThreshold()

Used with time based thresholding. Returns percentage rate of failures, from 1 to 100, that must occur when in a CLOSED or HALF_OPEN state in order to open the circuit, else 0 if failure rate thresholding is not configured.

See Also:

• CircuitBreakerBuilder.withFailureRateThreshold(int, int, Duration)

getFailureThresholdingPeriod

public Duration getFailureThresholdingPeriod()

Used with time based thresholding. Returns the rolling time period during which failure thresholding is performed when in the CLOSED state, else null if time based failure thresholding is not configured. Only the most recent executions that occurred within this rolling time period contribute to thresholding decisions.

See Also:

• CircuitBreakerBuilder.withFailureThreshold(int, Duration)
• CircuitBreakerBuilder.withFailureThreshold(int, int, Duration)
• CircuitBreakerBuilder.withFailureRateThreshold(int, int, Duration)

getFailureExecutionThreshold

public int getFailureExecutionThreshold()

Used with time based thresholding. Returns the minimum number of executions that must be recorded in the CLOSED state before the breaker can be opened. For failure rate thresholding this also determines the minimum number of executions that must be recorded in the HALF_OPEN state. Returns 0 by default.

See Also:

• CircuitBreakerBuilder.withFailureThreshold(int, int, Duration)
• CircuitBreakerBuilder.withFailureRateThreshold(int, int, Duration)

getSuccessThreshold

public int getSuccessThreshold()

Gets the number of successes that must occur within the success thresholding capacity when in a HALF_OPEN state in order to open the circuit. Returns 0 by default, in which case the failure threshold is used instead.

See Also:

• CircuitBreakerBuilder.withSuccessThreshold(int)
• CircuitBreakerBuilder.withSuccessThreshold(int, int)

getSuccessThresholdingCapacity

public int getSuccessThresholdingCapacity()

Returns the rolling capacity for storing execution results when performing success thresholding in the HALF_OPEN state. Only the most recent executions that fit within this capacity contribute to thresholding decisions.

See Also:

• CircuitBreakerBuilder.withSuccessThreshold(int)
• CircuitBreakerBuilder.withSuccessThreshold(int, int)

getOpenListener

public EventListener<CircuitBreakerStateChangedEvent> getOpenListener()

Returns the open event listener.

See Also:

• CircuitBreakerBuilder.onOpen(EventListener)

getHalfOpenListener

public EventListener<CircuitBreakerStateChangedEvent> getHalfOpenListener()

Returns the half-open event listener.

See Also:

• CircuitBreakerBuilder.onHalfOpen(EventListener)

getCloseListener

public EventListener<CircuitBreakerStateChangedEvent> getCloseListener()

Returns the close event listener.

See Also:

• CircuitBreakerBuilder.onClose(EventListener)