1 /*
2 * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/DefaultMethodRetryHandler.java,v 1.1 2003/05/01 12:27:42 mbecke Exp $
3 * $Revision: 1.1 $
4 * $Date: 2003/05/01 12:27:42 $
5 *
6 * ====================================================================
7 *
8 * The Apache Software License, Version 1.1
9 *
10 * Copyright (c) 1999-2003 The Apache Software Foundation. All rights
11 * reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 *
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in
22 * the documentation and/or other materials provided with the
23 * distribution.
24 *
25 * 3. The end-user documentation included with the redistribution, if
26 * any, must include the following acknowlegement:
27 * "This product includes software developed by the
28 * Apache Software Foundation (http://www.apache.org/)."
29 * Alternately, this acknowlegement may appear in the software itself,
30 * if and wherever such third-party acknowlegements normally appear.
31 *
32 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
33 * Foundation" must not be used to endorse or promote products derived
34 * from this software without prior written permission. For written
35 * permission, please contact apache@apache.org.
36 *
37 * 5. Products derived from this software may not be called "Apache"
38 * nor may "Apache" appear in their names without prior written
39 * permission of the Apache Group.
40 *
41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * SUCH DAMAGE.
53 * ====================================================================
54 *
55 * This software consists of voluntary contributions made by many
56 * individuals on behalf of the Apache Software Foundation. For more
57 * information on the Apache Software Foundation, please see
58 * <http://www.apache.org/>.
59 *
60 * [Additional notices, if required by prior licensing conditions]
61 *
62 */
63
64 package org.apache.commons.httpclient;
65
66 /***
67 * The default MethodRetryHandler used by HttpMethodBase.
68 *
69 * @author Michael Becke
70 *
71 * @see HttpMethodBase#setMethodRetryHandler(MethodRetryHandler)
72 */
73 public class DefaultMethodRetryHandler implements MethodRetryHandler {
74
75 /*** the number of times a method will be retried */
76 private int retryCount;
77
78 /*** Whether or not methods that have successfully sent their request will be retried */
79 private boolean requestSentRetryEnabled;
80
81 /***
82 */
83 public DefaultMethodRetryHandler() {
84 this.retryCount = 3;
85 this.requestSentRetryEnabled = false;
86 }
87
88 /***
89 * Used <code>retryCount</code> and <code>requestSentRetryEnabled</code> to determine
90 * if the given method should be retried.
91 *
92 * @see MethodRetryHandler#retryMethod(HttpMethod, HttpConnection, HttpRecoverableException, int, boolean)
93 */
94 public boolean retryMethod(
95 HttpMethod method,
96 HttpConnection connection,
97 HttpRecoverableException recoverableException,
98 int executionCount,
99 boolean requestSent
100 ) {
101 return ((!requestSent || requestSentRetryEnabled) && (executionCount <= retryCount));
102 }
103 /***
104 * @return <code>true</code> if this handler will retry methods that have
105 * successfully sent their request, <code>false</code> otherwise
106 */
107 public boolean isRequestSentRetryEnabled() {
108 return requestSentRetryEnabled;
109 }
110
111 /***
112 * @return the maximum number of times a method will be retried
113 */
114 public int getRetryCount() {
115 return retryCount;
116 }
117
118 /***
119 * @param requestSentRetryEnabled a flag indicating if methods that have
120 * successfully sent their request should be retried
121 */
122 public void setRequestSentRetryEnabled(boolean requestSentRetryEnabled) {
123 this.requestSentRetryEnabled = requestSentRetryEnabled;
124 }
125
126 /***
127 * @param retryCount the maximum number of times a method can be retried
128 */
129 public void setRetryCount(int retryCount) {
130 this.retryCount = retryCount;
131 }
132
133 }
This page was automatically generated by Maven