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

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

java.lang.Object
io.helidon.faulttolerance.TimeoutConfig.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:
TimeoutConfig.Builder
Enclosing interface:
TimeoutConfig
public abstract static class TimeoutConfig.BuilderBase<BUILDER extends TimeoutConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends TimeoutConfig> extends Object implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Fluent API builder base for TimeoutConfig.

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(TimeoutConfig 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(TimeoutConfig.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 TimeoutConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends TimeoutConfig>
      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 TimeoutConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends TimeoutConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • clearName

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

    • name

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

    • timeout

      public BUILDER timeout(Duration timeout)
      Duration to wait before timing out. Defaults to 10 seconds.
      Parameters:
      timeout - timeout
      Returns:
      updated builder instance
      See Also:

    • currentThread

      public BUILDER currentThread(boolean currentThread)
      Flag to indicate that code must be executed in current thread instead of in an executor's thread. This flag is false by default.
      Parameters:
      currentThread - whether to execute on current thread (true), or in an executor service (false})
      Returns:
      updated builder instance
      See Also:

    • clearExecutor

      public BUILDER clearExecutor()
      Clear existing value of executor.
      Returns:
      updated builder instance
      See Also:

    • executor

      public BUILDER executor(ExecutorService executor)
      Executor service to schedule the timeout.
      Parameters:
      executor - executor service to use
      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:

    • name

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

    • timeout

      public Duration timeout()
      Duration to wait before timing out. Defaults to 10 seconds.
      Returns:
      timeout

    • currentThread

      public boolean currentThread()
      Flag to indicate that code must be executed in current thread instead of in an executor's thread. This flag is false by default.
      Returns:
      whether to execute on current thread (true), or in an executor service (false})

    • executor

      public Optional<ExecutorService> executor()
      Executor service to schedule the timeout.
      Returns:
      executor service to use

    • 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:
      metrics enabled flag

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • preBuildPrototype

      protected void preBuildPrototype()
      Handles providers and decorators.

    • validatePrototype

      protected void validatePrototype()
      Validates required properties.

    • config

      protected Optional<Config> config()
      Configuration used to configure this instance.
      Returns:
      config instance