View Javadoc

1   /*
2    * $HeadURL: https://svn.apache.org/repos/asf/httpcomponents/oac.hc3x/trunk/src/java/org/apache/commons/httpclient/HttpMethodRetryHandler.java $
3    * $Revision: 1425331 $
4    * $Date: 2012-12-22 19:29:41 +0100 (Sat, 22 Dec 2012) $
5    *
6    * ====================================================================
7    *
8    *  Licensed to the Apache Software Foundation (ASF) under one or more
9    *  contributor license agreements.  See the NOTICE file distributed with
10   *  this work for additional information regarding copyright ownership.
11   *  The ASF licenses this file to You under the Apache License, Version 2.0
12   *  (the "License"); you may not use this file except in compliance with
13   *  the License.  You may obtain a copy of the License at
14   *
15   *      http://www.apache.org/licenses/LICENSE-2.0
16   *
17   *  Unless required by applicable law or agreed to in writing, software
18   *  distributed under the License is distributed on an "AS IS" BASIS,
19   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20   *  See the License for the specific language governing permissions and
21   *  limitations under the License.
22   * ====================================================================
23   *
24   * This software consists of voluntary contributions made by many
25   * individuals on behalf of the Apache Software Foundation.  For more
26   * information on the Apache Software Foundation, please see
27   * <http://www.apache.org/>.
28   *
29   */
30  
31  package org.apache.commons.httpclient;
32  
33  import java.io.IOException;
34  
35  /***
36   * A handler for determining if an HttpMethod should be retried after a 
37   * recoverable exception during execution.
38   * 
39   * <p>
40   * Classes implementing this interface must synchronize access to shared
41   * data as methods of this interfrace may be executed from multiple threads 
42   * </p>
43   * 
44   * @see HttpMethod#execute(HttpState, HttpConnection)
45   * 
46   * @author Michael Becke
47   * @author <a href="mailto:oleg -at- ural.ru">Oleg Kalnichevski</a>
48   */
49  public interface HttpMethodRetryHandler {
50  
51      /***
52       * Determines if a method should be retried after an HttpRecoverableException
53       * occurs during execution.
54       * 
55       * @param method the method being executed
56       * @param exception the exception that occurred
57       * @param executionCount the number of times this method has been 
58       * unsuccessfully executed
59       * 
60       * @return <code>true</code> if the method should be retried, <code>false</code>
61       * otherwise
62       */
63      boolean retryMethod(HttpMethod method, IOException exception, int executionCount);
64  
65  }