Interface BackOffPolicy

    • Field Summary

      Fields

      Modifier and Type Field and Description
      static long STOP
      Deprecated. 
      Value indicating that no more retries should be made, see getNextBackOffMillis().
    • Method Summary

      Modifier and Type Method and Description
      long getNextBackOffMillis()
      Deprecated. 
      Gets the number of milliseconds to wait before retrying an HTTP request.
      boolean isBackOffRequired(int statusCode)
      Deprecated. 
      Determines if back off is required based on the specified status code.
      void reset()
      Deprecated. 
      Reset Back off counters (if any) in an implementation-specific fashion.
    • Method Detail

      • isBackOffRequired

        boolean isBackOffRequired(int statusCode)
        Deprecated. 
        Determines if back off is required based on the specified status code.

        Implementations may want to back off on server or product-specific errors.

        Parameters:
        statusCode - HTTP status code
      • reset

        void reset()
        Deprecated. 
        Reset Back off counters (if any) in an implementation-specific fashion.
      • getNextBackOffMillis

        long getNextBackOffMillis()
                           throws IOException
        Deprecated. 
        Gets the number of milliseconds to wait before retrying an HTTP request. If STOP is returned, no retries should be made. This method should be used as follows:
          long backoffTime = backoffPolicy.getNextBackoffMs();
          if (backoffTime == BackoffPolicy.STOP) {
            // Stop retrying.
          } else {
            // Retry after backoffTime.
          }
        
        Returns:
        the number of milliseconds to wait when backing off requests, or STOP if no more retries should be made
        Throws:
        IOException