Class CircuitBreakerConfig.BuilderBase.CircuitBreakerConfigImpl

java.lang.Object

io.helidon.faulttolerance.CircuitBreakerConfig.BuilderBase.CircuitBreakerConfigImpl

All Implemented Interfaces:

Prototype.Api, Prototype.Factory<CircuitBreaker>, CircuitBreakerConfig, Supplier<CircuitBreaker>

Enclosing class:

CircuitBreakerConfig.BuilderBase<BUILDER extends CircuitBreakerConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends CircuitBreakerConfig>

protected static class CircuitBreakerConfig.BuilderBase.CircuitBreakerConfigImpl
extends Object
implements CircuitBreakerConfig, Supplier<CircuitBreaker>

Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface CircuitBreakerConfig

CircuitBreakerConfig.Builder, CircuitBreakerConfig.BuilderBase<BUILDER, PROTOTYPE>

Modifier and Type	Interface	Description
static class	CircuitBreakerConfig.Builder	Fluent API builder for CircuitBreaker.
static class	CircuitBreakerConfig.BuilderBase<BUILDER extends CircuitBreakerConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends CircuitBreakerConfig>	Fluent API builder base for CircuitBreakerConfig.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_ERROR_RATIO	Default error ratio.
static final int	DEFAULT_SUCCESS_THRESHOLD	Default success threshold.
static final int	DEFAULT_VOLUME	Default volume.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CircuitBreakerConfigImpl(CircuitBreakerConfig.BuilderBase<?,?> builder)	Create an instance providing a builder.

Method Summary

Modifier and Type	Method	Description
Set<Class<? extends Throwable>>	applyOn()	These throwables will be considered failures.
CircuitBreaker	build()	Create a new runtime instance from this prototype.
Duration	delay()	How long to wait before transitioning from open to half-open state; must not be negative and must be small enough to represent in milliseconds.
boolean	enableMetrics()	Flag to enable metrics for this instance.
boolean	equals(Object o)
int	errorRatio()	How many failures out of 100 will trigger the circuit to open; must be between 1 and 100, inclusive, and its product with the configured volume must not exceed 2,147,483,647.
Optional<ExecutorService>	executor()	Executor service to schedule future tasks.
CircuitBreaker	get()
int	hashCode()
Optional<String>	name()	Name of this circuit breaker.
Set<Class<? extends Throwable>>	skipOn()	These throwables will not be considered failures, all other will.
int	successThreshold()	How many successful calls will close a half-open circuit; must be at least 1.
String	toString()
int	volume()	Rolling window size used to calculate ratio of failed requests; must be at least 1 and its product with the configured error ratio must not exceed 2,147,483,647.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_ERROR_RATIO

static final int DEFAULT_ERROR_RATIO

Default error ratio.

See Also:

• Constant Field Values

DEFAULT_SUCCESS_THRESHOLD

static final int DEFAULT_SUCCESS_THRESHOLD

Default success threshold.

See Also:

• Constant Field Values

DEFAULT_VOLUME

static final int DEFAULT_VOLUME

Default volume.

See Also:

• Constant Field Values

Constructor Details

CircuitBreakerConfigImpl

protected CircuitBreakerConfigImpl(CircuitBreakerConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

build

public CircuitBreaker build()

Create a new runtime instance from this prototype.

Specified by:

build in interface Prototype.Factory<CircuitBreaker>

Returns:

new configured runtime instance

get

public CircuitBreaker get()

Specified by:

get in interface Supplier<CircuitBreaker>

name

public Optional<String> name()

Description copied from interface: CircuitBreakerConfig

Name of this circuit breaker.

Specified by:

name in interface CircuitBreakerConfig

Returns:

name

delay

public Duration delay()

Description copied from interface: CircuitBreakerConfig

How long to wait before transitioning from open to half-open state; must not be negative and must be small enough to represent in milliseconds.

Specified by:

delay in interface CircuitBreakerConfig

Returns:

delay

errorRatio

public int errorRatio()

Description copied from interface: CircuitBreakerConfig

How many failures out of 100 will trigger the circuit to open; must be between 1 and 100, inclusive, and its product with the configured volume must not exceed 2,147,483,647. This is adapted to the CircuitBreakerConfig.volume() used to handle the window of requests.

If errorRatio is 40, and volume is 10, 4 failed requests will open the circuit. Default is 60.

Specified by:

errorRatio in interface CircuitBreakerConfig

Returns:

percent of failure that trigger the circuit to open

See Also:

• CircuitBreakerConfig.volume()

volume

public int volume()

Description copied from interface: CircuitBreakerConfig

Rolling window size used to calculate ratio of failed requests; must be at least 1 and its product with the configured error ratio must not exceed 2,147,483,647. Default is 10.

Specified by:

volume in interface CircuitBreakerConfig

Returns:

how big a window is used to calculate error errorRatio

See Also:

• CircuitBreakerConfig.errorRatio()

successThreshold

public int successThreshold()

Description copied from interface: CircuitBreakerConfig

How many successful calls will close a half-open circuit; must be at least 1. Nevertheless, the first failed call will open the circuit again. Default is 1.

Specified by:

successThreshold in interface CircuitBreakerConfig

Returns:

number of calls

executor

public Optional<ExecutorService> executor()

Description copied from interface: CircuitBreakerConfig

Executor service to schedule future tasks.

Specified by:

executor in interface CircuitBreakerConfig

Returns:

executor to use

skipOn

public Set<Class<? extends Throwable>> skipOn()

Description copied from interface: CircuitBreakerConfig

These throwables will not be considered failures, all other will.

Specified by:

skipOn in interface CircuitBreakerConfig

Returns:

throwable classes to not be considered a failure

See Also:

• CircuitBreakerConfig.applyOn()

applyOn

public Set<Class<? extends Throwable>> applyOn()

Description copied from interface: CircuitBreakerConfig

These throwables will be considered failures.

Specified by:

applyOn in interface CircuitBreakerConfig

Returns:

throwable classes to be considered a failure

See Also:

• CircuitBreakerConfig.skipOn()

enableMetrics

public boolean enableMetrics()

Description copied from interface: CircuitBreakerConfig

Flag to enable metrics for this instance. The value of this flag is combined with the global config entry FaultTolerance.FT_METRICS_DEFAULT_ENABLED. If either of these flags is true, then metrics will be enabled for the instance.

Specified by:

enableMetrics in interface CircuitBreakerConfig

Returns:

metrics enabled flag

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object