org.springframework.util.backoff

Class FixedBackOff

  • java.lang.Object
    • org.springframework.util.backoff.FixedBackOff
  • All Implemented Interfaces:
    BackOff


    public class FixedBackOff
    extends java.lang.Object
    implements BackOff
    A simple BackOff implementation that provides a fixed interval between two attempts and a maximum number of retries.
    Since:
    4.1
    Author:
    Stephane Nicoll
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static long DEFAULT_INTERVAL
      The default recovery interval: 5000 ms = 5 seconds.
      static long UNLIMITED_ATTEMPTS
      Constant value indicating an unlimited number of attempts.
    • Constructor Summary

      Constructors 
      Constructor and Description
      FixedBackOff()
      Create an instance with an interval of 5000L ms and an unlimited number of attempts.
      FixedBackOff(long interval, long maxAttempts)
      Create an instance.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      long getInterval()
      Return the interval between two attempts in milliseconds.
      long getMaxAttempts()
      Return the maximum number of attempts in milliseconds.
      void setInterval(long interval)
      Set the interval between two attempts in milliseconds.
      void setMaxAttempts(long maxAttempts)
      Set the maximum number of attempts in milliseconds.
      BackOffExecution start()
      Start a new back off execution.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • DEFAULT_INTERVAL

        public static final long DEFAULT_INTERVAL
        The default recovery interval: 5000 ms = 5 seconds.
        See Also:
        Constant Field Values
      • UNLIMITED_ATTEMPTS

        public static final long UNLIMITED_ATTEMPTS
        Constant value indicating an unlimited number of attempts.
        See Also:
        Constant Field Values
    • Constructor Detail

      • FixedBackOff

        public FixedBackOff()
        Create an instance with an interval of 5000L ms and an unlimited number of attempts.
      • FixedBackOff

        public FixedBackOff(long interval,
                            long maxAttempts)
        Create an instance.
        Parameters:
        interval - the interval between two attempts
        maxAttempts - the maximum number of attempts
    • Method Detail

      • setInterval

        public void setInterval(long interval)
        Set the interval between two attempts in milliseconds.
      • getInterval

        public long getInterval()
        Return the interval between two attempts in milliseconds.
      • setMaxAttempts

        public void setMaxAttempts(long maxAttempts)
        Set the maximum number of attempts in milliseconds.
      • getMaxAttempts

        public long getMaxAttempts()
        Return the maximum number of attempts in milliseconds.