View Javadoc

1   /*
2    * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/MethodRetryHandler.java,v 1.4 2004/04/18 23:51:35 jsdever Exp $
3    * $Revision: 1.4 $
4    * $Date: 2004/04/18 23:51:35 $
5    *
6    * ====================================================================
7    *
8    *  Copyright 1999-2004 The Apache Software Foundation
9    *
10   *  Licensed under the Apache License, Version 2.0 (the "License");
11   *  you may not use this file except in compliance with the License.
12   *  You may obtain a copy of the License at
13   *
14   *      http://www.apache.org/licenses/LICENSE-2.0
15   *
16   *  Unless required by applicable law or agreed to in writing, software
17   *  distributed under the License is distributed on an "AS IS" BASIS,
18   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19   *  See the License for the specific language governing permissions and
20   *  limitations under the License.
21   * ====================================================================
22   *
23   * This software consists of voluntary contributions made by many
24   * individuals on behalf of the Apache Software Foundation.  For more
25   * information on the Apache Software Foundation, please see
26   * <http://www.apache.org/>.
27   *
28   */
29  
30  package org.apache.commons.httpclient;
31  
32  /***
33   * A handler for determining if an HttpMethod should be retried after a 
34   * recoverable exception during execution.
35   * 
36   * @see HttpMethod#execute(HttpState, HttpConnection)
37   * @see HttpRecoverableException
38   * 
39   * @author Michael Becke
40   */
41  public interface MethodRetryHandler {
42  
43      /***
44       * Determines if a method should be retried after an HttpRecoverableException
45       * occurs during execution.
46       * 
47       * @param method the method being executed
48       * @param connection the connection the method is using
49       * @param recoverableException the exception that occurred
50       * @param executionCount the number of times this method has been 
51       * unsuccessfully executed
52       * @param requestSent a flag indicating if the request has been fully sent or not
53       * 
54       * @return <code>true</code> if the method should be retried, <code>false</code>
55       * otherwise
56       */
57      boolean retryMethod(
58          HttpMethod method, 
59          HttpConnection connection,
60          HttpRecoverableException recoverableException,
61          int executionCount,
62          boolean requestSent);
63  
64  }