← Back to branch summary

~ubuntu-branches/ubuntu/lucid/commons-httpclient/lucid

« back to all changes in this revision

Viewing changes to docs/apidocs/org/apache/commons/httpclient/MethodRetryHandler.html

  • Committer: Bazaar Package Importer
  • Author(s): Barry Hawkins
  • Date: 2005-11-25 13:12:23 UTC
  • Revision ID: james.westby@ubuntu.com-20051125131223-2g7eyo21pqgrohpo
Tags: upstream-2.0.2
Import upstream version 2.0.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/apidocs/org/apache/commons/httpclient/MethodRetryHandler.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
 
2
<!--NewPage-->
 
3
<HTML>
 
4
<HEAD>
 
5
<!-- Generated by javadoc on Sun Oct 10 17:41:04 EDT 2004 -->
 
6
<TITLE>
 
7
HttpClient 2.0.2 API: Interface  MethodRetryHandler
 
8
</TITLE>
 
9
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
 
10
</HEAD>
 
11
<BODY BGCOLOR="white">
 
12
 
 
13
<!-- ========== START OF NAVBAR ========== -->
 
14
<A NAME="navbar_top"><!-- --></A>
 
15
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
 
16
<TR>
 
17
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 
18
<A NAME="navbar_top_firstrow"><!-- --></A>
 
19
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
 
20
  <TR ALIGN="center" VALIGN="top">
 
21
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 
22
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 
23
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 
24
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/MethodRetryHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 
25
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 
26
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 
27
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 
28
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 
29
  </TR>
 
30
</TABLE>
 
31
</TD>
 
32
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 
33
</EM>
 
34
</TD>
 
35
</TR>
 
36
 
 
37
<TR>
 
38
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
39
&nbsp;<A HREF="../../../../org/apache/commons/httpclient/HttpUrlMethod.html"><B>PREV CLASS</B></A>&nbsp;
 
40
&nbsp;<A HREF="../../../../org/apache/commons/httpclient/ResponseConsumedWatcher.html"><B>NEXT CLASS</B></A></FONT></TD>
 
41
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
42
  <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
 
43
&nbsp;<A HREF="MethodRetryHandler.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
 
44
</TR>
 
45
<TR>
 
46
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
47
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 
48
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
49
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 
50
</TR>
 
51
</TABLE>
 
52
<!-- =========== END OF NAVBAR =========== -->
 
53
 
 
54
<HR>
 
55
<!-- ======== START OF CLASS DATA ======== -->
 
56
<H2>
 
57
<FONT SIZE="-1">
 
58
org.apache.commons.httpclient</FONT>
 
59
<BR>
 
60
Interface  MethodRetryHandler</H2>
 
61
<DL>
 
62
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/commons/httpclient/DefaultMethodRetryHandler.html">DefaultMethodRetryHandler</A></DD>
 
63
</DL>
 
64
<HR>
 
65
<DL>
 
66
<DT>public interface <B>MethodRetryHandler</B></DL>
 
67
 
 
68
<P>
 
69
A handler for determining if an HttpMethod should be retried after a 
 
70
 recoverable exception during execution.
 
71
<P>
 
72
<DL>
 
73
<DT><B>Author: </B><DD>Michael Becke</DD>
 
74
<DT><B>See Also: </B><DD><A HREF="../../../../org/apache/commons/httpclient/HttpMethod.html#execute(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection)"><CODE>HttpMethod.execute(HttpState, HttpConnection)</CODE></A>, 
 
75
<A HREF="../../../../org/apache/commons/httpclient/HttpRecoverableException.html"><CODE>HttpRecoverableException</CODE></A></DL>
 
76
<HR>
 
77
 
 
78
<P>
 
79
<!-- ======== INNER CLASS SUMMARY ======== -->
 
80
 
 
81
 
 
82
<!-- =========== FIELD SUMMARY =========== -->
 
83
 
 
84
 
 
85
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
 
86
 
 
87
 
 
88
<!-- ========== METHOD SUMMARY =========== -->
 
89
 
 
90
<A NAME="method_summary"><!-- --></A>
 
91
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
92
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
93
<TD COLSPAN=2><FONT SIZE="+2">
 
94
<B>Method Summary</B></FONT></TD>
 
95
</TR>
 
96
<TR BGCOLOR="white" CLASS="TableRowColor">
 
97
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
98
<CODE>&nbsp;boolean</CODE></FONT></TD>
 
99
<TD><CODE><B><A HREF="../../../../org/apache/commons/httpclient/MethodRetryHandler.html#retryMethod(org.apache.commons.httpclient.HttpMethod, org.apache.commons.httpclient.HttpConnection, org.apache.commons.httpclient.HttpRecoverableException, int, boolean)">retryMethod</A></B>(<A HREF="../../../../org/apache/commons/httpclient/HttpMethod.html">HttpMethod</A>&nbsp;method,
 
100
            <A HREF="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</A>&nbsp;connection,
 
101
            <A HREF="../../../../org/apache/commons/httpclient/HttpRecoverableException.html">HttpRecoverableException</A>&nbsp;recoverableException,
 
102
            int&nbsp;executionCount,
 
103
            boolean&nbsp;requestSent)</CODE>
 
104
 
 
105
<BR>
 
106
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines if a method should be retried after an HttpRecoverableException
 
107
 occurs during execution.</TD>
 
108
</TR>
 
109
</TABLE>
 
110
&nbsp;
 
111
<P>
 
112
 
 
113
<!-- ============ FIELD DETAIL =========== -->
 
114
 
 
115
 
 
116
<!-- ========= CONSTRUCTOR DETAIL ======== -->
 
117
 
 
118
 
 
119
<!-- ============ METHOD DETAIL ========== -->
 
120
 
 
121
<A NAME="method_detail"><!-- --></A>
 
122
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
123
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
124
<TD COLSPAN=1><FONT SIZE="+2">
 
125
<B>Method Detail</B></FONT></TD>
 
126
</TR>
 
127
</TABLE>
 
128
 
 
129
<A NAME="retryMethod(org.apache.commons.httpclient.HttpMethod, org.apache.commons.httpclient.HttpConnection, org.apache.commons.httpclient.HttpRecoverableException, int, boolean)"><!-- --></A><H3>
 
130
retryMethod</H3>
 
131
<PRE>
 
132
public boolean <B>retryMethod</B>(<A HREF="../../../../org/apache/commons/httpclient/HttpMethod.html">HttpMethod</A>&nbsp;method,
 
133
                           <A HREF="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</A>&nbsp;connection,
 
134
                           <A HREF="../../../../org/apache/commons/httpclient/HttpRecoverableException.html">HttpRecoverableException</A>&nbsp;recoverableException,
 
135
                           int&nbsp;executionCount,
 
136
                           boolean&nbsp;requestSent)</PRE>
 
137
<DL>
 
138
<DD>Determines if a method should be retried after an HttpRecoverableException
 
139
 occurs during execution.<DD><DL>
 
140
<DT><B>Parameters:</B><DD><CODE>method</CODE> - the method being executed<DD><CODE>connection</CODE> - the connection the method is using<DD><CODE>recoverableException</CODE> - the exception that occurred<DD><CODE>executionCount</CODE> - the number of times this method has been 
 
141
 unsuccessfully executed<DD><CODE>requestSent</CODE> - a flag indicating if the request has been fully sent or not<DT><B>Returns:</B><DD><code>true</code> if the method should be retried, <code>false</code>
 
142
 otherwise</DL>
 
143
</DD>
 
144
</DL>
 
145
<!-- ========= END OF CLASS DATA ========= -->
 
146
<HR>
 
147
 
 
148
<!-- ========== START OF NAVBAR ========== -->
 
149
<A NAME="navbar_bottom"><!-- --></A>
 
150
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
 
151
<TR>
 
152
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 
153
<A NAME="navbar_bottom_firstrow"><!-- --></A>
 
154
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
 
155
  <TR ALIGN="center" VALIGN="top">
 
156
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 
157
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 
158
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 
159
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/MethodRetryHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 
160
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 
161
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 
162
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 
163
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 
164
  </TR>
 
165
</TABLE>
 
166
</TD>
 
167
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 
168
</EM>
 
169
</TD>
 
170
</TR>
 
171
 
 
172
<TR>
 
173
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
174
&nbsp;<A HREF="../../../../org/apache/commons/httpclient/HttpUrlMethod.html"><B>PREV CLASS</B></A>&nbsp;
 
175
&nbsp;<A HREF="../../../../org/apache/commons/httpclient/ResponseConsumedWatcher.html"><B>NEXT CLASS</B></A></FONT></TD>
 
176
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
177
  <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
 
178
&nbsp;<A HREF="MethodRetryHandler.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
 
179
</TR>
 
180
<TR>
 
181
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
182
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 
183
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
184
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 
185
</TR>
 
186
</TABLE>
 
187
<!-- =========== END OF NAVBAR =========== -->
 
188
 
 
189
<HR>
 
190
Copyright &copy; 2001-2004 Apache Software Foundation. All Rights Reserved.
 
191
</BODY>
 
192
</HTML>