1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>DefaultMethodRetryHandler xref</title>
5
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
8
<div id="overview"><a href="../../../../../apidocs/org/apache/commons/httpclient/DefaultMethodRetryHandler.html">View Javadoc</a></div><pre>
10
<a name="1" href="#1">1</a> <em class="comment">/*</em>
11
<a name="2" href="#2">2</a> <em class="comment"> * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/DefaultMethodRetryHandler.java,v 1.1.2.1 2004/02/22 18:21:13 olegk Exp $</em>
12
<a name="3" href="#3">3</a> <em class="comment"> * $Revision: 1.1.2.1 $</em>
13
<a name="4" href="#4">4</a> <em class="comment"> * $Date: 2004/02/22 18:21:13 $</em>
14
<a name="5" href="#5">5</a> <em class="comment"> *</em>
15
<a name="6" href="#6">6</a> <em class="comment"> * ====================================================================</em>
16
<a name="7" href="#7">7</a> <em class="comment"> *</em>
17
<a name="8" href="#8">8</a> <em class="comment"> * Copyright 1999-2004 The Apache Software Foundation</em>
18
<a name="9" href="#9">9</a> <em class="comment"> *</em>
19
<a name="10" href="#10">10</a> <em class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
20
<a name="11" href="#11">11</a> <em class="comment"> * you may not use this file except in compliance with the License.</em>
21
<a name="12" href="#12">12</a> <em class="comment"> * You may obtain a copy of the License at</em>
22
<a name="13" href="#13">13</a> <em class="comment"> *</em>
23
<a name="14" href="#14">14</a> <em class="comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
24
<a name="15" href="#15">15</a> <em class="comment"> *</em>
25
<a name="16" href="#16">16</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
26
<a name="17" href="#17">17</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
27
<a name="18" href="#18">18</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
28
<a name="19" href="#19">19</a> <em class="comment"> * See the License for the specific language governing permissions and</em>
29
<a name="20" href="#20">20</a> <em class="comment"> * limitations under the License.</em>
30
<a name="21" href="#21">21</a> <em class="comment"> * ====================================================================</em>
31
<a name="22" href="#22">22</a> <em class="comment"> *</em>
32
<a name="23" href="#23">23</a> <em class="comment"> * This software consists of voluntary contributions made by many</em>
33
<a name="24" href="#24">24</a> <em class="comment"> * individuals on behalf of the Apache Software Foundation. For more</em>
34
<a name="25" href="#25">25</a> <em class="comment"> * information on the Apache Software Foundation, please see</em>
35
<a name="26" href="#26">26</a> <em class="comment"> * <<a href="http://www.apache.org/" target="alexandria_uri">http://www.apache.org/</a>>.</em>
36
<a name="27" href="#27">27</a> <em class="comment"> *</em>
37
<a name="28" href="#28">28</a> <em class="comment"> * [Additional notices, if required by prior licensing conditions]</em>
38
<a name="29" href="#29">29</a> <em class="comment"> *</em>
39
<a name="30" href="#30">30</a> <em class="comment"> */</em>
40
<a name="31" href="#31">31</a>
41
<a name="32" href="#32">32</a> <strong>package</strong> <a href="../../../../org/apache/commons/httpclient/package-summary.html">org.apache.commons.httpclient</a>;
42
<a name="33" href="#33">33</a>
43
<a name="34" href="#34">34</a> <em>/**<em>*</em></em>
44
<a name="35" href="#35">35</a> <em> * The default MethodRetryHandler used by HttpMethodBase.</em>
45
<a name="36" href="#36">36</a> <em> * </em>
46
<a name="37" href="#37">37</a> <em> * @author Michael Becke</em>
47
<a name="38" href="#38">38</a> <em> * </em>
48
<a name="39" href="#39">39</a> <em> * @see HttpMethodBase#setMethodRetryHandler(MethodRetryHandler)</em>
49
<a name="40" href="#40">40</a> <em> */</em>
50
<a name="41" href="#41">41</a> <strong>public</strong> <strong>class</strong> <a href="../../../../org/apache/commons/httpclient/DefaultMethodRetryHandler.html">DefaultMethodRetryHandler</a> implements <a href="../../../../org/apache/commons/httpclient/MethodRetryHandler.html">MethodRetryHandler</a> {
51
<a name="42" href="#42">42</a>
52
<a name="43" href="#43">43</a> <em>/**<em>* the number of times a method will be retried */</em></em>
53
<a name="44" href="#44">44</a> <strong>private</strong> <strong>int</strong> retryCount;
54
<a name="45" href="#45">45</a>
55
<a name="46" href="#46">46</a> <em>/**<em>* Whether or not methods that have successfully sent their request will be retried */</em></em>
56
<a name="47" href="#47">47</a> <strong>private</strong> <strong>boolean</strong> requestSentRetryEnabled;
57
<a name="48" href="#48">48</a>
58
<a name="49" href="#49">49</a> <em>/**<em>*</em></em>
59
<a name="50" href="#50">50</a> <em> */</em>
60
<a name="51" href="#51">51</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/DefaultMethodRetryHandler.html">DefaultMethodRetryHandler</a>() {
61
<a name="52" href="#52">52</a> <strong>this</strong>.retryCount = 3;
62
<a name="53" href="#53">53</a> <strong>this</strong>.requestSentRetryEnabled = false;
63
<a name="54" href="#54">54</a> }
64
<a name="55" href="#55">55</a>
65
<a name="56" href="#56">56</a> <em>/**<em>* </em></em>
66
<a name="57" href="#57">57</a> <em> * Used <code>retryCount</code> and <code>requestSentRetryEnabled</code> to determine</em>
67
<a name="58" href="#58">58</a> <em> * if the given method should be retried.</em>
68
<a name="59" href="#59">59</a> <em> * </em>
69
<a name="60" href="#60">60</a> <em> * @see MethodRetryHandler#retryMethod(HttpMethod, HttpConnection, HttpRecoverableException, int, boolean)</em>
70
<a name="61" href="#61">61</a> <em> */</em>
71
<a name="62" href="#62">62</a> <strong>public</strong> <strong>boolean</strong> retryMethod(
72
<a name="63" href="#63">63</a> <a href="../../../../org/apache/commons/httpclient/HttpMethod.html">HttpMethod</a> method,
73
<a name="64" href="#64">64</a> <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> connection,
74
<a name="65" href="#65">65</a> <a href="../../../../org/apache/commons/httpclient/HttpRecoverableException.html">HttpRecoverableException</a> recoverableException,
75
<a name="66" href="#66">66</a> <strong>int</strong> executionCount,
76
<a name="67" href="#67">67</a> <strong>boolean</strong> requestSent
77
<a name="68" href="#68">68</a> ) {
78
<a name="69" href="#69">69</a> <strong>return</strong> ((!requestSent || requestSentRetryEnabled) && (executionCount <= retryCount));
79
<a name="70" href="#70">70</a> }
80
<a name="71" href="#71">71</a> <em>/**<em>*</em></em>
81
<a name="72" href="#72">72</a> <em> * @return <code>true</code> if this handler will retry methods that have </em>
82
<a name="73" href="#73">73</a> <em> * successfully sent their request, <code>false</code> otherwise</em>
83
<a name="74" href="#74">74</a> <em> */</em>
84
<a name="75" href="#75">75</a> <strong>public</strong> <strong>boolean</strong> isRequestSentRetryEnabled() {
85
<a name="76" href="#76">76</a> <strong>return</strong> requestSentRetryEnabled;
86
<a name="77" href="#77">77</a> }
87
<a name="78" href="#78">78</a>
88
<a name="79" href="#79">79</a> <em>/**<em>*</em></em>
89
<a name="80" href="#80">80</a> <em> * @return the maximum number of times a method will be retried</em>
90
<a name="81" href="#81">81</a> <em> */</em>
91
<a name="82" href="#82">82</a> <strong>public</strong> <strong>int</strong> getRetryCount() {
92
<a name="83" href="#83">83</a> <strong>return</strong> retryCount;
93
<a name="84" href="#84">84</a> }
94
<a name="85" href="#85">85</a>
95
<a name="86" href="#86">86</a> <em>/**<em>*</em></em>
96
<a name="87" href="#87">87</a> <em> * @param requestSentRetryEnabled a flag indicating if methods that have </em>
97
<a name="88" href="#88">88</a> <em> * successfully sent their request should be retried</em>
98
<a name="89" href="#89">89</a> <em> */</em>
99
<a name="90" href="#90">90</a> <strong>public</strong> <strong>void</strong> setRequestSentRetryEnabled(<strong>boolean</strong> requestSentRetryEnabled) {
100
<a name="91" href="#91">91</a> <strong>this</strong>.requestSentRetryEnabled = requestSentRetryEnabled;
101
<a name="92" href="#92">92</a> }
102
<a name="93" href="#93">93</a>
103
<a name="94" href="#94">94</a> <em>/**<em>*</em></em>
104
<a name="95" href="#95">95</a> <em> * @param retryCount the maximum number of times a method can be retried</em>
105
<a name="96" href="#96">96</a> <em> */</em>
106
<a name="97" href="#97">97</a> <strong>public</strong> <strong>void</strong> setRetryCount(<strong>int</strong> retryCount) {
107
<a name="98" href="#98">98</a> <strong>this</strong>.retryCount = retryCount;
108
<a name="99" href="#99">99</a> }
109
<a name="100" href="#100">100</a>
110
<a name="101" href="#101">101</a> }
112
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>