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 java.io.IOException;
31  
32  import org.apache.http.protocol.HttpContext;
33  
34  /**
35   * A handler for determining if an HttpRequest should be retried after a
36   * recoverable exception during execution.
37   * <p>
38   * Implementations of this interface must be thread-safe. Access to shared
39   * data must be synchronized as methods of this interface may be executed
40   * from multiple threads.
41   *
42   * @since 4.0
43   */
44  public interface HttpRequestRetryHandler {
45  
46      /**
47       * Determines if a method should be retried after an IOException
48       * occurs during execution.
49       *
50       * @param exception the exception that occurred
51       * @param executionCount the number of times this method has been
52       * unsuccessfully executed
53       * @param context the context for the request execution
54       *
55       * @return {@code true} if the method should be retried, {@code false}
56       * otherwise
57       */
58      boolean retryRequest(IOException exception, int executionCount, HttpContext context);
59  
60  }