Package org.apache.camel.model

Class FaultToleranceConfigurationDefinition

java.lang.Object

org.apache.camel.model.IdentifiedType

org.apache.camel.model.FaultToleranceConfigurationCommon

org.apache.camel.model.FaultToleranceConfigurationDefinition

@Metadata(label="configuration,eip,error")
@Configurer(extended=true)
public class FaultToleranceConfigurationDefinition
extends FaultToleranceConfigurationCommon

MicroProfile Fault Tolerance Circuit Breaker EIP configuration

Constructor Summary

Constructors

Modifier	Constructor	Description
	FaultToleranceConfigurationDefinition()
	FaultToleranceConfigurationDefinition(CircuitBreakerDefinition parent)
protected	FaultToleranceConfigurationDefinition(FaultToleranceConfigurationDefinition source)

Method Summary

Modifier and Type	Method	Description
FaultToleranceConfigurationDefinition	bulkheadEnabled(boolean bulkheadEnabled)	Whether bulkhead is enabled or not on the circuit breaker.
FaultToleranceConfigurationDefinition	bulkheadMaxConcurrentCalls(int bulkheadMaxConcurrentCalls)	Configures the max amount of concurrent calls the bulkhead will support.
FaultToleranceConfigurationDefinition	bulkheadWaitingTaskQueue(int bulkheadWaitingTaskQueue)	Configures the task queue size for holding waiting tasks to be processed by the bulkhead
FaultToleranceConfigurationDefinition	copyDefinition()
FaultToleranceConfigurationDefinition	delay(long delay)	Control how long the circuit breaker stays open.
FaultToleranceConfigurationDefinition	delay(String delay)	Control how long the circuit breaker stays open.
CircuitBreakerDefinition	end()	End of configuration.
FaultToleranceConfigurationDefinition	failureRatio(int failureRatio)	Configures the failure rate threshold in percentage.
FaultToleranceConfigurationDefinition	requestVolumeThreshold(int requestVolumeThreshold)	Controls the size of the rolling window used when the circuit breaker is closed
FaultToleranceConfigurationDefinition	successThreshold(int successThreshold)	Controls the number of trial calls which are allowed when the circuit breaker is half-open
FaultToleranceConfigurationDefinition	threadOffloadExecutorService(String threadOffloadExecutorService)	References a custom thread pool to use when offloading a guarded action to another thread.
FaultToleranceConfigurationDefinition	timeoutDuration(long timeoutDuration)	Configures the thread execution timeout.
FaultToleranceConfigurationDefinition	timeoutDuration(String timeoutDuration)	Configures the thread execution timeout.
FaultToleranceConfigurationDefinition	timeoutEnabled(boolean timeoutEnabled)	Whether timeout is enabled or not on the circuit breaker.
FaultToleranceConfigurationDefinition	timeoutPoolSize(int poolSize)	Configures the pool size of the thread pool when timeout is enabled.
FaultToleranceConfigurationDefinition	typedGuard(String typedGuard)	Refers to an existing io.smallrye.faulttolerance.api.TypedGuard instance to lookup and use from the registry.

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

getBulkheadEnabled, getBulkheadMaxConcurrentCalls, getBulkheadWaitingTaskQueue, getDelay, getFailureRatio, getRequestVolumeThreshold, getSuccessThreshold, getThreadOffloadExecutorService, getTimeoutDuration, getTimeoutEnabled, getTimeoutPoolSize, getTypedGuard, setBulkheadEnabled, setBulkheadMaxConcurrentCalls, setBulkheadWaitingTaskQueue, setDelay, setFailureRatio, setRequestVolumeThreshold, setSuccessThreshold, setThreadOffloadExecutorService, setTimeoutDuration, setTimeoutEnabled, setTimeoutPoolSize, setTypedGuard

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 Details

FaultToleranceConfigurationDefinition

public FaultToleranceConfigurationDefinition()

FaultToleranceConfigurationDefinition

protected FaultToleranceConfigurationDefinition(FaultToleranceConfigurationDefinition source)

FaultToleranceConfigurationDefinition

public FaultToleranceConfigurationDefinition(CircuitBreakerDefinition parent)

Method Details

copyDefinition

public FaultToleranceConfigurationDefinition copyDefinition()

Overrides:

copyDefinition in class FaultToleranceConfigurationCommon

typedGuard

public FaultToleranceConfigurationDefinition typedGuard(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.

delay

public FaultToleranceConfigurationDefinition delay(long delay)

Control how long the circuit breaker stays open. The default is 5 seconds.

delay

public FaultToleranceConfigurationDefinition delay(String delay)

Control how long the circuit breaker stays open. The default is 5 seconds.

successThreshold

public FaultToleranceConfigurationDefinition successThreshold(int successThreshold)

Controls the number of trial calls which are allowed when the circuit breaker is half-open

requestVolumeThreshold

public FaultToleranceConfigurationDefinition requestVolumeThreshold(int requestVolumeThreshold)

Controls the size of the rolling window used when the circuit breaker is closed

failureRatio

public FaultToleranceConfigurationDefinition failureRatio(int 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.

timeoutEnabled

public FaultToleranceConfigurationDefinition timeoutEnabled(boolean timeoutEnabled)

Whether timeout is enabled or not on the circuit breaker. Default is false.

timeoutDuration

public FaultToleranceConfigurationDefinition timeoutDuration(long timeoutDuration)

Configures the thread execution timeout. Default value is 1 second.

timeoutDuration

public FaultToleranceConfigurationDefinition timeoutDuration(String timeoutDuration)

Configures the thread execution timeout. Default value is 1 second.

timeoutPoolSize

public FaultToleranceConfigurationDefinition timeoutPoolSize(int poolSize)

Configures the pool size of the thread pool when timeout is enabled. Default value is 10.

bulkheadEnabled

public FaultToleranceConfigurationDefinition bulkheadEnabled(boolean bulkheadEnabled)

Whether bulkhead is enabled or not on the circuit breaker. Default is false.

bulkheadMaxConcurrentCalls

public FaultToleranceConfigurationDefinition bulkheadMaxConcurrentCalls(int bulkheadMaxConcurrentCalls)

Configures the max amount of concurrent calls the bulkhead will support.

bulkheadWaitingTaskQueue

public FaultToleranceConfigurationDefinition bulkheadWaitingTaskQueue(int bulkheadWaitingTaskQueue)

Configures the task queue size for holding waiting tasks to be processed by the bulkhead

threadOffloadExecutorService

public FaultToleranceConfigurationDefinition threadOffloadExecutorService(String threadOffloadExecutorService)

References a custom thread pool to use when offloading a guarded action to another thread.

end

public CircuitBreakerDefinition end()

End of configuration.