Module io.helidon.faulttolerance

Package io.helidon.faulttolerance

Interface BulkheadConfig

All Superinterfaces:

Prototype.Api, Prototype.Factory<Bulkhead>

All Known Implementing Classes:

BulkheadConfig.BuilderBase.BulkheadConfigImpl

public interface BulkheadConfig
extends Prototype.Api

Bulkhead configuration bean.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_LIMIT	Default limit.
static final int	DEFAULT_QUEUE_LENGTH	Default queue lengths.

Method Summary

Modifier and Type	Method	Description
static BulkheadConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static BulkheadConfig.Builder	builder(BulkheadConfig instance)	Create a new fluent API builder from an existing instance.
static BulkheadConfig	create()	Create a new instance with default values.
static BulkheadConfig	create(Config config)	Create a new instance from configuration.
boolean	enableMetrics()	Flag to enable metrics for this instance.
int	limit()	Maximal number of parallel requests going through this bulkhead.
Optional<String>	name()	Name for debugging, error reporting, monitoring.
int	queueLength()	Maximal number of enqueued requests waiting for processing.
List<Bulkhead.QueueListener>	queueListeners()	Queue listeners of this bulkhead.

Methods inherited from interface io.helidon.builder.api.Prototype.Factory

build

Field Details

DEFAULT_LIMIT

static final int DEFAULT_LIMIT

Default limit.

See Also:

• limit()
• Constant Field Values

DEFAULT_QUEUE_LENGTH

static final int DEFAULT_QUEUE_LENGTH

Default queue lengths.

See Also:

• queueLength()
• Constant Field Values

Method Details

builder

static BulkheadConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static BulkheadConfig.Builder builder(BulkheadConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static BulkheadConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static BulkheadConfig create()

Create a new instance with default values.

Returns:

a new instance

limit

int limit()

Maximal number of parallel requests going through this bulkhead. When the limit is reached, additional requests are enqueued.

Returns:

maximal number of parallel calls, defaults is 10

queueLength

int queueLength()

Maximal number of enqueued requests waiting for processing. When the limit is reached, additional attempts to invoke a request will receive a BulkheadException.

Returns:

length of the queue

queueListeners

List<Bulkhead.QueueListener> queueListeners()

Queue listeners of this bulkhead.

Returns:

queue listeners

name

Optional<String> name()

Name for debugging, error reporting, monitoring.

Returns:

name of this bulkhead

enableMetrics

boolean enableMetrics()

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.

Returns:

metrics enabled flag