fish.payara.microprofile.faulttolerance.state

Class CircuitBreakerState

java.lang.Object

fish.payara.microprofile.faulttolerance.state.CircuitBreakerState

public class CircuitBreakerState
extends Object

Class that represents the state of a CircuitBreaker.

Author:

Andrew Pielage

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CircuitBreakerState.CircuitState

Constructor Summary

Constructors

Constructor and Description
CircuitBreakerState(int requestVolumeThreshold)

Method Summary

Modifier and Type	Method and Description
CircuitBreakerState.CircuitState	getCircuitState() Gets the current circuit state.
int	getHalfOpenSuccessFulResultCounter() Gets the successful results counter for the half open state.
void	incrementHalfOpenSuccessfulResultCounter() Increments the successful results counter for the half open state.
Boolean	isOverFailureThreshold(long failureThreshold) Checks to see if the CircuitBreaker is over the given failure threshold.
void	recordClosedResult(Boolean result) Records a success or failure result to the CircuitBreaker.
void	resetHalfOpenSuccessfulResultCounter() Resets the successful results counter for the half open state.
void	resetResults() Clears the results queue.
void	setCircuitState(CircuitBreakerState.CircuitState circuitState) Sets the CircuitBreaker state to the provided enum value.

Methods inherited from class java.lang.Object

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

Constructor Detail

CircuitBreakerState

public CircuitBreakerState(int requestVolumeThreshold)

Method Detail

getCircuitState

public CircuitBreakerState.CircuitState getCircuitState()

Gets the current circuit state.

Returns:

The current circuit state

setCircuitState

public void setCircuitState(CircuitBreakerState.CircuitState circuitState)

Sets the CircuitBreaker state to the provided enum value.

Parameters:

circuitState - The state to set the CIrcuitBreaker to.

recordClosedResult

public void recordClosedResult(Boolean result)

Records a success or failure result to the CircuitBreaker.

Parameters:

result - True for a success, false for a failure

resetResults

public void resetResults()

Clears the results queue.

incrementHalfOpenSuccessfulResultCounter

public void incrementHalfOpenSuccessfulResultCounter()

Increments the successful results counter for the half open state.

resetHalfOpenSuccessfulResultCounter

public void resetHalfOpenSuccessfulResultCounter()

Resets the successful results counter for the half open state.

getHalfOpenSuccessFulResultCounter

public int getHalfOpenSuccessFulResultCounter()

Gets the successful results counter for the half open state.

Returns:

The number of consecutive successful results.

isOverFailureThreshold

public Boolean isOverFailureThreshold(long failureThreshold)

Checks to see if the CircuitBreaker is over the given failure threshold.

Parameters:

failureThreshold - The number of failures before the circuit breaker should open

Returns:

True if the CircuitBreaker is over the failure threshold