Resilience4jConfigurationCommon (Camel :: Core Model 3.11.1 API)

java.lang.Object
- org.apache.camel.model.IdentifiedType
- - org.apache.camel.model.Resilience4jConfigurationCommon

Direct Known Subclasses:: Resilience4jConfigurationDefinition

public class Resilience4jConfigurationCommon
extends IdentifiedType

Constructor Summary

Constructors
Constructor and Description

Resilience4jConfigurationCommon()

Constructors
Constructor and Description
`Resilience4jConfigurationCommon()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAutomaticTransitionFromOpenToHalfOpenEnabled()`
`String`	`getBulkheadEnabled()`
`String`	`getBulkheadMaxConcurrentCalls()`
`String`	`getBulkheadMaxWaitDuration()`
`String`	`getCircuitBreakerRef()`
`String`	`getConfigRef()`
`String`	`getFailureRateThreshold()`
`String`	`getMinimumNumberOfCalls()`
`String`	`getPermittedNumberOfCallsInHalfOpenState()`
`String`	`getSlidingWindowSize()`
`String`	`getSlidingWindowType()`
`String`	`getSlowCallDurationThreshold()`
`String`	`getSlowCallRateThreshold()`
`String`	`getTimeoutCancelRunningFuture()`
`String`	`getTimeoutDuration()`
`String`	`getTimeoutEnabled()`
`String`	`getTimeoutExecutorServiceRef()`
`String`	`getWaitDurationInOpenState()`
`String`	`getWritableStackTraceEnabled()`
`void`	`setAutomaticTransitionFromOpenToHalfOpenEnabled(String automaticTransitionFromOpenToHalfOpenEnabled)` Enables automatic transition from OPEN to HALF_OPEN state once the waitDurationInOpenState has passed.
`void`	`setBulkheadEnabled(String bulkheadEnabled)` Whether bulkhead is enabled or not on the circuit breaker.
`void`	`setBulkheadMaxConcurrentCalls(String bulkheadMaxConcurrentCalls)` Configures the max amount of concurrent calls the bulkhead will support.
`void`	`setBulkheadMaxWaitDuration(String bulkheadMaxWaitDuration)` Configures a maximum amount of time which the calling thread will wait to enter the bulkhead.
`void`	`setCircuitBreakerRef(String circuitBreakerRef)` Refers to an existing io.github.resilience4j.circuitbreaker.CircuitBreaker instance to lookup and use from the registry.
`void`	`setConfigRef(String configRef)` Refers to an existing io.github.resilience4j.circuitbreaker.CircuitBreakerConfig instance to lookup and use from the registry.
`void`	`setFailureRateThreshold(String failureRateThreshold)` Configures the failure rate threshold in percentage.
`void`	`setMinimumNumberOfCalls(String minimumNumberOfCalls)` Configures the minimum number of calls which are required (per sliding window period) before the CircuitBreaker can calculate the error rate.
`void`	`setPermittedNumberOfCallsInHalfOpenState(String permittedNumberOfCallsInHalfOpenState)` Configures the number of permitted calls when the CircuitBreaker is half open.
`void`	`setSlidingWindowSize(String slidingWindowSize)` Configures the size of the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed.
`void`	`setSlidingWindowType(String slidingWindowType)` Configures the type of the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed.
`void`	`setSlowCallDurationThreshold(String slowCallDurationThreshold)` Configures the duration threshold (seconds) above which calls are considered as slow and increase the slow calls percentage.
`void`	`setSlowCallRateThreshold(String slowCallRateThreshold)` Configures a threshold in percentage.
`void`	`setTimeoutCancelRunningFuture(String timeoutCancelRunningFuture)` Configures whether cancel is called on the running future.
`void`	`setTimeoutDuration(String timeoutDuration)` Configures the thread execution timeout.
`void`	`setTimeoutEnabled(String timeoutEnabled)` Whether timeout is enabled or not on the circuit breaker.
`void`	`setTimeoutExecutorServiceRef(String timeoutExecutorServiceRef)` References to a custom thread pool to use when timeout is enabled (uses `ForkJoinPool.commonPool()` by default)
`void`	`setWaitDurationInOpenState(String waitDurationInOpenState)` Configures the wait duration (in seconds) which specifies how long the CircuitBreaker should stay open, before it switches to half open.
`void`	`setWritableStackTraceEnabled(String writableStackTraceEnabled)` Enables writable stack traces.

Methods inherited from class org.apache.camel.model.IdentifiedType
getId, setId

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Resilience4jConfigurationCommon
```
public Resilience4jConfigurationCommon()
```
- Method Detail
  - getCircuitBreakerRef
```
public String getCircuitBreakerRef()
```
  - setCircuitBreakerRef
```
public void setCircuitBreakerRef(String circuitBreakerRef)
```
    Refers to an existing io.github.resilience4j.circuitbreaker.CircuitBreaker instance to lookup and use from the registry. When using this, then any other circuit breaker options are not in use.
  - getConfigRef
```
public String getConfigRef()
```
  - setConfigRef
```
public void setConfigRef(String configRef)
```
    Refers to an existing io.github.resilience4j.circuitbreaker.CircuitBreakerConfig instance to lookup and use from the registry.
  - getFailureRateThreshold
```
public String getFailureRateThreshold()
```
  - setFailureRateThreshold
```
public void setFailureRateThreshold(String failureRateThreshold)
```
    Configures the failure rate threshold in percentage. If the failure rate is equal or greater than the threshold the CircuitBreaker transitions to open and starts short-circuiting calls.
    The threshold must be greater than 0 and not greater than 100. Default value is 50 percentage.
  - getPermittedNumberOfCallsInHalfOpenState
```
public String getPermittedNumberOfCallsInHalfOpenState()
```
  - setPermittedNumberOfCallsInHalfOpenState
```
public void setPermittedNumberOfCallsInHalfOpenState(String permittedNumberOfCallsInHalfOpenState)
```
    Configures the number of permitted calls when the CircuitBreaker is half open.
    The size must be greater than 0. Default size is 10.
  - getSlidingWindowSize
```
public String getSlidingWindowSize()
```
  - setSlidingWindowSize
```
public void setSlidingWindowSize(String slidingWindowSize)
```
    Configures the size of the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed. slidingWindowSize configures the size of the sliding window. Sliding window can either be count-based or time-based. If slidingWindowType is COUNT_BASED, the last slidingWindowSize calls are recorded and aggregated. If slidingWindowType is TIME_BASED, the calls of the last slidingWindowSize seconds are recorded and aggregated.
    The slidingWindowSize must be greater than 0. The minimumNumberOfCalls must be greater than 0. If the slidingWindowType is COUNT_BASED, the minimumNumberOfCalls cannot be greater than slidingWindowSize. If the slidingWindowType is TIME_BASED, you can pick whatever you want. Default slidingWindowSize is 100.
  - getSlidingWindowType
```
public String getSlidingWindowType()
```
  - setSlidingWindowType
```
public void setSlidingWindowType(String slidingWindowType)
```
    Configures the type of the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed. Sliding window can either be count-based or time-based. If slidingWindowType is COUNT_BASED, the last slidingWindowSize calls are recorded and aggregated. If slidingWindowType is TIME_BASED, the calls of the last slidingWindowSize seconds are recorded and aggregated. Default slidingWindowType is COUNT_BASED.
  - getMinimumNumberOfCalls
```
public String getMinimumNumberOfCalls()
```
  - setMinimumNumberOfCalls
```
public void setMinimumNumberOfCalls(String minimumNumberOfCalls)
```
    Configures the minimum number of calls which are required (per sliding window period) before the CircuitBreaker can calculate the error rate. For example, if minimumNumberOfCalls is 10, then at least 10 calls must be recorded, before the failure rate can be calculated. If only 9 calls have been recorded the CircuitBreaker will not transition to open even if all 9 calls have failed. Default minimumNumberOfCalls is 100
  - getWritableStackTraceEnabled
```
public String getWritableStackTraceEnabled()
```
  - setWritableStackTraceEnabled
```
public void setWritableStackTraceEnabled(String writableStackTraceEnabled)
```
    Enables writable stack traces. When set to false, Exception.getStackTrace returns a zero length array. This may be used to reduce log spam when the circuit breaker is open as the cause of the exceptions is already known (the circuit breaker is short-circuiting calls).
  - getWaitDurationInOpenState
```
public String getWaitDurationInOpenState()
```
  - setWaitDurationInOpenState
```
public void setWaitDurationInOpenState(String waitDurationInOpenState)
```
    Configures the wait duration (in seconds) which specifies how long the CircuitBreaker should stay open, before it switches to half open. Default value is 60 seconds.
  - getAutomaticTransitionFromOpenToHalfOpenEnabled
```
public String getAutomaticTransitionFromOpenToHalfOpenEnabled()
```
  - setAutomaticTransitionFromOpenToHalfOpenEnabled
```
public void setAutomaticTransitionFromOpenToHalfOpenEnabled(String automaticTransitionFromOpenToHalfOpenEnabled)
```
    Enables automatic transition from OPEN to HALF_OPEN state once the waitDurationInOpenState has passed.
  - getSlowCallRateThreshold
```
public String getSlowCallRateThreshold()
```
  - setSlowCallRateThreshold
```
public void setSlowCallRateThreshold(String slowCallRateThreshold)
```
    Configures a threshold in percentage. The CircuitBreaker considers a call as slow when the call duration is greater than slowCallDurationThreshold Duration. When the percentage of slow calls is equal or greater the threshold, the CircuitBreaker transitions to open and starts short-circuiting calls.
    The threshold must be greater than 0 and not greater than 100. Default value is 100 percentage which means that all recorded calls must be slower than slowCallDurationThreshold.
  - getSlowCallDurationThreshold
```
public String getSlowCallDurationThreshold()
```
  - setSlowCallDurationThreshold
```
public void setSlowCallDurationThreshold(String slowCallDurationThreshold)
```
    Configures the duration threshold (seconds) above which calls are considered as slow and increase the slow calls percentage. Default value is 60 seconds.
  - getBulkheadEnabled
```
public String getBulkheadEnabled()
```
  - setBulkheadEnabled
```
public void setBulkheadEnabled(String bulkheadEnabled)
```
    Whether bulkhead is enabled or not on the circuit breaker. Default is false.
  - getBulkheadMaxConcurrentCalls
```
public String getBulkheadMaxConcurrentCalls()
```
  - setBulkheadMaxConcurrentCalls
```
public void setBulkheadMaxConcurrentCalls(String bulkheadMaxConcurrentCalls)
```
    Configures the max amount of concurrent calls the bulkhead will support.
  - getBulkheadMaxWaitDuration
```
public String getBulkheadMaxWaitDuration()
```
  - setBulkheadMaxWaitDuration
```
public void setBulkheadMaxWaitDuration(String bulkheadMaxWaitDuration)
```
    Configures a maximum amount of time which the calling thread will wait to enter the bulkhead. If bulkhead has space available, entry is guaranteed and immediate. If bulkhead is full, calling threads will contest for space, if it becomes available. maxWaitDuration can be set to 0.
    Note: for threads running on an event-loop or equivalent (rx computation pool, etc), setting maxWaitDuration to 0 is highly recommended. Blocking an event-loop thread will most likely have a negative effect on application throughput.
  - getTimeoutEnabled
```
public String getTimeoutEnabled()
```
  - setTimeoutEnabled
```
public void setTimeoutEnabled(String timeoutEnabled)
```
    Whether timeout is enabled or not on the circuit breaker. Default is false.
  - getTimeoutExecutorServiceRef
```
public String getTimeoutExecutorServiceRef()
```
  - setTimeoutExecutorServiceRef
```
public void setTimeoutExecutorServiceRef(String timeoutExecutorServiceRef)
```
    References to a custom thread pool to use when timeout is enabled (uses ForkJoinPool.commonPool() by default)
  - getTimeoutDuration
```
public String getTimeoutDuration()
```
  - setTimeoutDuration
```
public void setTimeoutDuration(String timeoutDuration)
```
    Configures the thread execution timeout. Default value is 1 second.
  - getTimeoutCancelRunningFuture
```
public String getTimeoutCancelRunningFuture()
```
  - setTimeoutCancelRunningFuture
```
public void setTimeoutCancelRunningFuture(String timeoutCancelRunningFuture)
```
    Configures whether cancel is called on the running future. Defaults to true.

Class Resilience4jConfigurationCommon

Constructor Summary

Method Summary

Methods inherited from class org.apache.camel.model.IdentifiedType

Methods inherited from class java.lang.Object

Constructor Detail

Resilience4jConfigurationCommon

Method Detail

getCircuitBreakerRef

setCircuitBreakerRef

getConfigRef

setConfigRef

getFailureRateThreshold

setFailureRateThreshold

getPermittedNumberOfCallsInHalfOpenState

setPermittedNumberOfCallsInHalfOpenState

getSlidingWindowSize

setSlidingWindowSize

getSlidingWindowType

setSlidingWindowType

getMinimumNumberOfCalls

setMinimumNumberOfCalls

getWritableStackTraceEnabled

setWritableStackTraceEnabled

getWaitDurationInOpenState

setWaitDurationInOpenState

getAutomaticTransitionFromOpenToHalfOpenEnabled

setAutomaticTransitionFromOpenToHalfOpenEnabled

getSlowCallRateThreshold

setSlowCallRateThreshold

getSlowCallDurationThreshold

setSlowCallDurationThreshold

getBulkheadEnabled

setBulkheadEnabled

getBulkheadMaxConcurrentCalls

setBulkheadMaxConcurrentCalls

getBulkheadMaxWaitDuration

setBulkheadMaxWaitDuration

getTimeoutEnabled

setTimeoutEnabled

getTimeoutExecutorServiceRef

setTimeoutExecutorServiceRef

getTimeoutDuration

setTimeoutDuration

getTimeoutCancelRunningFuture

setTimeoutCancelRunningFuture