Package io.smallrye.faulttolerance.api

Interface CircuitBreakerMaintenance

@Experimental("first attempt at providing maintenance access to circuit breakers")
public interface CircuitBreakerMaintenance

Allows reading and observing current state of circuit breakers and reseting them to the initial (closed) state. To access a specific circuit breaker, it must be given a name using @CircuitBreakerName or withCircuitBreaker().name("...").

Method Summary

Modifier and Type	Method	Description
CircuitBreakerState	currentState(String name)	Returns current state of the circuit breaker with given name.
void	onStateChange(String name, Consumer<CircuitBreakerState> callback)	Registers a callback to be called when the circuit breaker with given name changes state.
void	reset(String name)	Resets the circuit breaker with given name to the initial (closed) state.
void	resetAll()	Resets all circuit breakers in the application to the initial (closed) state.

Method Detail

currentState

CircuitBreakerState currentState(String name)

Returns current state of the circuit breaker with given name. Note that there's no guarantee that the circuit breaker will stay in that state for any time, so this method is only useful for monitoring.

It is an error to use a name that wasn't registered using @CircuitBreakerName or withCircuitBreaker().name("...").

onStateChange

void onStateChange(String name,
                   Consumer<CircuitBreakerState> callback)

Registers a callback to be called when the circuit breaker with given name changes state.

It is an error to use a name that wasn't registered using @CircuitBreakerName or withCircuitBreaker().name("...").

The callback must be fast and non-blocking and must not throw an exception.

reset

void reset(String name)

Resets the circuit breaker with given name to the initial (closed) state.

This method should not be used regularly, it's mainly meant for testing (to isolate individual tests) and perhaps emergency maintenance tasks.

It is an error to use a name that wasn't registered using @CircuitBreakerName or withCircuitBreaker().name("...").

resetAll

void resetAll()

Resets all circuit breakers in the application to the initial (closed) state. This includes all named circuit breakers and unnamed circuit breakers declared using @CircuitBreaker. It does not include unnamed circuit breakers created using the programmatic API.

This method should not be used regularly, it's mainly meant for testing (to isolate individual tests) and perhaps emergency maintenance tasks.