Module io.helidon.faulttolerance
Package io.helidon.faulttolerance

Class BulkheadConfig.BuilderBase<BUILDER extends BulkheadConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends BulkheadConfig>

java.lang.Object
io.helidon.faulttolerance.BulkheadConfig.BuilderBase<BUILDER,PROTOTYPE>
Type Parameters:
BUILDER - type of the builder extending this abstract builder
PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()
All Implemented Interfaces:
Prototype.Builder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Direct Known Subclasses:
BulkheadConfig.Builder
Enclosing interface:
BulkheadConfig
public abstract static class BulkheadConfig.BuilderBase<BUILDER extends BulkheadConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends BulkheadConfig> extends Object implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Fluent API builder base for Bulkhead.

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(BulkheadConfig prototype)
      Update this builder from an existing prototype instance. This method disables automatic service discovery.
      Parameters:
      prototype - existing prototype to update this builder from
      Returns:
      updated builder instance

    • from

      public BUILDER from(BulkheadConfig.BuilderBase<?,?> builder)
      Update this builder from an existing prototype builder instance.
      Parameters:
      builder - existing builder prototype to update this builder from
      Returns:
      updated builder instance

    • config

      @Deprecated public BUILDER config(Config config)
      Deprecated.
      use config(io.helidon.config.Config)
      Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.
      Specified by:
      config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends BulkheadConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends BulkheadConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • config

      public BUILDER config(Config config)
      Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.
      Specified by:
      config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends BulkheadConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends BulkheadConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • limit

      public BUILDER limit(int limit)
      Maximal number of parallel requests going through this bulkhead. When the limit is reached, additional requests are enqueued.
      Parameters:
      limit - maximal number of parallel calls, defaults is 10
      Returns:
      updated builder instance
      See Also:

    • queueLength

      public BUILDER 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.
      Parameters:
      queueLength - length of the queue
      Returns:
      updated builder instance
      See Also:

    • queueListeners

      public BUILDER queueListeners(List<? extends Bulkhead.QueueListener> queueListeners)
      Queue listeners of this bulkhead.
      Parameters:
      queueListeners - queue listeners
      Returns:
      updated builder instance
      See Also:

    • addQueueListeners

      public BUILDER addQueueListeners(List<? extends Bulkhead.QueueListener> queueListeners)
      Queue listeners of this bulkhead.
      Parameters:
      queueListeners - queue listeners
      Returns:
      updated builder instance
      See Also:

    • addQueueListener

      public BUILDER addQueueListener(Bulkhead.QueueListener queueListener)
      Queue listeners of this bulkhead.
      Parameters:
      queueListener - queue listeners
      Returns:
      updated builder instance
      See Also:

    • clearName

      public BUILDER clearName()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • name

      public BUILDER name(String name)
      Name for debugging, error reporting, monitoring.
      Parameters:
      name - name of this bulkhead
      Returns:
      updated builder instance
      See Also:

    • enableMetrics

      public BUILDER 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.
      Parameters:
      enableMetrics - metrics enabled flag
      Returns:
      updated builder instance
      See Also:

    • limit

      public int limit()
      Maximal number of parallel requests going through this bulkhead. When the limit is reached, additional requests are enqueued.
      Returns:
      the limit

    • queueLength

      public 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:
      the queue length

    • queueListeners

      public List<Bulkhead.QueueListener> queueListeners()
      Queue listeners of this bulkhead.
      Returns:
      the queue listeners

    • name

      public Optional<String> name()
      Name for debugging, error reporting, monitoring.
      Returns:
      the name

    • enableMetrics

      public 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:
      the enable metrics

    • config

      public Optional<Config> config()
      If this instance was configured, this would be the config instance used.
      Returns:
      config node used to configure this builder, or empty if not configured

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • preBuildPrototype

      protected void preBuildPrototype()
      Handles providers and decorators.

    • validatePrototype

      protected void validatePrototype()
      Validates required properties.