View Javadoc

1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  package org.apache.http.client;
29  
30  import org.apache.http.HttpResponse;
31  import org.apache.http.protocol.HttpContext;
32  
33  /**
34   * Strategy interface that allows API users to plug in their own logic to
35   * control whether or not a retry should automatically be done, how many times
36   * it should be retried and so on.
37   *
38   * @since 4.2
39   */
40  public interface ServiceUnavailableRetryStrategy {
41  
42      /**
43       * Determines if a method should be retried given the response from the target server.
44       *
45       * @param response the response from the target server
46       * @param executionCount the number of times this method has been
47       * unsuccessfully executed
48       * @param context the context for the request execution
49  
50       * @return {@code true} if the method should be retried, {@code false}
51       * otherwise
52       */
53      boolean retryRequest(HttpResponse response, int executionCount, HttpContext context);
54  
55      /**
56       * @return The interval between the subsequent auto-retries.
57       */
58      long getRetryInterval();
59  
60  }