1 /*
2 * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/MethodRetryHandler.java,v 1.2.2.1 2004/02/22 18:21:13 olegk Exp $
3 * $Revision: 1.2.2.1 $
4 * $Date: 2004/02/22 18:21:13 $
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 * [Additional notices, if required by prior licensing conditions]
29 *
30 */
31
32 package org.apache.commons.httpclient;
33
34 /***
35 * A handler for determining if an HttpMethod should be retried after a
36 * recoverable exception during execution.
37 *
38 * @see HttpMethod#execute(HttpState, HttpConnection)
39 * @see HttpRecoverableException
40 *
41 * @author Michael Becke
42 */
43 public interface MethodRetryHandler {
44
45 /***
46 * Determines if a method should be retried after an HttpRecoverableException
47 * occurs during execution.
48 *
49 * @param method the method being executed
50 * @param connection the connection the method is using
51 * @param recoverableException the exception that occurred
52 * @param executionCount the number of times this method has been
53 * unsuccessfully executed
54 * @param requestSent a flag indicating if the request has been fully sent or not
55 *
56 * @return <code>true</code> if the method should be retried, <code>false</code>
57 * otherwise
58 */
59 boolean retryMethod(
60 HttpMethod method,
61 HttpConnection connection,
62 HttpRecoverableException recoverableException,
63 int executionCount,
64 boolean requestSent);
65
66 }