Package com.broadleafcommerce.search.util.properties

Class RetryAndTimeoutExternalServiceProperties

java.lang.Object
com.broadleafcommerce.search.util.properties.RetryAndTimeoutExternalServiceProperties
public class RetryAndTimeoutExternalServiceProperties extends Object
Configuration properties to support end-to-end timeout and retry behavior.

This class is intended to be used as a NestedConfigurationProperty within any provider-specific configuration that needs to participate in standardized timeout and retry handling.

  • Constructor Details

    • RetryAndTimeoutExternalServiceProperties

      public RetryAndTimeoutExternalServiceProperties()

  • Method Details

    • getRetryMaxAttempts

      public int getRetryMaxAttempts()
      The maximum number of times to retry a failed request.

    • getEndToEndTimeout

      public Duration getEndToEndTimeout()
      This is an end-to-end timeout for sending the request as well as getting back a complete response. This is useful to put a maximum bound on an API call, regardless of what happens.

    • getRetryMinBackoffDuration

      public Duration getRetryMinBackoffDuration()
      The minimum duration for the first backoff.

    • isWaitTimeAdditive

      public boolean isWaitTimeAdditive()
      Indicates if the wait time should be increased by the previous wait time on each try

    • setRetryMaxAttempts

      public void setRetryMaxAttempts(int retryMaxAttempts)
      The maximum number of times to retry a failed request.

    • setEndToEndTimeout

      public void setEndToEndTimeout(Duration endToEndTimeout)
      This is an end-to-end timeout for sending the request as well as getting back a complete response. This is useful to put a maximum bound on an API call, regardless of what happens.

    • setRetryMinBackoffDuration

      public void setRetryMinBackoffDuration(Duration retryMinBackoffDuration)
      The minimum duration for the first backoff.

    • setWaitTimeAdditive

      public void setWaitTimeAdditive(boolean waitTimeAdditive)
      Indicates if the wait time should be increased by the previous wait time on each try

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object