CircuitBreakerConfiguration configures a circuit breaker
Setting an invocation response timeout lower that the slow call threshold will bypass the intended effect of the circuit breaker
| Modifier and Type | Class and Description |
|---|---|
| public static class |
| Modifier and Type | Field and Description |
|---|---|
| public static final int | |
| public static final int | |
| public static final int | |
| public static final int | |
| public static final int | |
| public static final int | |
| public static final int | |
| public static final int | |
| public static final boolean | |
| private final int | |
| public static final int | |
| public static final int | |
| private final int | |
| public static final int | |
| private final int | |
| private final int | |
| private final List | recordExceptions
List of exceptions for circuitBreaker to consider as failures, we are limiting the list to subclasses of RuntimeException because all JaxRs exceptions inherit from the RuntimeException |
| private final Set | recordHttpStatuses
List of default http error codes to record as circuit breaker failure |
| private final boolean | |
| public static final int | |
| private final int | |
| private final Duration | |
| private final int | |
| public static final int | |
| private final Duration | |
| private final boolean |
| Access | Constructor and Description |
|---|---|
| protected | CircuitBreakerConfiguration(int failureRateThreshold, int slowCallRateThreshold, Duration waitDurationInOpenState, int permittedNumberOfCallsInHalfOpenState, int minimumNumberOfCalls, int slidingWindowSize, Duration slowCallDurationThreshold, boolean writableStackTraceEnabled, Set<Integer> recordHttpStatuses, List<Class<? extends RuntimeException>> recordExceptions, boolean recordProcessingFailures)
|
| protected | CircuitBreakerConfiguration(int failureRateThreshold, int slowCallRateThreshold, Duration waitDurationInOpenState, int permittedNumberOfCallsInHalfOpenState, int minimumNumberOfCalls, int slidingWindowSize, Duration slowCallDurationThreshold, boolean writableStackTraceEnabled, Set<Integer> recordHttpStatuses, List<Class<? extends RuntimeException>> recordExceptions, boolean recordProcessingFailures, int numberOfRecordedHistoryResponses)
Use |
| public |
| Modifier and Type | Method and Description |
|---|---|
| public static CircuitBreakerConfiguration. | |
| private static List | |
| private static Set | |
| public int | |
| public int | |
| public int | |
| public int | |
| public List | |
| public Set | |
| public int | |
| public Duration | |
| public int | |
| public Duration | |
| public boolean | |
| public boolean |
| BAD_GATEWAY | back to summary |
|---|---|
| public static final int BAD_GATEWAY | |
| DEFAULT_FAILURE_RATE_THRESHOLD | back to summary |
|---|---|
| public static final int DEFAULT_FAILURE_RATE_THRESHOLD | |
| DEFAULT_MINIMUM_NUMBER_OF_CALLS | back to summary |
|---|---|
| public static final int DEFAULT_MINIMUM_NUMBER_OF_CALLS | |
| DEFAULT_PERMITTED_CALLS_IN_HALF_OPEN_STATE | back to summary |
|---|---|
| public static final int DEFAULT_PERMITTED_CALLS_IN_HALF_OPEN_STATE | |
| DEFAULT_SLIDING_WINDOW_SIZE | back to summary |
|---|---|
| public static final int DEFAULT_SLIDING_WINDOW_SIZE | |
| DEFAULT_SLOW_CALL_DURATION_THRESHOLD | back to summary |
|---|---|
| public static final int DEFAULT_SLOW_CALL_DURATION_THRESHOLD | |
| DEFAULT_SLOW_CALL_RATE_THRESHOLD | back to summary |
|---|---|
| public static final int DEFAULT_SLOW_CALL_RATE_THRESHOLD | |
| DEFAULT_WAIT_DURATION_IN_OPEN_STATE | back to summary |
|---|---|
| public static final int DEFAULT_WAIT_DURATION_IN_OPEN_STATE | |
| DEFAULT_WRITABLE_STACK_TRACE_ENABLED | back to summary |
|---|---|
| public static final boolean DEFAULT_WRITABLE_STACK_TRACE_ENABLED | |
| failureRateThreshold | back to summary |
|---|---|
| private final int failureRateThreshold | |
| GATEWAY_TIMEOUT | back to summary |
|---|---|
| public static final int GATEWAY_TIMEOUT | |
| INTERNAL_SERVER_ERROR | back to summary |
|---|---|
| public static final int INTERNAL_SERVER_ERROR | |
| minimumNumberOfCalls | back to summary |
|---|---|
| private final int minimumNumberOfCalls | |
| NUMBER_OF_RECORDED_HISTORY_RESPONSES | back to summary |
|---|---|
| public static final int NUMBER_OF_RECORDED_HISTORY_RESPONSES | |
| numberOfRecordedHistoryResponses | back to summary |
|---|---|
| private final int numberOfRecordedHistoryResponses | |
| permittedNumberOfCallsInHalfOpenState | back to summary |
|---|---|
| private final int permittedNumberOfCallsInHalfOpenState | |
| recordExceptions | back to summary |
|---|---|
| private final List<Class<? extends RuntimeException>> recordExceptions List of exceptions for circuitBreaker to consider as failures, we are limiting the list to subclasses of RuntimeException because all JaxRs exceptions inherit from the RuntimeException | |
| recordHttpStatuses | back to summary |
|---|---|
| private final Set<Integer> recordHttpStatuses List of default http error codes to record as circuit breaker failure | |
| recordProcessingFailures | back to summary |
|---|---|
| private final boolean recordProcessingFailures | |
| SERVICE_UNAVAILABLE | back to summary |
|---|---|
| public static final int SERVICE_UNAVAILABLE | |
| slidingWindowSize | back to summary |
|---|---|
| private final int slidingWindowSize | |
| slowCallDurationThreshold | back to summary |
|---|---|
| private final Duration slowCallDurationThreshold | |
| slowCallRateThreshold | back to summary |
|---|---|
| private final int slowCallRateThreshold | |
| TOO_MANY_REQUESTS | back to summary |
|---|---|
| public static final int TOO_MANY_REQUESTS | |
| waitDurationInOpenState | back to summary |
|---|---|
| private final Duration waitDurationInOpenState | |
| writableStackTraceEnabled | back to summary |
|---|---|
| private final boolean writableStackTraceEnabled | |
| CircuitBreakerConfiguration | back to summary |
|---|---|
| protected CircuitBreakerConfiguration(int failureRateThreshold, int slowCallRateThreshold, Duration waitDurationInOpenState, int permittedNumberOfCallsInHalfOpenState, int minimumNumberOfCalls, int slidingWindowSize, Duration slowCallDurationThreshold, boolean writableStackTraceEnabled, Set<Integer> recordHttpStatuses, List<Class<? extends RuntimeException>> recordExceptions, boolean recordProcessingFailures) | |
| CircuitBreakerConfiguration | back to summary |
|---|---|
| protected CircuitBreakerConfiguration(int failureRateThreshold, int slowCallRateThreshold, Duration waitDurationInOpenState, int permittedNumberOfCallsInHalfOpenState, int minimumNumberOfCalls, int slidingWindowSize, Duration slowCallDurationThreshold, boolean writableStackTraceEnabled, Set<Integer> recordHttpStatuses, List<Class<? extends RuntimeException>> recordExceptions, boolean recordProcessingFailures, int numberOfRecordedHistoryResponses) Use
| |
| CircuitBreakerConfiguration | back to summary |
|---|---|
| public CircuitBreakerConfiguration() | |
| builder | back to summary |
|---|---|
| public static CircuitBreakerConfiguration. | |
| defaultRecordExceptions | back to summary |
|---|---|
| private static List | |
| defaultRecordHttpStatuses | back to summary |
|---|---|
| private static Set | |
| getFailureRateThreshold | back to summary |
|---|---|
| public int getFailureRateThreshold() | |
| getMinimumNumberOfCalls | back to summary |
|---|---|
| public int getMinimumNumberOfCalls() | |
| getNumberOfRecordedHistoryResponses | back to summary |
|---|---|
| public int getNumberOfRecordedHistoryResponses() | |
| getPermittedNumberOfCallsInHalfOpenState | back to summary |
|---|---|
| public int getPermittedNumberOfCallsInHalfOpenState() | |
| getRecordExceptions | back to summary |
|---|---|
| public List | |
| getRecordHttpStatuses | back to summary |
|---|---|
| public Set | |
| getSlidingWindowSize | back to summary |
|---|---|
| public int getSlidingWindowSize() | |
| getSlowCallDurationThreshold | back to summary |
|---|---|
| public Duration getSlowCallDurationThreshold() | |
| getSlowCallRateThreshold | back to summary |
|---|---|
| public int getSlowCallRateThreshold() | |
| getWaitDurationInOpenState | back to summary |
|---|---|
| public Duration getWaitDurationInOpenState() | |
| isRecordProcessingFailures | back to summary |
|---|---|
| public boolean isRecordProcessingFailures() | |
| isWritableStackTraceEnabled | back to summary |
|---|---|
| public boolean isWritableStackTraceEnabled() | |
| Modifier and Type | Field and Description |
|---|---|
| private boolean | |
| private int | |
| private boolean | |
| private int | |
| private boolean | |
| private int | |
| private boolean | |
| private int | |
| private boolean | |
| private List | |
| private boolean | |
| private Set | |
| private boolean | |
| private boolean | |
| private int | |
| private boolean | |
| private Duration | |
| private boolean | |
| private int | |
| private boolean | |
| private Duration | |
| private boolean | |
| private boolean |
| Access | Constructor and Description |
|---|---|
| pack-priv |
| failureRateThreshold$set | back to summary |
|---|---|
| private boolean failureRateThreshold$set | |
| failureRateThreshold$value | back to summary |
|---|---|
| private int failureRateThreshold$value | |
| minimumNumberOfCalls$set | back to summary |
|---|---|
| private boolean minimumNumberOfCalls$set | |
| minimumNumberOfCalls$value | back to summary |
|---|---|
| private int minimumNumberOfCalls$value | |
| numberOfRecordedHistoryResponses$set | back to summary |
|---|---|
| private boolean numberOfRecordedHistoryResponses$set | |
| numberOfRecordedHistoryResponses$value | back to summary |
|---|---|
| private int numberOfRecordedHistoryResponses$value | |
| permittedNumberOfCallsInHalfOpenState$set | back to summary |
|---|---|
| private boolean permittedNumberOfCallsInHalfOpenState$set | |
| permittedNumberOfCallsInHalfOpenState$value | back to summary |
|---|---|
| private int permittedNumberOfCallsInHalfOpenState$value | |
| recordExceptions$set | back to summary |
|---|---|
| private boolean recordExceptions$set | |
| recordExceptions$value | back to summary |
|---|---|
| private List<Class<? extends RuntimeException>> recordExceptions$value | |
| recordHttpStatuses$set | back to summary |
|---|---|
| private boolean recordHttpStatuses$set | |
| recordHttpStatuses$value | back to summary |
|---|---|
| private Set<Integer> recordHttpStatuses$value | |
| recordProcessingFailures | back to summary |
|---|---|
| private boolean recordProcessingFailures | |
| slidingWindowSize$set | back to summary |
|---|---|
| private boolean slidingWindowSize$set | |
| slidingWindowSize$value | back to summary |
|---|---|
| private int slidingWindowSize$value | |
| slowCallDurationThreshold$set | back to summary |
|---|---|
| private boolean slowCallDurationThreshold$set | |
| slowCallDurationThreshold$value | back to summary |
|---|---|
| private Duration slowCallDurationThreshold$value | |
| slowCallRateThreshold$set | back to summary |
|---|---|
| private boolean slowCallRateThreshold$set | |
| slowCallRateThreshold$value | back to summary |
|---|---|
| private int slowCallRateThreshold$value | |
| waitDurationInOpenState$set | back to summary |
|---|---|
| private boolean waitDurationInOpenState$set | |
| waitDurationInOpenState$value | back to summary |
|---|---|
| private Duration waitDurationInOpenState$value | |
| writableStackTraceEnabled$set | back to summary |
|---|---|
| private boolean writableStackTraceEnabled$set | |
| writableStackTraceEnabled$value | back to summary |
|---|---|
| private boolean writableStackTraceEnabled$value | |
| CircuitBreakerConfigurationBuilder | back to summary |
|---|---|
| pack-priv CircuitBreakerConfigurationBuilder() | |
| build | back to summary |
|---|---|
| public CircuitBreakerConfiguration build() | |
| failureRateThreshold | back to summary |
|---|---|
| public CircuitBreakerConfiguration. | |
| minimumNumberOfCalls | back to summary |
|---|---|
| public CircuitBreakerConfiguration. | |
| numberOfRecordedHistoryResponses | back to summary |
|---|---|
| public CircuitBreakerConfiguration. | |
| permittedNumberOfCallsInHalfOpenState | back to summary |
|---|---|
| public CircuitBreakerConfiguration. | |
| recordExceptions | back to summary |
|---|---|
| public CircuitBreakerConfiguration. | |
| recordHttpStatuses | back to summary |
|---|---|
| public CircuitBreakerConfiguration. | |
| recordProcessingFailures | back to summary |
|---|---|
| public CircuitBreakerConfiguration. | |
| slidingWindowSize | back to summary |
|---|---|
| public CircuitBreakerConfiguration. | |
| slowCallDurationThreshold | back to summary |
|---|---|
| public CircuitBreakerConfiguration. | |
| slowCallRateThreshold | back to summary |
|---|---|
| public CircuitBreakerConfiguration. | |
| toString | back to summary |
|---|---|
| public String toString() Overrides java. Doc from java. Returns a string representation of the object.
Satisfying this method's contract implies a non-
| |
| waitDurationInOpenState | back to summary |
|---|---|
| public CircuitBreakerConfiguration. | |
| writableStackTraceEnabled | back to summary |
|---|---|
| public CircuitBreakerConfiguration. | |