Class CircuitBreakerStateMachine.OpenState

java.lang.Object

io.github.resilience4j.circuitbreaker.internal.CircuitBreakerStateMachine.OpenState

All Implemented Interfaces:

CircuitBreakerStateMachine.CircuitBreakerState

Enclosing class:

CircuitBreakerStateMachine

private class CircuitBreakerStateMachine.OpenState
extends Object
implements CircuitBreakerStateMachine.CircuitBreakerState

Field Summary

Fields

Modifier and Type	Field	Description
private final int	attempts
private final CircuitBreakerMetrics	circuitBreakerMetrics
private final AtomicBoolean	isOpen
private final Instant	retryAfterWaitDuration
private final ScheduledFuture<?>	transitionToHalfOpenFuture

Constructor Summary

Constructors

Constructor	Description
OpenState(int attempts, long waitDurationInMillis, CircuitBreakerMetrics circuitBreakerMetrics)
OpenState(int attempts, long waitDurationInMillis, Instant retryAfterWaitDuration, CircuitBreakerMetrics circuitBreakerMetrics)
OpenState(int attempts, CircuitBreakerMetrics circuitBreakerMetrics)
OpenState(int attempts, Duration waitDuration, CircuitBreakerMetrics circuitBreakerMetrics)
OpenState(int attempts, Instant waitUntil, CircuitBreakerMetrics circuitBreakerMetrics)

Method Summary

Modifier and Type	Method	Description
void	acquirePermission()
int	attempts()
private void	cancelAutomaticTransitionToHalfOpen()
CircuitBreakerMetrics	getMetrics()
CircuitBreaker.State	getState()	Get the state of the CircuitBreaker
void	handlePossibleTransition(CircuitBreakerConfig.TransitionCheckResult result)
void	onError(long duration, TimeUnit durationUnit, Throwable throwable)	Should never be called when tryAcquirePermission returns false.
void	onSuccess(long duration, TimeUnit durationUnit)	Should never be called when tryAcquirePermission returns false.
void	preTransitionHook()	This method is invoked before transit to other CircuitBreakerState.
void	releasePermission()
private void	toHalfOpenState()
boolean	tryAcquirePermission()	Returns false, if the wait duration has not elapsed.

Methods inherited from class Object

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

Methods inherited from interface CircuitBreakerStateMachine.CircuitBreakerState

shouldPublishEvents

Field Details

attempts

private final int attempts

retryAfterWaitDuration

private final Instant retryAfterWaitDuration

circuitBreakerMetrics

private final CircuitBreakerMetrics circuitBreakerMetrics

isOpen

private final AtomicBoolean isOpen

transitionToHalfOpenFuture

@Nullable
private final ScheduledFuture<?> transitionToHalfOpenFuture

Constructor Details

OpenState

OpenState(int attempts,
 CircuitBreakerMetrics circuitBreakerMetrics)

OpenState

OpenState(int attempts,
 Duration waitDuration,
 CircuitBreakerMetrics circuitBreakerMetrics)

OpenState

OpenState(int attempts,
 long waitDurationInMillis,
 CircuitBreakerMetrics circuitBreakerMetrics)

OpenState

OpenState(int attempts,
 Instant waitUntil,
 CircuitBreakerMetrics circuitBreakerMetrics)

OpenState

OpenState(int attempts,
 long waitDurationInMillis,
 Instant retryAfterWaitDuration,
 CircuitBreakerMetrics circuitBreakerMetrics)

Method Details

tryAcquirePermission

public boolean tryAcquirePermission()

Returns false, if the wait duration has not elapsed. Returns true, if the wait duration has elapsed and transitions the state machine to HALF_OPEN state.

Specified by:

tryAcquirePermission in interface CircuitBreakerStateMachine.CircuitBreakerState

Returns:

false, if the wait duration has not elapsed. true, if the wait duration has elapsed.

acquirePermission

public void acquirePermission()

Specified by:

acquirePermission in interface CircuitBreakerStateMachine.CircuitBreakerState

releasePermission

public void releasePermission()

Specified by:

releasePermission in interface CircuitBreakerStateMachine.CircuitBreakerState

onError

public void onError(long duration,
 TimeUnit durationUnit,
 Throwable throwable)

Should never be called when tryAcquirePermission returns false.

Specified by:

onError in interface CircuitBreakerStateMachine.CircuitBreakerState

onSuccess

public void onSuccess(long duration,
 TimeUnit durationUnit)

Should never be called when tryAcquirePermission returns false.

Specified by:

onSuccess in interface CircuitBreakerStateMachine.CircuitBreakerState

handlePossibleTransition

public void handlePossibleTransition(CircuitBreakerConfig.TransitionCheckResult result)

Specified by:

handlePossibleTransition in interface CircuitBreakerStateMachine.CircuitBreakerState

attempts

public int attempts()

Specified by:

attempts in interface CircuitBreakerStateMachine.CircuitBreakerState

getState

public CircuitBreaker.State getState()

Get the state of the CircuitBreaker

Specified by:

getState in interface CircuitBreakerStateMachine.CircuitBreakerState

getMetrics

public CircuitBreakerMetrics getMetrics()

Specified by:

getMetrics in interface CircuitBreakerStateMachine.CircuitBreakerState

preTransitionHook

public void preTransitionHook()

Description copied from interface: CircuitBreakerStateMachine.CircuitBreakerState

This method is invoked before transit to other CircuitBreakerState.

Specified by:

preTransitionHook in interface CircuitBreakerStateMachine.CircuitBreakerState

toHalfOpenState

private void toHalfOpenState()

cancelAutomaticTransitionToHalfOpen

private void cancelAutomaticTransitionToHalfOpen()