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

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

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

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(RetryConfig 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(RetryConfig.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 RetryConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends RetryConfig>
      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 RetryConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends RetryConfig>
      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 retry
      Returns:
      updated builder instance
      See Also:

    • calls

      public BUILDER calls(int calls)
      Number of calls (first try + retries).
      Parameters:
      calls - number of desired calls, must be 1 (means no retries) or higher.
      Returns:
      updated builder instance
      See Also:

    • delay

      public BUILDER delay(Duration delay)
      Base delay between try and retry. Defaults to 200 ms.
      Parameters:
      delay - delay between retries (combines with retry policy)
      Returns:
      updated builder instance
      See Also:

    • delayFactor

      public BUILDER delayFactor(double delayFactor)
      Delay retry policy factor. If unspecified (value of -1), Jitter retry policy would be used, unless jitter is also unspecified.

      Default when Retry.DelayingRetryPolicy is used is 2.

      Parameters:
      delayFactor - delay factor for delaying retry policy
      Returns:
      updated builder instance
      See Also:

    • jitter

      public BUILDER jitter(Duration jitter)
      Jitter for Retry.JitterRetryPolicy. If unspecified (value of -1), delaying retry policy is used. If both this value, and delayFactor() are specified, delaying retry policy would be used.
      Parameters:
      jitter - jitter
      Returns:
      updated builder instance
      See Also:

    • overallTimeout

      public BUILDER overallTimeout(Duration overallTimeout)
      Overall timeout of all retries combined.
      Parameters:
      overallTimeout - overall timeout
      Returns:
      updated builder instance
      See Also:

    • clearSkipOn

      public BUILDER clearSkipOn()
      Clear all skipOn.
      Returns:
      updated builder instance
      See Also:

    • skipOn

      public BUILDER skipOn(Set<Class<? extends Throwable>> skipOn)
      These throwables will not be considered retriable, all other will.
      Parameters:
      skipOn - throwable classes to skip retries
      Returns:
      updated builder instance
      See Also:

    • addSkipOn

      public BUILDER addSkipOn(Set<Class<? extends Throwable>> skipOn)
      These throwables will not be considered retriable, all other will.
      Parameters:
      skipOn - throwable classes to skip retries
      Returns:
      updated builder instance
      See Also:

    • addSkipOn

      public BUILDER addSkipOn(Class<? extends Throwable> skipOn)
      These throwables will not be considered retriable, all other will.
      Parameters:
      skipOn - add single throwable classes to skip retries
      Returns:
      updated builder instance
      See Also:

    • clearApplyOn

      public BUILDER clearApplyOn()
      Clear all applyOn.
      Returns:
      updated builder instance
      See Also:

    • applyOn

      public BUILDER applyOn(Set<Class<? extends Throwable>> applyOn)
      These throwables will be considered retriable.
      Parameters:
      applyOn - throwable classes to trigger retries
      Returns:
      updated builder instance
      See Also:

    • addApplyOn

      public BUILDER addApplyOn(Set<Class<? extends Throwable>> applyOn)
      These throwables will be considered retriable.
      Parameters:
      applyOn - throwable classes to trigger retries
      Returns:
      updated builder instance
      See Also:

    • addApplyOn

      public BUILDER addApplyOn(Class<? extends Throwable> applyOn)
      These throwables will be considered retriable.
      Parameters:
      applyOn - add single throwable classes to trigger retries
      Returns:
      updated builder instance
      See Also:

    • clearRetryPolicy

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

    • retryPolicy

      public BUILDER retryPolicy(Retry.RetryPolicy retryPolicy)
      Explicitly configured retry policy.
      Parameters:
      retryPolicy - retry policy
      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 retry

    • calls

      public int calls()
      Number of calls (first try + retries).
      Returns:
      number of desired calls, must be 1 (means no retries) or higher.

    • delay

      public Duration delay()
      Base delay between try and retry. Defaults to 200 ms.
      Returns:
      delay between retries (combines with retry policy)

    • delayFactor

      public double delayFactor()
      Delay retry policy factor. If unspecified (value of -1), Jitter retry policy would be used, unless jitter is also unspecified.

      Default when Retry.DelayingRetryPolicy is used is 2.

      Returns:
      delay factor for delaying retry policy

    • jitter

      public Duration jitter()
      Jitter for Retry.JitterRetryPolicy. If unspecified (value of -1), delaying retry policy is used. If both this value, and delayFactor() are specified, delaying retry policy would be used.
      Returns:
      jitter

    • overallTimeout

      public Duration overallTimeout()
      Overall timeout of all retries combined.
      Returns:
      overall timeout

    • skipOn

      public Set<Class<? extends Throwable>> skipOn()
      These throwables will not be considered retriable, all other will.
      Returns:
      throwable classes to skip retries
      See Also:

    • applyOn

      public Set<Class<? extends Throwable>> applyOn()
      These throwables will be considered retriable.
      Returns:
      throwable classes to trigger retries
      See Also:

    • retryPolicy

      public Optional<Retry.RetryPolicy> retryPolicy()
      Explicitly configured retry policy.
      Returns:
      retry policy

    • 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