Package org.apache.camel.main

Class FaultToleranceConfigurationProperties

java.lang.Object
org.apache.camel.main.FaultToleranceConfigurationProperties
All Implemented Interfaces:
Closeable, AutoCloseable, org.apache.camel.spi.BootstrapCloseable
@Configurer(extended=true) public class FaultToleranceConfigurationProperties extends Object implements org.apache.camel.spi.BootstrapCloseable
Global configuration for MicroProfile Fault Tolerance EIP circuit breaker.

  • Constructor Details

  • Method Details

    • end

      public MainConfigurationProperties end()

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable

    • getTypedGuard

      public String getTypedGuard()

    • setTypedGuard

      public void setTypedGuard(String typedGuard)
      Refers to an existing io.smallrye.faulttolerance.api.TypedGuard instance to lookup and use from the registry. When using this, then any other TypedGuard circuit breaker options are not in use.

    • getDelay

      public Long getDelay()

    • setDelay

      public void setDelay(Long delay)
      Control how long the circuit breaker stays open. The value are in seconds and the default is 5 seconds.

    • getSuccessThreshold

      public Integer getSuccessThreshold()

    • setSuccessThreshold

      public void setSuccessThreshold(Integer successThreshold)
      Controls the number of trial calls which are allowed when the circuit breaker is half-open Default value is 1.

    • getRequestVolumeThreshold

      public Integer getRequestVolumeThreshold()

    • setRequestVolumeThreshold

      public void setRequestVolumeThreshold(Integer requestVolumeThreshold)
      Controls the size of the rolling window used when the circuit breaker is closed Default value is 20.

    • getFailureRatio

      public Integer getFailureRatio()

    • setFailureRatio

      public void setFailureRatio(Integer failureRatio)
      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.

    • getTimeoutEnabled

      public Boolean getTimeoutEnabled()

    • setTimeoutEnabled

      public void setTimeoutEnabled(Boolean timeoutEnabled)
      Whether timeout is enabled or not on the circuit breaker. Default is false.

    • getTimeoutDuration

      public Long getTimeoutDuration()

    • setTimeoutDuration

      public void setTimeoutDuration(Long timeoutDuration)
      Configures the thread execution timeout. Default value is 1000 milliseconds.

    • getTimeoutPoolSize

      public Integer getTimeoutPoolSize()

    • setTimeoutPoolSize

      public void setTimeoutPoolSize(Integer timeoutPoolSize)
      Configures the pool size of the thread pool when timeout is enabled. Default value is 10.

    • getBulkheadEnabled

      public Boolean getBulkheadEnabled()

    • setBulkheadEnabled

      public void setBulkheadEnabled(Boolean bulkheadEnabled)
      Whether bulkhead is enabled or not on the circuit breaker. Default is false.

    • getBulkheadMaxConcurrentCalls

      public Integer getBulkheadMaxConcurrentCalls()

    • setBulkheadMaxConcurrentCalls

      public void setBulkheadMaxConcurrentCalls(Integer bulkheadMaxConcurrentCalls)
      Configures the max amount of concurrent calls the bulkhead will support. Default value is 10.

    • getBulkheadWaitingTaskQueue

      public Integer getBulkheadWaitingTaskQueue()

    • setBulkheadWaitingTaskQueue

      public void setBulkheadWaitingTaskQueue(Integer bulkheadWaitingTaskQueue)
      Configures the task queue size for holding waiting tasks to be processed by the bulkhead. Default value is 10.

    • getThreadOffloadExecutorService

      public String getThreadOffloadExecutorService()

    • setThreadOffloadExecutorService

      public void setThreadOffloadExecutorService(String threadOffloadExecutorService)
      References a custom thread pool to use when offloading a guarded action to another thread.

    • withTypedGuard

      public FaultToleranceConfigurationProperties withTypedGuard(String typedGuard)
      Refers to an existing io.smallrye.faulttolerance.api.TypedGuard instance to lookup and use from the registry. When using this, then any other TypedGuard circuit breaker options are not in use.

    • withDelay

      public FaultToleranceConfigurationProperties withDelay(Long delay)
      Control how long the circuit breaker stays open. The value are in seconds and the default is 5 seconds.

    • withSuccessThreshold

      public FaultToleranceConfigurationProperties withSuccessThreshold(Integer successThreshold)
      Controls the number of trial calls which are allowed when the circuit breaker is half-open Default value is 1.

    • withRequestVolumeThreshold

      public FaultToleranceConfigurationProperties withRequestVolumeThreshold(Integer requestVolumeThreshold)
      Controls the size of the rolling window used when the circuit breaker is closed Default value is 20.

    • withFailureRatio

      public FaultToleranceConfigurationProperties withFailureRatio(Integer failureRatio)
      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.

    • withTimeoutEnabled

      public FaultToleranceConfigurationProperties withTimeoutEnabled(Boolean timeoutEnabled)
      Whether timeout is enabled or not on the circuit breaker. Default is false.

    • withTimeoutDuration

      public FaultToleranceConfigurationProperties withTimeoutDuration(Long timeoutDuration)
      Configures the thread execution timeout. Default value is 1000 milliseconds.

    • withTimeoutPoolSize

      public FaultToleranceConfigurationProperties withTimeoutPoolSize(Integer timeoutPoolSize)
      Configures the pool size of the thread pool when timeout is enabled. Default value is 10.

    • withBulkheadEnabled

      public FaultToleranceConfigurationProperties withBulkheadEnabled(Boolean bulkheadEnabled)
      Whether bulkhead is enabled or not on the circuit breaker. Default is false.

    • withBulkheadMaxConcurrentCalls

      public FaultToleranceConfigurationProperties withBulkheadMaxConcurrentCalls(Integer bulkheadMaxConcurrentCalls)
      Configures the max amount of concurrent calls the bulkhead will support. Default value is 10.

    • withBulkheadWaitingTaskQueue

      public FaultToleranceConfigurationProperties withBulkheadWaitingTaskQueue(Integer bulkheadWaitingTaskQueue)
      Configures the task queue size for holding waiting tasks to be processed by the bulkhead. Default value is 10.

    • withThreadOffloadExecutorServiceRef

      public FaultToleranceConfigurationProperties withThreadOffloadExecutorServiceRef(String threadOffloadExecutorServiceRef)
      References a custom thread pool to use when offloading a guarded action to another thread.