1 /*
2 * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/java/org/apache/commons/httpclient/HttpMethodRetryHandler.java,v 1.2 2004/09/14 20:11:31 olegk Exp $
3 * $Revision: 224452 $
4 * $Date: 2005-07-23 06:33:39 -0400 (Sat, 23 Jul 2005) $
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 import java.io.IOException;
33
34 /***
35 * A handler for determining if an HttpMethod should be retried after a
36 * recoverable exception during execution.
37 *
38 * <p>
39 * Classes implementing this interface must synchronize access to shared
40 * data as methods of this interfrace may be executed from multiple threads
41 * </p>
42 *
43 * @see HttpMethod#execute(HttpState, HttpConnection)
44 *
45 * @author Michael Becke
46 * @author <a href="mailto:oleg -at- ural.ru">Oleg Kalnichevski</a>
47 */
48 public interface HttpMethodRetryHandler {
49
50 /***
51 * Determines if a method should be retried after an HttpRecoverableException
52 * occurs during execution.
53 *
54 * @param method the method being executed
55 * @param exception the exception that occurred
56 * @param executionCount the number of times this method has been
57 * unsuccessfully executed
58 *
59 * @return <code>true</code> if the method should be retried, <code>false</code>
60 * otherwise
61 */
62 boolean retryMethod(HttpMethod method, IOException exception, int executionCount);
63
64 }