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

<a name="2" href="#2">2</a> * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpMethodBase.java,v 1.159.2.33 2004/10/10 00:00:35 mbecke Exp $

<a name="3" href="#3">3</a> * $Revision: 1.159.2.33 $

<a name="4" href="#4">4</a> * $Date: 2004/10/10 00:00:35 $

<a name="5" href="#5">5</a> *

<a name="6" href="#6">6</a> * ====================================================================

<a name="7" href="#7">7</a> *

<a name="9" href="#9">9</a> *

<a name="10" href="#10">10</a> * Licensed under the Apache License, Version 2.0 (the "License");

<a name="11" href="#11">11</a> * you may not use this file except in compliance with the License.

<a name="12" href="#12">12</a> * You may obtain a copy of the License at

<a name="13" href="#13">13</a> *

<a name="14" href="#14">14</a> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a>

<a name="15" href="#15">15</a> *

<a name="16" href="#16">16</a> * Unless required by applicable law or agreed to in writing, software

<a name="17" href="#17">17</a> * distributed under the License is distributed on an "AS IS" BASIS,

<a name="18" href="#18">18</a> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

<a name="19" href="#19">19</a> * See the License for the specific language governing permissions and

<a name="20" href="#20">20</a> * limitations under the License.

<a name="21" href="#21">21</a> * ====================================================================

<a name="22" href="#22">22</a> *

<a name="23" href="#23">23</a> * This software consists of voluntary contributions made by many

<a name="24" href="#24">24</a> * individuals on behalf of the Apache Software Foundation. For more

<a name="25" href="#25">25</a> * information on the Apache Software Foundation, please see

<a name="26" href="#26">26</a> * <<a href="http://www.apache.org/" target="alexandria_uri">http://www.apache.org/</a>>.

<a name="27" href="#27">27</a> *

<a name="28" href="#28">28</a> * [Additional notices, if required by prior licensing conditions]

<a name="29" href="#29">29</a> *

<a name="30" href="#30">30</a> */

<a name="32" href="#32">32</a> package <a href="../../../../org/apache/commons/httpclient/package-summary.html">org.apache.commons.httpclient</a>;

<a name="34" href="#34">34</a> import java.io.ByteArrayInputStream;

<a name="35" href="#35">35</a> import java.io.ByteArrayOutputStream;

<a name="36" href="#36">36</a> import java.io.IOException;

<a name="37" href="#37">37</a> import java.io.InputStream;

<a name="38" href="#38">38</a> import java.io.InterruptedIOException;

<a name="39" href="#39">39</a> import java.util.HashSet;

<a name="40" href="#40">40</a> import java.util.Set;

<a name="42" href="#42">42</a> import org.apache.commons.httpclient.auth.AuthScheme;

<a name="43" href="#43">43</a> import org.apache.commons.httpclient.auth.AuthenticationException;

<a name="44" href="#44">44</a> import org.apache.commons.httpclient.auth.HttpAuthenticator;

<a name="45" href="#45">45</a> import org.apache.commons.httpclient.auth.MalformedChallengeException;

<a name="46" href="#46">46</a> import org.apache.commons.httpclient.auth.NTLMScheme;

<a name="47" href="#47">47</a> import org.apache.commons.httpclient.cookie.CookiePolicy;

<a name="48" href="#48">48</a> import org.apache.commons.httpclient.cookie.CookieSpec;

<a name="49" href="#49">49</a> import org.apache.commons.httpclient.cookie.MalformedCookieException;

<a name="50" href="#50">50</a> import org.apache.commons.httpclient.protocol.Protocol;

<a name="51" href="#51">51</a> import org.apache.commons.httpclient.util.EncodingUtil;

<a name="52" href="#52">52</a> import org.apache.commons.logging.Log;

<a name="53" href="#53">53</a> import org.apache.commons.logging.LogFactory;

<a name="55" href="#55">55</a> /***

<a name="56" href="#56">56</a> * An abstract base implementation of HttpMethod.

<a name="57" href="#57">57</a> *

<a name="58" href="#58">58</a> * At minimum, subclasses will need to override:

<a name="60" href="#60">60</a> * <li>{@link #getName} to return the approriate name for this method

<a name="63" href="#63">63</a> *

<a name="64" href="#64">64</a> *

<a name="65" href="#65">65</a> * When a method's request may contain a body, subclasses will typically want

<a name="66" href="#66">66</a> * to override:

<a name="68" href="#68">68</a> * <li>{@link #getRequestContentLength} to indicate the length (in bytes)

<a name="70" href="#70">70</a> * <li>{@link #writeRequestBody writeRequestBody(HttpState,HttpConnection)}

<a name="71" href="#71">71</a> * to write the body</li>

<a name="73" href="#73">73</a> *

<a name="74" href="#74">74</a> *

<a name="75" href="#75">75</a> *

<a name="76" href="#76">76</a> * When a method requires additional request headers, subclasses will typically

<a name="77" href="#77">77</a> * want to override:

<a name="79" href="#79">79</a> * <li>{@link #addRequestHeaders addRequestHeaders(HttpState,HttpConnection)}

<a name="80" href="#80">80</a> * to write those headers

<a name="83" href="#83">83</a> *

<a name="84" href="#84">84</a> *

<a name="85" href="#85">85</a> *

<a name="86" href="#86">86</a> * When a method expects specific response headers, subclasses may want to

<a name="87" href="#87">87</a> * override:

<a name="89" href="#89">89</a> * <li>{@link #processResponseHeaders processResponseHeaders(HttpState,HttpConnection)}

<a name="90" href="#90">90</a> * to handle those headers

100

101

102

<a name="93" href="#93">93</a> *

103

<a name="94" href="#94">94</a> *

104

<a name="95" href="#95">95</a> *

105

<a name="96" href="#96">96</a> * @author <a href="<a href="mailto:remm@apache.org" target="alexandria_uri">mailto:remm@apache.org</a>">Remy Maucherat</a>

106

<a name="97" href="#97">97</a> * @author Rodney Waldhoff

107

<a name="98" href="#98">98</a> * @author Sean C. Sullivan

108

<a name="99" href="#99">99</a> * @author <a href="<a href="mailto:dion@apache.org" target="alexandria_uri">mailto:dion@apache.org</a>">dIon Gillard</a>

109

<a name="100" href="#100">100</a> * @author <a href="<a href="mailto:jsdever@apache.org" target="alexandria_uri">mailto:jsdever@apache.org</a>">Jeff Dever</a>

110

<a name="101" href="#101">101</a> * @author <a href="<a href="mailto:dims@apache.org" target="alexandria_uri">mailto:dims@apache.org</a>">Davanum Srinivas</a>

111

<a name="102" href="#102">102</a> * @author Ortwin Glueck

112

<a name="103" href="#103">103</a> * @author Eric Johnson

113

<a name="104" href="#104">104</a> * @author Michael Becke

114

<a name="105" href="#105">105</a> * @author <a href="<a href="mailto:oleg@ural.ru" target="alexandria_uri">mailto:oleg@ural.ru</a>">Oleg Kalnichevski</a>

115

<a name="106" href="#106">106</a> * @author <a href="<a href="mailto:mbowler@GargoyleSoftware.com" target="alexandria_uri">mailto:mbowler@GargoyleSoftware.com</a>">Mike Bowler</a>

116

<a name="107" href="#107">107</a> * @author <a href="<a href="mailto:ggregory@seagullsw.com" target="alexandria_uri">mailto:ggregory@seagullsw.com</a>">Gary Gregory</a>

117

<a name="108" href="#108">108</a> *

118

<a name="109" href="#109">109</a> * @version $Revision: 1.159.2.33 $ $Date: 2004/10/10 00:00:35 $

119

<a name="110" href="#110">110</a> */

120

<a name="111" href="#111">111</a> public abstract class <a href="../../../../org/apache/commons/httpclient/HttpMethodBase.html">HttpMethodBase</a> implements <a href="../../../../org/apache/commons/httpclient/HttpMethod.html">HttpMethod</a> {

121

122

<a name="113" href="#113">113</a> /*** Maximum number of redirects and authentications that will be followed */

123

<a name="114" href="#114">114</a> private static final int MAX_FORWARDS = 100;

124

125

<a name="116" href="#116">116</a> // -------------------------------------------------------------- Constants

126

127

<a name="118" href="#118">118</a> /*** Log object for this class. */

128

<a name="119" href="#119">119</a> private static final Log LOG = LogFactory.getLog(HttpMethodBase.class);

129

130

<a name="121" href="#121">121</a> /*** The User-Agent header sent on every request. */

131

<a name="122" href="#122">122</a> protected static final <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> USER_AGENT;

132

133

<a name="124" href="#124">124</a> static {

134

<a name="125" href="#125">125</a> String agent = null;

135

<a name="126" href="#126">126</a> try {

136

<a name="127" href="#127">127</a> agent = System.getProperty("httpclient.useragent");

137

<a name="128" href="#128">128</a> } catch (SecurityException ignore) {

138

<a name="129" href="#129">129</a> }

139

<a name="130" href="#130">130</a> if (agent == null) {

140

<a name="131" href="#131">131</a> agent = "Jakarta Commons-HttpClient/2.0.2";

141

<a name="132" href="#132">132</a> }

142

<a name="133" href="#133">133</a> USER_AGENT = new <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>("User-Agent", agent);

143

<a name="134" href="#134">134</a> }

144

145

<a name="136" href="#136">136</a> // ----------------------------------------------------- Instance variables

146

147

<a name="138" href="#138">138</a> /*** Request headers, if any. */

148

<a name="139" href="#139">139</a> private <a href="../../../../org/apache/commons/httpclient/HeaderGroup.html">HeaderGroup</a> requestHeaders = new <a href="../../../../org/apache/commons/httpclient/HeaderGroup.html">HeaderGroup</a>();

149

150

<a name="141" href="#141">141</a> /*** The Status-Line from the response. */

151

<a name="142" href="#142">142</a> private <a href="../../../../org/apache/commons/httpclient/StatusLine.html">StatusLine</a> statusLine = null;

152

153

<a name="144" href="#144">144</a> /*** Response headers, if any. */

154

<a name="145" href="#145">145</a> private <a href="../../../../org/apache/commons/httpclient/HeaderGroup.html">HeaderGroup</a> responseHeaders = new <a href="../../../../org/apache/commons/httpclient/HeaderGroup.html">HeaderGroup</a>();

155

156

<a name="147" href="#147">147</a> /*** Response trailer headers, if any. */

157

<a name="148" href="#148">148</a> private <a href="../../../../org/apache/commons/httpclient/HeaderGroup.html">HeaderGroup</a> responseTrailerHeaders = new <a href="../../../../org/apache/commons/httpclient/HeaderGroup.html">HeaderGroup</a>();

158

159

<a name="150" href="#150">150</a> /*** Authentication scheme used to authenticate againt the target server */

160

<a name="151" href="#151">151</a> private <a href="../../../../org/apache/commons/httpclient/auth/AuthScheme.html">AuthScheme</a> authScheme = null;

161

162

<a name="153" href="#153">153</a> /*** Realms this method tried to authenticate to */

163

<a name="154" href="#154">154</a> private Set realms = null;

164

165

<a name="156" href="#156">156</a> /*** Actual authentication realm */

166

<a name="157" href="#157">157</a> private String realm = null;

167

168

<a name="159" href="#159">159</a> /*** Authentication scheme used to authenticate againt the proxy server */

169

<a name="160" href="#160">160</a> private <a href="../../../../org/apache/commons/httpclient/auth/AuthScheme.html">AuthScheme</a> proxyAuthScheme = null;

170

171

<a name="162" href="#162">162</a> /*** Proxy Realms this method tried to authenticate to */

172

<a name="163" href="#163">163</a> private Set proxyRealms = null;

173

174

<a name="165" href="#165">165</a> /*** Actual proxy authentication realm */

175

<a name="166" href="#166">166</a> private String proxyRealm = null;

176

177

<a name="168" href="#168">168</a> /*** Path of the HTTP method. */

178

<a name="169" href="#169">169</a> private String path = null;

179

180

<a name="171" href="#171">171</a> /*** Query string of the HTTP method, if any. */

181

<a name="172" href="#172">172</a> private String queryString = null;

182

183

<a name="174" href="#174">174</a> /*** The response body of the HTTP method, assuming it has not be

184

<a name="175" href="#175">175</a> * intercepted by a sub-class. */

185

<a name="176" href="#176">176</a> private InputStream responseStream = null;

186

187

<a name="178" href="#178">178</a> /*** The connection that the response stream was read from. */

188

<a name="179" href="#179">179</a> private <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> responseConnection = null;

189

190

<a name="181" href="#181">181</a> /*** Buffer for the response */

191

<a name="182" href="#182">182</a> private byte[] responseBody = null;

192

193

<a name="184" href="#184">184</a> /*** True if the HTTP method should automatically follow

194

<a name="185" href="#185">185</a> * HTTP redirects. */

195

<a name="186" href="#186">186</a> private boolean followRedirects = false;

196

197

<a name="188" href="#188">188</a> /*** True if the HTTP method should automatically handle

198

<a name="189" href="#189">189</a> * HTTP authentication challenges. */

199

<a name="190" href="#190">190</a> private boolean doAuthentication = true;

200

201

<a name="192" href="#192">192</a> /*** True if version 1.1 of the HTTP protocol should be used per default. */

202

<a name="193" href="#193">193</a> private boolean http11 = true;

203

204

<a name="195" href="#195">195</a> /*** True if this HTTP method should strictly follow the HTTP protocol

205

<a name="196" href="#196">196</a> * specification. */

206

<a name="197" href="#197">197</a> private boolean strictMode = false;

207

208

<a name="199" href="#199">199</a> /*** True if this method has already been executed. */

209

<a name="200" href="#200">200</a> private boolean used = false;

210

211

<a name="202" href="#202">202</a> /*** Count of how many times did this HTTP method transparently handle

212

<a name="203" href="#203">203</a> * a recoverable exception. */

213

<a name="204" href="#204">204</a> private int recoverableExceptionCount = 0;

214

215

<a name="206" href="#206">206</a> /*** The host configuration for this HTTP method, can be null */

216

<a name="207" href="#207">207</a> private <a href="../../../../org/apache/commons/httpclient/HostConfiguration.html">HostConfiguration</a> hostConfiguration;

217

218

<a name="209" href="#209">209</a> /***

219

<a name="210" href="#210">210</a> * Handles method retries

220

<a name="211" href="#211">211</a> */

221

<a name="212" href="#212">212</a> private <a href="../../../../org/apache/commons/httpclient/MethodRetryHandler.html">MethodRetryHandler</a> methodRetryHandler;

222

223

<a name="214" href="#214">214</a> /*** True if this method is currently being executed. */

224

<a name="215" href="#215">215</a> private boolean inExecute = false;

225

226

<a name="217" href="#217">217</a> /*** True if this HTTP method is finished with the connection */

227

<a name="218" href="#218">218</a> private boolean doneWithConnection = false;

228

229

<a name="220" href="#220">220</a> /*** True if the connection must be closed when no longer needed */

230

<a name="221" href="#221">221</a> private boolean connectionCloseForced = false;

231

232

<a name="223" href="#223">223</a> /*** Number of milliseconds to wait for 100-contunue response. */

233

<a name="224" href="#224">224</a> private static final int RESPONSE_WAIT_TIME_MS = 3000;

234

235

<a name="226" href="#226">226</a> /*** Maximum buffered response size (in bytes) that triggers no warning. */

236

<a name="227" href="#227">227</a> private static final int BUFFER_WARN_TRIGGER_LIMIT = 1024*1024; //1 MB

237

238

<a name="229" href="#229">229</a> /*** Default initial size of the response buffer if content length is unknown. */

239

<a name="230" href="#230">230</a> private static final int DEFAULT_INITIAL_BUFFER_SIZE = 4*1024; // 4 kB

240

241

<a name="232" href="#232">232</a> // ----------------------------------------------------------- Constructors

242

243

<a name="234" href="#234">234</a> /***

244

<a name="235" href="#235">235</a> * No-arg constructor.

245

<a name="236" href="#236">236</a> */

246

<a name="237" href="#237">237</a> public <a href="../../../../org/apache/commons/httpclient/HttpMethodBase.html">HttpMethodBase</a>() {

247

<a name="238" href="#238">238</a> }

248

249

<a name="240" href="#240">240</a> /***

250

<a name="241" href="#241">241</a> * Constructor specifying a URI.

251

<a name="242" href="#242">242</a> * It is responsibility of the caller to ensure that URI elements

252

<a name="243" href="#243">243</a> * (path & query parameters) are properly encoded (URL safe).

253

<a name="244" href="#244">244</a> *

254

<a name="245" href="#245">245</a> * @param uri either an absolute or relative URI. The URI is expected

255

<a name="246" href="#246">246</a> * to be URL-encoded

256

<a name="247" href="#247">247</a> *

257

<a name="248" href="#248">248</a> * @throws IllegalArgumentException when URI is invalid

258

<a name="249" href="#249">249</a> * @throws IllegalStateException when protocol of the absolute URI is not recognised

259

<a name="250" href="#250">250</a> */

260

<a name="251" href="#251">251</a> public <a href="../../../../org/apache/commons/httpclient/HttpMethodBase.html">HttpMethodBase</a>(String uri)

261

<a name="252" href="#252">252</a> throws IllegalArgumentException, IllegalStateException {

262

263

<a name="254" href="#254">254</a> try {

264

265

<a name="256" href="#256">256</a> // create a URI and allow for null/empty uri values

266

<a name="257" href="#257">257</a> if (uri == null || uri.equals("")) {

267

<a name="258" href="#258">258</a> uri = "/";

268

<a name="259" href="#259">259</a> }

269

<a name="260" href="#260">260</a> <a href="../../../../org/apache/commons/httpclient/URI.html">URI</a> parsedURI = new <a href="../../../../org/apache/commons/httpclient/URI.html">URI</a>(uri.toCharArray());

270

271

<a name="262" href="#262">262</a> // only set the host if specified by the URI

272

<a name="263" href="#263">263</a> if (parsedURI.isAbsoluteURI()) {

273

<a name="264" href="#264">264</a> hostConfiguration = new <a href="../../../../org/apache/commons/httpclient/HostConfiguration.html">HostConfiguration</a>();

274

<a name="265" href="#265">265</a> hostConfiguration.setHost(

275

<a name="266" href="#266">266</a> parsedURI.getHost(),

276

<a name="267" href="#267">267</a> parsedURI.getPort(),

277

<a name="268" href="#268">268</a> parsedURI.getScheme()

278

<a name="269" href="#269">269</a> );

279

<a name="270" href="#270">270</a> }

280

281

<a name="272" href="#272">272</a> // set the path, defaulting to root

282

<a name="273" href="#273">273</a> setPath(

283

<a name="274" href="#274">274</a> parsedURI.getPath() == null

284

<a name="275" href="#275">275</a> ? "/"

285

<a name="276" href="#276">276</a> : parsedURI.getEscapedPath()

286

<a name="277" href="#277">277</a> );

287

<a name="278" href="#278">278</a> setQueryString(parsedURI.getEscapedQuery());

288

289

<a name="280" href="#280">280</a> } catch (URIException e) {

290

<a name="281" href="#281">281</a> throw new IllegalArgumentException("Invalid uri '"

291

<a name="282" href="#282">282</a> + uri + "': " + e.getMessage()

292

<a name="283" href="#283">283</a> );

293

<a name="284" href="#284">284</a> }

294

<a name="285" href="#285">285</a> }

295

296

<a name="287" href="#287">287</a> // ------------------------------------------- Property Setters and Getters

297

298

<a name="289" href="#289">289</a> /***

299

<a name="290" href="#290">290</a> * Obtains the name of the HTTP method as used in the HTTP request line,

300

<a name="291" href="#291">291</a> * for example <tt>"GET"</tt> or <tt>"POST"</tt>.

301

<a name="292" href="#292">292</a> *

302

<a name="293" href="#293">293</a> * @return the name of this method

303

<a name="294" href="#294">294</a> */

304

<a name="295" href="#295">295</a> public abstract String getName();

305

306

<a name="297" href="#297">297</a> /***

307

<a name="298" href="#298">298</a> * Returns the URI of the HTTP method

308

<a name="299" href="#299">299</a> *

309

<a name="300" href="#300">300</a> * @return The URI

310

<a name="301" href="#301">301</a> *

311

<a name="302" href="#302">302</a> * @throws URIException If the URI cannot be created.

312

<a name="303" href="#303">303</a> *

313

<a name="304" href="#304">304</a> * @see org.apache.commons.httpclient.HttpMethod#getURI()

314

<a name="305" href="#305">305</a> */

315

<a name="306" href="#306">306</a> public <a href="../../../../org/apache/commons/httpclient/URI.html">URI</a> getURI() throws URIException {

316

317

<a name="308" href="#308">308</a> if (hostConfiguration == null) {

318

<a name="309" href="#309">309</a> // just use a relative URI, the host hasn't been set

319

<a name="310" href="#310">310</a> <a href="../../../../org/apache/commons/httpclient/URI.html">URI</a> tmpUri = new <a href="../../../../org/apache/commons/httpclient/URI.html">URI</a>(null, null, path, null, null);

320

<a name="311" href="#311">311</a> tmpUri.setEscapedQuery(queryString);

321

<a name="312" href="#312">312</a> return tmpUri;

322

<a name="313" href="#313">313</a> } else {

323

324

<a name="315" href="#315">315</a> // we only want to include the port if it's not the default

325

<a name="316" href="#316">316</a> int port = hostConfiguration.getPort();

326

<a name="317" href="#317">317</a> if (port == hostConfiguration.getProtocol().getDefaultPort()) {

327

<a name="318" href="#318">318</a> port = -1;

328

<a name="319" href="#319">319</a> }

329

330

<a name="321" href="#321">321</a> <a href="../../../../org/apache/commons/httpclient/URI.html">URI</a> tmpUri = new <a href="../../../../org/apache/commons/httpclient/URI.html">URI</a>(

331

<a name="322" href="#322">322</a> hostConfiguration.getProtocol().getScheme(),

332

<a name="323" href="#323">323</a> null,

333

<a name="324" href="#324">324</a> hostConfiguration.getHost(),

334

<a name="325" href="#325">325</a> port,

335

<a name="326" href="#326">326</a> path,

336

<a name="327" href="#327">327</a> null // to set an escaped form

337

<a name="328" href="#328">328</a> );

338

<a name="329" href="#329">329</a> tmpUri.setEscapedQuery(queryString);

339

<a name="330" href="#330">330</a> return tmpUri;

340

341

<a name="332" href="#332">332</a> }

342

343

<a name="334" href="#334">334</a> }

344

345

<a name="336" href="#336">336</a> /***

346

<a name="337" href="#337">337</a> * Sets whether or not the HTTP method should automatically follow HTTP redirects

347

<a name="338" href="#338">338</a> * (status code 302, etc.)

348

<a name="339" href="#339">339</a> *

349

<a name="340" href="#340">340</a> * @param followRedirects <tt>true</tt> if the method will automatically follow redirects,

350

<a name="341" href="#341">341</a> * <tt>false</tt> otherwise.

351

<a name="342" href="#342">342</a> */

352

<a name="343" href="#343">343</a> public void setFollowRedirects(boolean followRedirects) {

353

<a name="344" href="#344">344</a> this.followRedirects = followRedirects;

354

<a name="345" href="#345">345</a> }

355

356

<a name="347" href="#347">347</a> /***

357

<a name="348" href="#348">348</a> * Returns <tt>true</tt> if the HTTP method should automatically follow HTTP redirects

358

<a name="349" href="#349">349</a> * (status code 302, etc.), <tt>false</tt> otherwise.

359

<a name="350" href="#350">350</a> *

360

<a name="351" href="#351">351</a> * @return <tt>true</tt> if the method will automatically follow HTTP redirects,

361

<a name="352" href="#352">352</a> * <tt>false</tt> otherwise.

362

<a name="353" href="#353">353</a> */

363

<a name="354" href="#354">354</a> public boolean getFollowRedirects() {

364

<a name="355" href="#355">355</a> return this.followRedirects;

365

<a name="356" href="#356">356</a> }

366

367

<a name="358" href="#358">358</a> /***

368

<a name="359" href="#359">359</a> /** Sets whether version 1.1 of the HTTP protocol should be used per default.

369

<a name="360" href="#360">360</a> *

370

<a name="361" href="#361">361</a> * @param http11 <tt>true</tt> to use HTTP/1.1, <tt>false</tt> to use 1.0

371

<a name="362" href="#362">362</a> */

372

<a name="363" href="#363">363</a> public void setHttp11(boolean http11) {

373

<a name="364" href="#364">364</a> this.http11 = http11;

374

<a name="365" href="#365">365</a> }

375

376

<a name="367" href="#367">367</a> /***

377

<a name="368" href="#368">368</a> * Returns <tt>true</tt> if the HTTP method should automatically handle HTTP

378

<a name="369" href="#369">369</a> * authentication challenges (status code 401, etc.), <tt>false</tt> otherwise

379

<a name="370" href="#370">370</a> *

380

<a name="371" href="#371">371</a> * @return <tt>true</tt> if authentication challenges will be processed

381

<a name="372" href="#372">372</a> * automatically, <tt>false</tt> otherwise.

382

<a name="373" href="#373">373</a> *

383

<a name="374" href="#374">374</a> * @since 2.0

384

<a name="375" href="#375">375</a> */

385

<a name="376" href="#376">376</a> public boolean getDoAuthentication() {

386

<a name="377" href="#377">377</a> return doAuthentication;

387

<a name="378" href="#378">378</a> }

388

389

<a name="380" href="#380">380</a> /***

390

<a name="381" href="#381">381</a> * Sets whether or not the HTTP method should automatically handle HTTP

391

<a name="382" href="#382">382</a> * authentication challenges (status code 401, etc.)

392

<a name="383" href="#383">383</a> *

393

<a name="384" href="#384">384</a> * @param doAuthentication <tt>true</tt> to process authentication challenges

394

<a name="385" href="#385">385</a> * authomatically, <tt>false</tt> otherwise.

395

<a name="386" href="#386">386</a> *

396

<a name="387" href="#387">387</a> * @since 2.0

397

<a name="388" href="#388">388</a> */

398

<a name="389" href="#389">389</a> public void setDoAuthentication(boolean doAuthentication) {

399

<a name="390" href="#390">390</a> this.doAuthentication = doAuthentication;

400

<a name="391" href="#391">391</a> }

401

402

<a name="393" href="#393">393</a> // ---------------------------------------------- Protected Utility Methods

403

404

<a name="395" href="#395">395</a> /***

405

<a name="396" href="#396">396</a> * Returns <tt>true</tt> if version 1.1 of the HTTP protocol should be

406

<a name="397" href="#397">397</a> * used per default, <tt>false</tt> if version 1.0 should be used.

407

<a name="398" href="#398">398</a> *

408

<a name="399" href="#399">399</a> * @return <tt>true</tt> to use HTTP/1.1, <tt>false</tt> to use 1.0

409

<a name="400" href="#400">400</a> */

410

<a name="401" href="#401">401</a> public boolean isHttp11() {

411

<a name="402" href="#402">402</a> return http11;

412

<a name="403" href="#403">403</a> }

413

414

<a name="405" href="#405">405</a> /***

415

<a name="406" href="#406">406</a> * Sets the path of the HTTP method.

416

<a name="407" href="#407">407</a> * It is responsibility of the caller to ensure that the path is

417

<a name="408" href="#408">408</a> * properly encoded (URL safe).

418

<a name="409" href="#409">409</a> *

419

<a name="410" href="#410">410</a> * @param path the path of the HTTP method. The path is expected

420

<a name="411" href="#411">411</a> * to be URL-encoded

421

<a name="412" href="#412">412</a> */

422

<a name="413" href="#413">413</a> public void setPath(String path) {

423

<a name="414" href="#414">414</a> this.path = path;

424

<a name="415" href="#415">415</a> }

425

426

<a name="417" href="#417">417</a> /***

427

<a name="418" href="#418">418</a> * Adds the specified request header, NOT overwriting any previous value.

428

<a name="419" href="#419">419</a> * Note that header-name matching is case insensitive.

429

<a name="420" href="#420">420</a> *

430

<a name="421" href="#421">421</a> * @param header the header to add to the request

431

<a name="422" href="#422">422</a> */

432

<a name="423" href="#423">423</a> public void addRequestHeader(<a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> header) {

433

<a name="424" href="#424">424</a> LOG.trace("HttpMethodBase.addRequestHeader(Header)");

434

435

<a name="426" href="#426">426</a> if (header == null) {

436

<a name="427" href="#427">427</a> LOG.debug("null header value ignored");

437

<a name="428" href="#428">428</a> } else {

438

<a name="429" href="#429">429</a> getRequestHeaderGroup().addHeader(header);

439

<a name="430" href="#430">430</a> }

440

<a name="431" href="#431">431</a> }

441

442

<a name="433" href="#433">433</a> /***

443

<a name="434" href="#434">434</a> * Use this method internally to add footers.

444

<a name="435" href="#435">435</a> *

445

<a name="436" href="#436">436</a> * @param footer The footer to add.

446

<a name="437" href="#437">437</a> */

447

<a name="438" href="#438">438</a> public void addResponseFooter(<a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> footer) {

448

<a name="439" href="#439">439</a> getResponseTrailerHeaderGroup().addHeader(footer);

449

<a name="440" href="#440">440</a> }

450

451

<a name="442" href="#442">442</a> /***

452

<a name="443" href="#443">443</a> * Gets the path of this HTTP method.

453

<a name="444" href="#444">444</a> * Calling this method after the request has been executed will

454

<a name="445" href="#445">445</a> * return the actual path, following any redirects automatically

455

<a name="446" href="#446">446</a> * handled by this HTTP method.

456

<a name="447" href="#447">447</a> *

457

<a name="448" href="#448">448</a> * @return the path to request or "/" if the path is blank.

458

<a name="449" href="#449">449</a> */

459

<a name="450" href="#450">450</a> public String getPath() {

460

<a name="451" href="#451">451</a> return (path == null || path.equals("")) ? "/" : path;

461

<a name="452" href="#452">452</a> }

462

463

<a name="454" href="#454">454</a> /***

464

<a name="455" href="#455">455</a> * Sets the query string of this HTTP method. The caller must ensure that the string

465

<a name="456" href="#456">456</a> * is properly URL encoded. The query string should not start with the question

466

<a name="457" href="#457">457</a> * mark character.

467

<a name="458" href="#458">458</a> *

468

<a name="459" href="#459">459</a> * @param queryString the query string

469

<a name="460" href="#460">460</a> *

470

<a name="461" href="#461">461</a> * @see EncodingUtil#formUrlEncode(NameValuePair[], String)

471

<a name="462" href="#462">462</a> */

472

<a name="463" href="#463">463</a> public void setQueryString(String queryString) {

473

<a name="464" href="#464">464</a> this.queryString = queryString;

474

<a name="465" href="#465">465</a> }

475

476

<a name="467" href="#467">467</a> /***

477

<a name="468" href="#468">468</a> * Sets the query string of this HTTP method. The pairs are encoded as UTF-8 characters.

478

<a name="469" href="#469">469</a> * To use a different charset the parameters can be encoded manually using EncodingUtil

479

<a name="470" href="#470">470</a> * and set as a single String.

480

<a name="471" href="#471">471</a> *

481

<a name="472" href="#472">472</a> * @param params an array of {@link NameValuePair}s to add as query string

482

<a name="473" href="#473">473</a> * parameters. The name/value pairs will be automcatically

483

<a name="474" href="#474">474</a> * URL encoded

484

<a name="475" href="#475">475</a> *

485

<a name="476" href="#476">476</a> * @see EncodingUtil#formUrlEncode(NameValuePair[], String)

486

<a name="477" href="#477">477</a> * @see #setQueryString(String)

487

<a name="478" href="#478">478</a> */

488

<a name="479" href="#479">479</a> public void setQueryString(<a href="../../../../org/apache/commons/httpclient/NameValuePair.html">NameValuePair</a>[] params) {

489

<a name="480" href="#480">480</a> LOG.trace("enter HttpMethodBase.setQueryString(NameValuePair[])");

490

<a name="481" href="#481">481</a> queryString = EncodingUtil.formUrlEncode(params, "UTF-8");

491

<a name="482" href="#482">482</a> }

492

493

<a name="484" href="#484">484</a> /***

494

<a name="485" href="#485">485</a> * Gets the query string of this HTTP method.

495

<a name="486" href="#486">486</a> *

496

<a name="487" href="#487">487</a> * @return The query string

497

<a name="488" href="#488">488</a> */

498

<a name="489" href="#489">489</a> public String getQueryString() {

499

<a name="490" href="#490">490</a> return queryString;

500

<a name="491" href="#491">491</a> }

501

502

<a name="493" href="#493">493</a> /***

503

<a name="494" href="#494">494</a> * Set the specified request header, overwriting any previous value. Note

504

<a name="495" href="#495">495</a> * that header-name matching is case-insensitive.

505

<a name="496" href="#496">496</a> *

506

<a name="497" href="#497">497</a> * @param headerName the header's name

507

<a name="498" href="#498">498</a> * @param headerValue the header's value

508

<a name="499" href="#499">499</a> */

509

<a name="500" href="#500">500</a> public void setRequestHeader(String headerName, String headerValue) {

510

<a name="501" href="#501">501</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> header = new <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>(headerName, headerValue);

511

<a name="502" href="#502">502</a> setRequestHeader(header);

512

<a name="503" href="#503">503</a> }

513

514

<a name="505" href="#505">505</a> /***

515

<a name="506" href="#506">506</a> * Sets the specified request header, overwriting any previous value.

516

<a name="507" href="#507">507</a> * Note that header-name matching is case insensitive.

517

<a name="508" href="#508">508</a> *

518

<a name="509" href="#509">509</a> * @param header the header

519

<a name="510" href="#510">510</a> */

520

<a name="511" href="#511">511</a> public void setRequestHeader(<a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> header) {

521

522

<a name="513" href="#513">513</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] headers = getRequestHeaderGroup().getHeaders(header.getName());

523

524

<a name="515" href="#515">515</a> for (int i = 0; i < headers.length; i++) {

525

<a name="516" href="#516">516</a> getRequestHeaderGroup().removeHeader(headers[i]);

526

<a name="517" href="#517">517</a> }

527

528

<a name="519" href="#519">519</a> getRequestHeaderGroup().addHeader(header);

529

530

<a name="521" href="#521">521</a> }

531

532

<a name="523" href="#523">523</a> /***

533

<a name="524" href="#524">524</a> * Returns the specified request header. Note that header-name matching is

534

<a name="525" href="#525">525</a> * case insensitive. <tt>null</tt> will be returned if either

535

<a name="526" href="#526">526</a> * headerName is <tt>null</tt> or there is no matching header for

536

<a name="527" href="#527">527</a> * headerName.

537

<a name="528" href="#528">528</a> *

538

<a name="529" href="#529">529</a> * @param headerName The name of the header to be returned.

539

<a name="530" href="#530">530</a> *

540

<a name="531" href="#531">531</a> * @return The specified request header.

541

<a name="532" href="#532">532</a> */

542

<a name="533" href="#533">533</a> public <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> getRequestHeader(String headerName) {

543

<a name="534" href="#534">534</a> if (headerName == null) {

544

<a name="535" href="#535">535</a> return null;

545

<a name="536" href="#536">536</a> } else {

546

<a name="537" href="#537">537</a> return getRequestHeaderGroup().getCondensedHeader(headerName);

547

<a name="538" href="#538">538</a> }

548

<a name="539" href="#539">539</a> }

549

550

<a name="541" href="#541">541</a> /***

551

<a name="542" href="#542">542</a> * Returns an array of the requests headers that the HTTP method currently has

552

<a name="543" href="#543">543</a> *

553

<a name="544" href="#544">544</a> * @return an array of my request headers.

554

<a name="545" href="#545">545</a> */

555

<a name="546" href="#546">546</a> public <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] getRequestHeaders() {

556

<a name="547" href="#547">547</a> return getRequestHeaderGroup().getAllHeaders();

557

<a name="548" href="#548">548</a> }

558

559

<a name="550" href="#550">550</a> /***

560

<a name="551" href="#551">551</a> * Gets the {@link HeaderGroup header group} storing the request headers.

561

<a name="552" href="#552">552</a> *

562

<a name="553" href="#553">553</a> * @return a HeaderGroup

563

<a name="554" href="#554">554</a> *

564

<a name="555" href="#555">555</a> * @since 2.0beta1

565

<a name="556" href="#556">556</a> */

566

<a name="557" href="#557">557</a> protected <a href="../../../../org/apache/commons/httpclient/HeaderGroup.html">HeaderGroup</a> getRequestHeaderGroup() {

567

<a name="558" href="#558">558</a> return requestHeaders;

568

<a name="559" href="#559">559</a> }

569

570

<a name="561" href="#561">561</a> /***

571

<a name="562" href="#562">562</a> * Gets the {@link HeaderGroup header group} storing the response trailer headers

572

<a name="563" href="#563">563</a> * as per RFC 2616 section 3.6.1.

573

<a name="564" href="#564">564</a> *

574

<a name="565" href="#565">565</a> * @return a HeaderGroup

575

<a name="566" href="#566">566</a> *

576

<a name="567" href="#567">567</a> * @since 2.0beta1

577

<a name="568" href="#568">568</a> */

578

<a name="569" href="#569">569</a> protected <a href="../../../../org/apache/commons/httpclient/HeaderGroup.html">HeaderGroup</a> getResponseTrailerHeaderGroup() {

579

<a name="570" href="#570">570</a> return responseTrailerHeaders;

580

<a name="571" href="#571">571</a> }

581

582

<a name="573" href="#573">573</a> /***

583

<a name="574" href="#574">574</a> * Gets the {@link HeaderGroup header group} storing the response headers.

584

<a name="575" href="#575">575</a> *

585

<a name="576" href="#576">576</a> * @return a HeaderGroup

586

<a name="577" href="#577">577</a> *

587

<a name="578" href="#578">578</a> * @since 2.0beta1

588

<a name="579" href="#579">579</a> */

589

<a name="580" href="#580">580</a> protected <a href="../../../../org/apache/commons/httpclient/HeaderGroup.html">HeaderGroup</a> getResponseHeaderGroup() {

590

<a name="581" href="#581">581</a> return responseHeaders;

591

<a name="582" href="#582">582</a> }

592

593

<a name="584" href="#584">584</a> /***

594

<a name="585" href="#585">585</a> * Returns the response status code.

595

<a name="586" href="#586">586</a> *

596

<a name="587" href="#587">587</a> * @return the status code associated with the latest response.

597

<a name="588" href="#588">588</a> */

598

<a name="589" href="#589">589</a> public int getStatusCode() {

599

<a name="590" href="#590">590</a> return statusLine.getStatusCode();

600

<a name="591" href="#591">591</a> }

601

602

<a name="593" href="#593">593</a> /***

603

<a name="594" href="#594">594</a> * Provides access to the response status line.

604

<a name="595" href="#595">595</a> *

605

<a name="596" href="#596">596</a> * @return the status line object from the latest response.

606

<a name="597" href="#597">597</a> * @since 2.0

607

<a name="598" href="#598">598</a> */

608

<a name="599" href="#599">599</a> public <a href="../../../../org/apache/commons/httpclient/StatusLine.html">StatusLine</a> getStatusLine() {

609

<a name="600" href="#600">600</a> return statusLine;

610

<a name="601" href="#601">601</a> }

611

612

<a name="603" href="#603">603</a> /***

613

<a name="604" href="#604">604</a> * Checks if response data is available.

614

<a name="605" href="#605">605</a> * @return <tt>true</tt> if response data is available, <tt>false</tt> otherwise.

615

<a name="606" href="#606">606</a> */

616

<a name="607" href="#607">607</a> private boolean responseAvailable() {

617

<a name="608" href="#608">608</a> return (responseBody != null) || (responseStream != null);

618

<a name="609" href="#609">609</a> }

619

620

<a name="611" href="#611">611</a> /***

621

<a name="612" href="#612">612</a> * Returns an array of the response headers that the HTTP method currently has

622

<a name="613" href="#613">613</a> * in the order in which they were read.

623

<a name="614" href="#614">614</a> *

624

<a name="615" href="#615">615</a> * @return an array of response headers.

625

<a name="616" href="#616">616</a> */

626

<a name="617" href="#617">617</a> public <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] getResponseHeaders() {

627

<a name="618" href="#618">618</a> return getResponseHeaderGroup().getAllHeaders();

628

<a name="619" href="#619">619</a> }

629

630

<a name="621" href="#621">621</a> /***

631

<a name="622" href="#622">622</a> * Gets the response header associated with the given name. Header name

632

<a name="623" href="#623">623</a> * matching is case insensitive. <tt>null</tt> will be returned if either

633

<a name="624" href="#624">624</a> * headerName is <tt>null</tt> or there is no matching header for

634

<a name="625" href="#625">625</a> * headerName.

635

<a name="626" href="#626">626</a> *

636

<a name="627" href="#627">627</a> * @param headerName the header name to match

637

<a name="628" href="#628">628</a> *

638

<a name="629" href="#629">629</a> * @return the matching header

639

<a name="630" href="#630">630</a> */

640

<a name="631" href="#631">631</a> public <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> getResponseHeader(String headerName) {

641

<a name="632" href="#632">632</a> if (headerName == null) {

642

<a name="633" href="#633">633</a> return null;

643

<a name="634" href="#634">634</a> } else {

644

<a name="635" href="#635">635</a> return getResponseHeaderGroup().getCondensedHeader(headerName);

645

<a name="636" href="#636">636</a> }

646

<a name="637" href="#637">637</a> }

647

648

649

<a name="640" href="#640">640</a> /***

650

<a name="641" href="#641">641</a> * Return the length (in bytes) of the response body, as specified in a

651

<a name="642" href="#642">642</a> * <tt>Content-Length</tt> header.

652

<a name="643" href="#643">643</a> *

653

<a name="644" href="#644">644</a> *

654

<a name="645" href="#645">645</a> * Return <tt>-1</tt> when the content-length is unknown.

655

<a name="646" href="#646">646</a> *

656

<a name="647" href="#647">647</a> *

657

<a name="648" href="#648">648</a> * @return content length, if <tt>Content-Length</tt> header is available.

658

<a name="649" href="#649">649</a> * <tt>0</tt> indicates that the request has no body.

659

<a name="650" href="#650">650</a> * If <tt>Content-Length</tt> header is not present, the method

660

<a name="651" href="#651">651</a> * returns <tt>-1</tt>.

661

<a name="652" href="#652">652</a> */

662

<a name="653" href="#653">653</a> protected int getResponseContentLength() {

663

<a name="654" href="#654">654</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] headers = getResponseHeaderGroup().getHeaders("Content-Length");

664

<a name="655" href="#655">655</a> if (headers.length == 0) {

665

<a name="656" href="#656">656</a> return -1;

666

<a name="657" href="#657">657</a> }

667

<a name="658" href="#658">658</a> if (headers.length > 1) {

668

<a name="659" href="#659">659</a> LOG.warn("Multiple content-length headers detected");

669

<a name="660" href="#660">660</a> }

670

<a name="661" href="#661">661</a> for (int i = headers.length - 1; i >= 0; i--) {

671

<a name="662" href="#662">662</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> header = headers[i];

672

<a name="663" href="#663">663</a> try {

673

<a name="664" href="#664">664</a> return Integer.parseInt(header.getValue());

674

<a name="665" href="#665">665</a> } catch (NumberFormatException e) {

675

<a name="666" href="#666">666</a> if (LOG.isWarnEnabled()) {

676

<a name="667" href="#667">667</a> LOG.warn("Invalid content-length value: " + e.getMessage());

677

<a name="668" href="#668">668</a> }

678

<a name="669" href="#669">669</a> }

679

<a name="670" href="#670">670</a> // See if we can have better luck with another header, if present

680

<a name="671" href="#671">671</a> }

681

<a name="672" href="#672">672</a> return -1;

682

<a name="673" href="#673">673</a> }

683

684

685

<a name="676" href="#676">676</a> /***

686

<a name="677" href="#677">677</a> * Returns the response body of the HTTP method, if any, as an array of bytes.

687

<a name="678" href="#678">678</a> * If response body is not available or cannot be read, returns <tt>null</tt>.

688

<a name="679" href="#679">679</a> *

689

<a name="680" href="#680">680</a> * Note: This will cause the entire response body to be buffered in memory. A

690

<a name="681" href="#681">681</a> * malicious server may easily exhaust all the VM memory. It is strongly

691

<a name="682" href="#682">682</a> * recommended, to use getResponseAsStream if the content length of the response

692

<a name="683" href="#683">683</a> * is unknown or resonably large.

693

<a name="684" href="#684">684</a> *

694

<a name="685" href="#685">685</a> * @return The response body.

695

<a name="686" href="#686">686</a> */

696

<a name="687" href="#687">687</a> public byte[] getResponseBody() {

697

<a name="688" href="#688">688</a> if (this.responseBody == null) {

698

<a name="689" href="#689">689</a> try {

699

<a name="690" href="#690">690</a> InputStream instream = getResponseBodyAsStream();

700

<a name="691" href="#691">691</a> if (instream != null) {

701

<a name="692" href="#692">692</a> int contentLength = getResponseContentLength();

702

<a name="693" href="#693">693</a> if ((contentLength == -1) || (contentLength > BUFFER_WARN_TRIGGER_LIMIT)) {

703

<a name="694" href="#694">694</a> LOG.warn("Going to buffer response body of large or unknown size. "

704

<a name="695" href="#695">695</a> +"Using getResponseAsStream instead is recommended.");

705

<a name="696" href="#696">696</a> }

706

<a name="697" href="#697">697</a> LOG.debug("Buffering response body");

707

<a name="698" href="#698">698</a> ByteArrayOutputStream outstream = new ByteArrayOutputStream(

708

<a name="699" href="#699">699</a> contentLength > 0 ? contentLength : DEFAULT_INITIAL_BUFFER_SIZE);

709

<a name="700" href="#700">700</a> byte[] buffer = new byte[4096];

710

<a name="701" href="#701">701</a> int len;

711

<a name="702" href="#702">702</a> while ((len = instream.read(buffer)) > 0) {

712

<a name="703" href="#703">703</a> outstream.write(buffer, 0, len);

713

<a name="704" href="#704">704</a> }

714

<a name="705" href="#705">705</a> outstream.close();

715

<a name="706" href="#706">706</a> setResponseStream(null);

716

<a name="707" href="#707">707</a> this.responseBody = outstream.toByteArray();

717

<a name="708" href="#708">708</a> }

718

<a name="709" href="#709">709</a> } catch (IOException e) {

719

<a name="710" href="#710">710</a> LOG.error("I/O failure reading response body", e);

720

<a name="711" href="#711">711</a> this.responseBody = null;

721

<a name="712" href="#712">712</a> }

722

<a name="713" href="#713">713</a> }

723

<a name="714" href="#714">714</a> return this.responseBody;

724

<a name="715" href="#715">715</a> }

725

726

<a name="717" href="#717">717</a> /***

727

<a name="718" href="#718">718</a> * Returns the response body of the HTTP method, if any, as an {@link InputStream}.

728

<a name="719" href="#719">719</a> * If response body is not available, returns <tt>null</tt>

729

<a name="720" href="#720">720</a> *

730

<a name="721" href="#721">721</a> * @return The response body

731

<a name="722" href="#722">722</a> *

732

<a name="723" href="#723">723</a> * @throws IOException If an I/O (transport) problem occurs while obtaining the

733

<a name="724" href="#724">724</a> * response body.

734

<a name="725" href="#725">725</a> */

735

<a name="726" href="#726">726</a> public InputStream getResponseBodyAsStream() throws IOException {

736

<a name="727" href="#727">727</a> if (responseStream != null) {

737

<a name="728" href="#728">728</a> return responseStream;

738

<a name="729" href="#729">729</a> }

739

<a name="730" href="#730">730</a> if (responseBody != null) {

740

<a name="731" href="#731">731</a> InputStream byteResponseStream = new ByteArrayInputStream(responseBody);

741

<a name="732" href="#732">732</a> LOG.debug("re-creating response stream from byte array");

742

<a name="733" href="#733">733</a> return byteResponseStream;

743

<a name="734" href="#734">734</a> }

744

<a name="735" href="#735">735</a> return null;

745

<a name="736" href="#736">736</a> }

746

747

<a name="738" href="#738">738</a> /***

748

<a name="739" href="#739">739</a> * Returns the response body of the HTTP method, if any, as a {@link String}.

749

<a name="740" href="#740">740</a> * If response body is not available or cannot be read, returns <tt>null</tt>

750

<a name="741" href="#741">741</a> * The string conversion on the data is done using the character encoding specified

751

<a name="742" href="#742">742</a> * in <tt>Content-Type</tt> header.

752

<a name="743" href="#743">743</a> *

753

<a name="744" href="#744">744</a> * Note: This will cause the entire response body to be buffered in memory. A

754

<a name="745" href="#745">745</a> * malicious server may easily exhaust all the VM memory. It is strongly

755

<a name="746" href="#746">746</a> * recommended, to use getResponseAsStream if the content length of the response

756

<a name="747" href="#747">747</a> * is unknown or resonably large.

757

<a name="748" href="#748">748</a> *

758

<a name="749" href="#749">749</a> * @return The response body.

759

<a name="750" href="#750">750</a> */

760

<a name="751" href="#751">751</a> public String getResponseBodyAsString() {

761

<a name="752" href="#752">752</a> byte[] rawdata = null;

762

<a name="753" href="#753">753</a> if (responseAvailable()) {

763

<a name="754" href="#754">754</a> rawdata = getResponseBody();

764

<a name="755" href="#755">755</a> }

765

<a name="756" href="#756">756</a> if (rawdata != null) {

766

<a name="757" href="#757">757</a> return HttpConstants.getContentString(rawdata, getResponseCharSet());

767

<a name="758" href="#758">758</a> } else {

768

<a name="759" href="#759">759</a> return null;

769

<a name="760" href="#760">760</a> }

770

<a name="761" href="#761">761</a> }

771

772

<a name="763" href="#763">763</a> /***

773

<a name="764" href="#764">764</a> * Returns an array of the response footers that the HTTP method currently has

774

<a name="765" href="#765">765</a> * in the order in which they were read.

775

<a name="766" href="#766">766</a> *

776

<a name="767" href="#767">767</a> * @return an array of footers

777

<a name="768" href="#768">768</a> */

778

<a name="769" href="#769">769</a> public <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] getResponseFooters() {

779

<a name="770" href="#770">770</a> return getResponseTrailerHeaderGroup().getAllHeaders();

780

<a name="771" href="#771">771</a> }

781

782

<a name="773" href="#773">773</a> /***

783

<a name="774" href="#774">774</a> * Gets the response footer associated with the given name.

784

<a name="775" href="#775">775</a> * Footer name matching is case insensitive.

785

<a name="776" href="#776">776</a> * <tt>null</tt> will be returned if either footerName is

786

<a name="777" href="#777">777</a> * <tt>null</tt> or there is no matching footer for footerName

787

<a name="778" href="#778">778</a> * or there are no footers available. If there are multiple footers

788

<a name="779" href="#779">779</a> * with the same name, there values will be combined with the ',' separator

789

<a name="780" href="#780">780</a> * as specified by RFC2616.

790

<a name="781" href="#781">781</a> *

791

<a name="782" href="#782">782</a> * @param footerName the footer name to match

792

<a name="783" href="#783">783</a> * @return the matching footer

793

<a name="784" href="#784">784</a> */

794

<a name="785" href="#785">785</a> public <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> getResponseFooter(String footerName) {

795

<a name="786" href="#786">786</a> if (footerName == null) {

796

<a name="787" href="#787">787</a> return null;

797

<a name="788" href="#788">788</a> } else {

798

<a name="789" href="#789">789</a> return getResponseTrailerHeaderGroup().getCondensedHeader(footerName);

799

<a name="790" href="#790">790</a> }

800

<a name="791" href="#791">791</a> }

801

802

<a name="793" href="#793">793</a> /***

803

<a name="794" href="#794">794</a> * Sets the response stream.

804

<a name="795" href="#795">795</a> * @param responseStream The new response stream.

805

<a name="796" href="#796">796</a> */

806

<a name="797" href="#797">797</a> protected void setResponseStream(InputStream responseStream) {

807

<a name="798" href="#798">798</a> this.responseStream = responseStream;

808

<a name="799" href="#799">799</a> }

809

810

<a name="801" href="#801">801</a> /***

811

<a name="802" href="#802">802</a> * Returns a stream from which the body of the current response may be read.

812

<a name="803" href="#803">803</a> * If the method has not yet been executed, if <code>responseBodyConsumed</code>

813

<a name="804" href="#804">804</a> * has been called, or if the stream returned by a previous call has been closed,

814

<a name="805" href="#805">805</a> * <code>null</code> will be returned.

815

<a name="806" href="#806">806</a> *

816

<a name="807" href="#807">807</a> * @return the current response stream

817

<a name="808" href="#808">808</a> */

818

<a name="809" href="#809">809</a> protected InputStream getResponseStream() {

819

<a name="810" href="#810">810</a> return responseStream;

820

<a name="811" href="#811">811</a> }

821

822

<a name="813" href="#813">813</a> /***

823

<a name="814" href="#814">814</a> * Returns the status text (or "reason phrase") associated with the latest

824

<a name="815" href="#815">815</a> * response.

825

<a name="816" href="#816">816</a> *

826

<a name="817" href="#817">817</a> * @return The status text.

827

<a name="818" href="#818">818</a> */

828

<a name="819" href="#819">819</a> public String getStatusText() {

829

<a name="820" href="#820">820</a> return statusLine.getReasonPhrase();

830

<a name="821" href="#821">821</a> }

831

832

<a name="823" href="#823">823</a> /***

833

<a name="824" href="#824">824</a> * Defines how strictly HttpClient follows the HTTP protocol specification

834

<a name="825" href="#825">825</a> * (RFC 2616 and other relevant RFCs). In the strict mode HttpClient precisely

835

<a name="826" href="#826">826</a> * implements the requirements of the specification, whereas in non-strict mode

836

<a name="827" href="#827">827</a> * it attempts to mimic the exact behaviour of commonly used HTTP agents,

837

<a name="828" href="#828">828</a> * which many HTTP servers expect.

838

<a name="829" href="#829">829</a> *

839

<a name="830" href="#830">830</a> * @param strictMode <tt>true</tt> for strict mode, <tt>false</tt> otherwise

840

<a name="831" href="#831">831</a> */

841

<a name="832" href="#832">832</a> public void setStrictMode(boolean strictMode) {

842

<a name="833" href="#833">833</a> this.strictMode = strictMode;

843

<a name="834" href="#834">834</a> }

844

845

<a name="836" href="#836">836</a> /***

846

<a name="837" href="#837">837</a> * Returns the value of the strict mode flag.

847

<a name="838" href="#838">838</a> *

848

<a name="839" href="#839">839</a> * @return <tt>true</tt> if strict mode is enabled, <tt>false</tt> otherwise

849

<a name="840" href="#840">840</a> */

850

<a name="841" href="#841">841</a> public boolean isStrictMode() {

851

<a name="842" href="#842">842</a> return strictMode;

852

<a name="843" href="#843">843</a> }

853

854

<a name="845" href="#845">845</a> /***

855

<a name="846" href="#846">846</a> * Adds the specified request header, NOT overwriting any previous value.

856

<a name="847" href="#847">847</a> * Note that header-name matching is case insensitive.

857

<a name="848" href="#848">848</a> *

858

<a name="849" href="#849">849</a> * @param headerName the header's name

859

<a name="850" href="#850">850</a> * @param headerValue the header's value

860

<a name="851" href="#851">851</a> */

861

<a name="852" href="#852">852</a> public void addRequestHeader(String headerName, String headerValue) {

862

<a name="853" href="#853">853</a> addRequestHeader(new <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>(headerName, headerValue));

863

<a name="854" href="#854">854</a> }

864

865

<a name="856" href="#856">856</a> /***

866

<a name="857" href="#857">857</a> * Tests if the connection should be force-closed when no longer needed.

867

<a name="858" href="#858">858</a> *

868

<a name="859" href="#859">859</a> * @return <code>true</code> if the connection must be closed

869

<a name="860" href="#860">860</a> */

870

<a name="861" href="#861">861</a> protected boolean isConnectionCloseForced() {

871

<a name="862" href="#862">862</a> return this.connectionCloseForced;

872

<a name="863" href="#863">863</a> }

873

874

<a name="865" href="#865">865</a> /***

875

<a name="866" href="#866">866</a> * Sets whether or not the connection should be force-closed when no longer

876

<a name="867" href="#867">867</a> * needed. This value should only be set to <code>true</code> in abnormal

877

<a name="868" href="#868">868</a> * circumstances, such as HTTP protocol violations.

878

<a name="869" href="#869">869</a> *

879

<a name="870" href="#870">870</a> * @param b <code>true</code> if the connection must be closed, <code>false</code>

880

<a name="871" href="#871">871</a> * otherwise.

881

<a name="872" href="#872">872</a> */

882

<a name="873" href="#873">873</a> protected void setConnectionCloseForced(boolean b) {

883

<a name="874" href="#874">874</a> if (LOG.isDebugEnabled()) {

884

<a name="875" href="#875">875</a> LOG.debug("Force-close connection: " + b);

885

<a name="876" href="#876">876</a> }

886

<a name="877" href="#877">877</a> this.connectionCloseForced = b;

887

<a name="878" href="#878">878</a> }

888

889

<a name="880" href="#880">880</a> /***

890

<a name="881" href="#881">881</a> * Tests if the connection should be closed after the method has been executed.

891

<a name="882" href="#882">882</a> * The connection will be left open when using HTTP/1.1 or if <tt>Connection:

892

<a name="883" href="#883">883</a> * keep-alive</tt> header was sent.

893

<a name="884" href="#884">884</a> *

894

<a name="885" href="#885">885</a> * @param conn the connection in question

895

<a name="886" href="#886">886</a> *

896

<a name="887" href="#887">887</a> * @return boolean true if we should close the connection.

897

<a name="888" href="#888">888</a> */

898

<a name="889" href="#889">889</a> protected boolean shouldCloseConnection(<a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn) {

899

900

<a name="891" href="#891">891</a> // Connection must be closed due to an abnormal circumstance

901

<a name="892" href="#892">892</a> if (isConnectionCloseForced()) {

902

<a name="893" href="#893">893</a> LOG.debug("Should force-close connection.");

903

<a name="894" href="#894">894</a> return true;

904

<a name="895" href="#895">895</a> }

905

906

<a name="897" href="#897">897</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> connectionHeader = null;

907

<a name="898" href="#898">898</a> // In case being connected via a proxy server

908

<a name="899" href="#899">899</a> if (!conn.isTransparent()) {

909

<a name="900" href="#900">900</a> // Check for 'proxy-connection' directive

910

<a name="901" href="#901">901</a> connectionHeader = responseHeaders.getFirstHeader("proxy-connection");

911

<a name="902" href="#902">902</a> }

912

<a name="903" href="#903">903</a> // In all cases Check for 'connection' directive

913

<a name="904" href="#904">904</a> // some non-complaint proxy servers send it instread of

914

<a name="905" href="#905">905</a> // expected 'proxy-connection' directive

915

<a name="906" href="#906">906</a> if (connectionHeader == null) {

916

<a name="907" href="#907">907</a> connectionHeader = responseHeaders.getFirstHeader("connection");

917

<a name="908" href="#908">908</a> }

918

<a name="909" href="#909">909</a> if (connectionHeader != null) {

919

<a name="910" href="#910">910</a> if (connectionHeader.getValue().equalsIgnoreCase("close")) {

920

<a name="911" href="#911">911</a> if (LOG.isDebugEnabled()) {

921

<a name="912" href="#912">912</a> LOG.debug("Should close connection in response to "

922

<a name="913" href="#913">913</a> + connectionHeader.toExternalForm());

923

<a name="914" href="#914">914</a> }

924

<a name="915" href="#915">915</a> return true;

925

<a name="916" href="#916">916</a> } else if (connectionHeader.getValue().equalsIgnoreCase("keep-alive")) {

926

<a name="917" href="#917">917</a> if (LOG.isDebugEnabled()) {

927

<a name="918" href="#918">918</a> LOG.debug("Should NOT close connection in response to "

928

<a name="919" href="#919">919</a> + connectionHeader.toExternalForm());

929

<a name="920" href="#920">920</a> }

930

<a name="921" href="#921">921</a> return false;

931

<a name="922" href="#922">922</a> } else {

932

<a name="923" href="#923">923</a> if (LOG.isDebugEnabled()) {

933

<a name="924" href="#924">924</a> LOG.debug("Unknown directive: " + connectionHeader.toExternalForm());

934

<a name="925" href="#925">925</a> }

935

<a name="926" href="#926">926</a> }

936

<a name="927" href="#927">927</a> }

937

<a name="928" href="#928">928</a> LOG.debug("Resorting to protocol version default close connection policy");

938

<a name="929" href="#929">929</a> // missing or invalid connection header, do the default

939

<a name="930" href="#930">930</a> if (http11) {

940

<a name="931" href="#931">931</a> LOG.debug("Should NOT close connection, using HTTP/1.1.");

941

<a name="932" href="#932">932</a> } else {

942

<a name="933" href="#933">933</a> LOG.debug("Should close connection, using HTTP/1.0.");

943

<a name="934" href="#934">934</a> }

944

<a name="935" href="#935">935</a> return !http11;

945

<a name="936" href="#936">936</a> }

946

947

<a name="938" href="#938">938</a> /***

948

<a name="939" href="#939">939</a> * Tests if the method needs to be retried.

949

<a name="940" href="#940">940</a> * @param statusCode The status code

950

<a name="941" href="#941">941</a> * @param state the {@link HttpState state} information associated with this method

951

<a name="942" href="#942">942</a> * @param conn the {@link HttpConnection connection} to be used

952

<a name="943" href="#943">943</a> * @return boolean true if a retry is needed.

953

<a name="944" href="#944">944</a> */

954

<a name="945" href="#945">945</a> private boolean isRetryNeeded(int statusCode, <a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn) {

955

<a name="946" href="#946">946</a> switch (statusCode) {

956

<a name="947" href="#947">947</a> case HttpStatus.SC_UNAUTHORIZED:

957

<a name="948" href="#948">948</a> case HttpStatus.SC_PROXY_AUTHENTICATION_REQUIRED:

958

<a name="949" href="#949">949</a> LOG.debug("Authorization required");

959

<a name="950" href="#950">950</a> if (doAuthentication) { //process authentication response

960

<a name="951" href="#951">951</a> //if the authentication is successful, return the statusCode

961

<a name="952" href="#952">952</a> //otherwise, drop through the switch and try again.

962

<a name="953" href="#953">953</a> if (processAuthenticationResponse(state, conn)) {

963

<a name="954" href="#954">954</a> return false;

964

<a name="955" href="#955">955</a> }

965

<a name="956" href="#956">956</a> } else { //let the client handle the authenticaiton

966

<a name="957" href="#957">957</a> return false;

967

<a name="958" href="#958">958</a> }

968

<a name="959" href="#959">959</a> break;

969

970

<a name="961" href="#961">961</a> case HttpStatus.SC_MOVED_TEMPORARILY:

971

<a name="962" href="#962">962</a> case HttpStatus.SC_MOVED_PERMANENTLY:

972

<a name="963" href="#963">963</a> case HttpStatus.SC_SEE_OTHER:

973

<a name="964" href="#964">964</a> case HttpStatus.SC_TEMPORARY_REDIRECT:

974

<a name="965" href="#965">965</a> LOG.debug("Redirect required");

975

976

<a name="967" href="#967">967</a> if (!processRedirectResponse(conn)) {

977

<a name="968" href="#968">968</a> return false;

978

<a name="969" href="#969">969</a> }

979

<a name="970" href="#970">970</a> break;

980

981

<a name="972" href="#972">972</a> default:

982

<a name="973" href="#973">973</a> // neither an unauthorized nor a redirect response

983

<a name="974" href="#974">974</a> return false;

984

<a name="975" href="#975">975</a> } //end of switch

985

986

<a name="977" href="#977">977</a> return true;

987

<a name="978" href="#978">978</a> }

988

989

<a name="980" href="#980">980</a> /***

990

<a name="981" href="#981">981</a> * Tests if the this method is ready to be executed.

991

<a name="982" href="#982">982</a> *

992

<a name="983" href="#983">983</a> * @param state the {@link HttpState state} information associated with this method

993

<a name="984" href="#984">984</a> * @param conn the {@link HttpConnection connection} to be used

994

<a name="985" href="#985">985</a> * @throws HttpException If the method is in invalid state.

995

<a name="986" href="#986">986</a> */

996

<a name="987" href="#987">987</a> private void checkExecuteConditions(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)

997

<a name="988" href="#988">988</a> throws <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {

998

999

<a name="990" href="#990">990</a> if (state == null) {

1000

<a name="991" href="#991">991</a> throw new IllegalArgumentException("HttpState parameter may not be null");

1001

<a name="992" href="#992">992</a> }

1002

<a name="993" href="#993">993</a> if (conn == null) {

1003

<a name="994" href="#994">994</a> throw new IllegalArgumentException("HttpConnection parameter may not be null");

1004

<a name="995" href="#995">995</a> }

1005

<a name="996" href="#996">996</a> if (hasBeenUsed()) {

1006

<a name="997" href="#997">997</a> throw new <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a>("Already used, but not recycled.");

1007

<a name="998" href="#998">998</a> }

1008

<a name="999" href="#999">999</a> if (!validate()) {

1009

<a name="1000" href="#1000">1000</a> throw new <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a>("Not valid");

1010

<a name="1001" href="#1001">1001</a> }

1011

<a name="1002" href="#1002">1002</a> if (inExecute) {

1012

<a name="1003" href="#1003">1003</a> throw new IllegalStateException("Execute invoked recursively, or exited abnormally.");

1013

<a name="1004" href="#1004">1004</a> }

1014

<a name="1005" href="#1005">1005</a> }

1015

1016

<a name="1007" href="#1007">1007</a> /***

1017

<a name="1008" href="#1008">1008</a> * Execute this HTTP method. Note that we cannot currently support redirects

1018

<a name="1009" href="#1009">1009</a> * that change the connection parameters (host, port, protocol) because

1019

<a name="1010" href="#1010">1010</a> * we don't yet have a good way to get the new connection. For the time

1020

<a name="1011" href="#1011">1011</a> * being, we just return the redirect response code, and allow the user

1021

<a name="1012" href="#1012">1012</a> * agent to resubmit if desired.

1022

<a name="1013" href="#1013">1013</a> *

1023

<a name="1014" href="#1014">1014</a> * @param state {@link HttpState state} information to associate with this

1024

<a name="1015" href="#1015">1015</a> * request. Must be non-null.

1025

<a name="1016" href="#1016">1016</a> * @param conn the {@link HttpConnection connection} to used to execute

1026

<a name="1017" href="#1017">1017</a> * this HTTP method. Must be non-null.

1027

<a name="1018" href="#1018">1018</a> * Note that we cannot currently support redirects that

1028

<a name="1019" href="#1019">1019</a> * change the HttpConnection parameters (host, port, protocol)

1029

<a name="1020" href="#1020">1020</a> * because we don't yet have a good way to get the new connection.

1030

<a name="1021" href="#1021">1021</a> * For the time being, we just return the 302 response, and allow

1031

<a name="1022" href="#1022">1022</a> * the user agent to resubmit if desired.

1032

<a name="1023" href="#1023">1023</a> *

1033

<a name="1024" href="#1024">1024</a> * @return the integer status code if one was obtained, or <tt>-1</tt>

1034

<a name="1025" href="#1025">1025</a> *

1035

<a name="1026" href="#1026">1026</a> * @throws IOException if an I/O (transport) error occurs

1036

<a name="1027" href="#1027">1027</a> * @throws HttpException if a protocol exception occurs.

1037

<a name="1028" href="#1028">1028</a> * @throws HttpRecoverableException if a recoverable transport error occurs.

1038

<a name="1029" href="#1029">1029</a> * Usually this kind of exceptions can be recovered from by

1039

<a name="1030" href="#1030">1030</a> * retrying the HTTP method

1040

<a name="1031" href="#1031">1031</a> */

1041

<a name="1032" href="#1032">1032</a> public int execute(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)

1042

<a name="1033" href="#1033">1033</a> throws HttpException, HttpRecoverableException,

1043

<a name="1034" href="#1034">1034</a> IOException {

1044

1045

<a name="1036" href="#1036">1036</a> LOG.trace("enter HttpMethodBase.execute(HttpState, HttpConnection)");

1046

1047

<a name="1038" href="#1038">1038</a> // this is our connection now, assign it to a local variable so

1048

<a name="1039" href="#1039">1039</a> // that it can be released later

1049

<a name="1040" href="#1040">1040</a> this.responseConnection = conn;

1050

1051

<a name="1042" href="#1042">1042</a> checkExecuteConditions(state, conn);

1052

<a name="1043" href="#1043">1043</a> inExecute = true;

1053

1054

<a name="1045" href="#1045">1045</a> try {

1055

<a name="1046" href="#1046">1046</a> //pre-emptively add the authorization header, if required.

1056

<a name="1047" href="#1047">1047</a> if (state.isAuthenticationPreemptive()) {

1057

1058

<a name="1049" href="#1049">1049</a> LOG.debug("Preemptively sending default basic credentials");

1059

1060

<a name="1051" href="#1051">1051</a> try {

1061

<a name="1052" href="#1052">1052</a> if (HttpAuthenticator.authenticateDefault(this, conn, state)) {

1062

<a name="1053" href="#1053">1053</a> LOG.debug("Default basic credentials applied");

1063

<a name="1054" href="#1054">1054</a> } else {

1064

<a name="1055" href="#1055">1055</a> LOG.warn("Preemptive authentication failed");

1065

<a name="1056" href="#1056">1056</a> }

1066

<a name="1057" href="#1057">1057</a> if (conn.isProxied()) {

1067

<a name="1058" href="#1058">1058</a> if (HttpAuthenticator.authenticateProxyDefault(this, conn, state)) {

1068

<a name="1059" href="#1059">1059</a> LOG.debug("Default basic proxy credentials applied");

1069

<a name="1060" href="#1060">1060</a> } else {

1070

<a name="1061" href="#1061">1061</a> LOG.warn("Preemptive proxy authentication failed");

1071

<a name="1062" href="#1062">1062</a> }

1072

<a name="1063" href="#1063">1063</a> }

1073

<a name="1064" href="#1064">1064</a> } catch (AuthenticationException e) {

1074

<a name="1065" href="#1065">1065</a> // Log error and move on

1075

<a name="1066" href="#1066">1066</a> LOG.error(e.getMessage(), e);

1076

<a name="1067" href="#1067">1067</a> }

1077

<a name="1068" href="#1068">1068</a> }

1078

1079

<a name="1070" href="#1070">1070</a> realms = new HashSet();

1080

<a name="1071" href="#1071">1071</a> proxyRealms = new HashSet();

1081

<a name="1072" href="#1072">1072</a> int forwardCount = 0; //protect from an infinite loop

1082

1083

<a name="1074" href="#1074">1074</a> while (forwardCount++ < MAX_FORWARDS) {

1084

<a name="1075" href="#1075">1075</a> // on every retry, reset this state information.

1085

<a name="1076" href="#1076">1076</a> conn.setLastResponseInputStream(null);

1086

1087

<a name="1078" href="#1078">1078</a> if (LOG.isDebugEnabled()) {

1088

<a name="1079" href="#1079">1079</a> LOG.debug("Execute loop try " + forwardCount);

1089

<a name="1080" href="#1080">1080</a> }

1090

1091

<a name="1082" href="#1082">1082</a> // Discard status line

1092

<a name="1083" href="#1083">1083</a> this.statusLine = null;

1093

<a name="1084" href="#1084">1084</a> this.connectionCloseForced = false;

1094

1095

<a name="1086" href="#1086">1086</a> //write the request and read the response, will retry

1096

<a name="1087" href="#1087">1087</a> processRequest(state, conn);

1097

1098

<a name="1089" href="#1089">1089</a> if (!isRetryNeeded(statusLine.getStatusCode(), state, conn)) {

1099

<a name="1090" href="#1090">1090</a> // nope, no retry needed, exit loop.

1100

<a name="1091" href="#1091">1091</a> break;

1101

<a name="1092" href="#1092">1092</a> }

1102

1103

<a name="1094" href="#1094">1094</a> // retry - close previous stream. Caution - this causes

1104

<a name="1095" href="#1095">1095</a> // responseBodyConsumed to be called, which may also close the

1105

<a name="1096" href="#1096">1096</a> // connection.

1106

<a name="1097" href="#1097">1097</a> if (responseStream != null) {

1107

<a name="1098" href="#1098">1098</a> responseStream.close();

1108

<a name="1099" href="#1099">1099</a> }

1109

1110

<a name="1101" href="#1101">1101</a> } //end of retry loop

1111

1112

<a name="1103" href="#1103">1103</a> if (forwardCount >= MAX_FORWARDS) {

1113

<a name="1104" href="#1104">1104</a> LOG.error("Narrowly avoided an infinite loop in execute");

1114

<a name="1105" href="#1105">1105</a> throw new <a href="../../../../org/apache/commons/httpclient/HttpRecoverableException.html">HttpRecoverableException</a>("Maximum redirects ("

1115

<a name="1106" href="#1106">1106</a> + MAX_FORWARDS + ") exceeded");

1116

<a name="1107" href="#1107">1107</a> }

1117

1118

<a name="1109" href="#1109">1109</a> } finally {

1119

<a name="1110" href="#1110">1110</a> inExecute = false;

1120

<a name="1111" href="#1111">1111</a> // If the response has been fully processed, return the connection

1121

<a name="1112" href="#1112">1112</a> // to the pool. Use this flag, rather than other tests (like

1122

<a name="1113" href="#1113">1113</a> // responseStream == null), as subclasses, might reset the stream,

1123

<a name="1114" href="#1114">1114</a> // for example, reading the entire response into a file and then

1124

<a name="1115" href="#1115">1115</a> // setting the file as the stream.

1125

<a name="1116" href="#1116">1116</a> if (doneWithConnection) {

1126

<a name="1117" href="#1117">1117</a> ensureConnectionRelease();

1127

<a name="1118" href="#1118">1118</a> }

1128

<a name="1119" href="#1119">1119</a> }

1129

1130

<a name="1121" href="#1121">1121</a> return statusLine.getStatusCode();

1131

<a name="1122" href="#1122">1122</a> }

1132

1133

<a name="1124" href="#1124">1124</a> /***

1134

<a name="1125" href="#1125">1125</a> * Process the redirect response.

1135

<a name="1126" href="#1126">1126</a> * @param conn the {@link HttpConnection connection} used to execute

1136

<a name="1127" href="#1127">1127</a> * this HTTP method

1137

<a name="1128" href="#1128">1128</a> * @return boolean <tt>true</tt> if the redirect was successful, <tt>false</tt>

1138

<a name="1129" href="#1129">1129</a> * otherwise.

1139

<a name="1130" href="#1130">1130</a> */

1140

<a name="1131" href="#1131">1131</a> private boolean processRedirectResponse(<a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn) {

1141

1142

<a name="1133" href="#1133">1133</a> if (!getFollowRedirects()) {

1143

<a name="1134" href="#1134">1134</a> LOG.info("Redirect requested but followRedirects is "

1144

<a name="1135" href="#1135">1135</a> + "disabled");

1145

<a name="1136" href="#1136">1136</a> return false;

1146

<a name="1137" href="#1137">1137</a> }

1147

1148

<a name="1139" href="#1139">1139</a> //get the location header to find out where to redirect to

1149

<a name="1140" href="#1140">1140</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> locationHeader = getResponseHeader("location");

1150

<a name="1141" href="#1141">1141</a> if (locationHeader == null) {

1151

<a name="1142" href="#1142">1142</a> // got a redirect response, but no location header

1152

<a name="1143" href="#1143">1143</a> LOG.error("Received redirect response " + getStatusCode()

1153

<a name="1144" href="#1144">1144</a> + " but no location header");

1154

<a name="1145" href="#1145">1145</a> return false;

1155

<a name="1146" href="#1146">1146</a> }

1156

<a name="1147" href="#1147">1147</a> String location = locationHeader.getValue();

1157

<a name="1148" href="#1148">1148</a> if (LOG.isDebugEnabled()) {

1158

<a name="1149" href="#1149">1149</a> LOG.debug("Redirect requested to location '" + location

1159

<a name="1150" href="#1150">1150</a> + "'");

1160

<a name="1151" href="#1151">1151</a> }

1161

1162

<a name="1153" href="#1153">1153</a> //rfc2616 demands the location value be a complete URI

1163

<a name="1154" href="#1154">1154</a> //Location = "Location" ":" absoluteURI

1164

<a name="1155" href="#1155">1155</a> <a href="../../../../org/apache/commons/httpclient/URI.html">URI</a> redirectUri = null;

1165

<a name="1156" href="#1156">1156</a> <a href="../../../../org/apache/commons/httpclient/URI.html">URI</a> currentUri = null;

1166

1167

<a name="1158" href="#1158">1158</a> try {

1168

<a name="1159" href="#1159">1159</a> currentUri = new <a href="../../../../org/apache/commons/httpclient/URI.html">URI</a>(

1169

<a name="1160" href="#1160">1160</a> conn.getProtocol().getScheme(),

1170

<a name="1161" href="#1161">1161</a> null,

1171

<a name="1162" href="#1162">1162</a> conn.getHost(),

1172

<a name="1163" href="#1163">1163</a> conn.getPort(),

1173

<a name="1164" href="#1164">1164</a> this.getPath()

1174

<a name="1165" href="#1165">1165</a> );

1175

<a name="1166" href="#1166">1166</a> redirectUri = new <a href="../../../../org/apache/commons/httpclient/URI.html">URI</a>(location.toCharArray());

1176

<a name="1167" href="#1167">1167</a> if (redirectUri.isRelativeURI()) {

1177

<a name="1168" href="#1168">1168</a> if (isStrictMode()) {

1178

<a name="1169" href="#1169">1169</a> LOG.warn("Redirected location '" + location

1179

<a name="1170" href="#1170">1170</a> + "' is not acceptable in strict mode");

1180

<a name="1171" href="#1171">1171</a> return false;

1181

<a name="1172" href="#1172">1172</a> } else {

1182

<a name="1173" href="#1173">1173</a> //location is incomplete, use current values for defaults

1183

<a name="1174" href="#1174">1174</a> LOG.debug("Redirect URI is not absolute - parsing as relative");

1184

<a name="1175" href="#1175">1175</a> redirectUri = new <a href="../../../../org/apache/commons/httpclient/URI.html">URI</a>(currentUri, redirectUri);

1185

<a name="1176" href="#1176">1176</a> }

1186

<a name="1177" href="#1177">1177</a> }

1187

<a name="1178" href="#1178">1178</a> } catch (URIException e) {

1188

<a name="1179" href="#1179">1179</a> LOG.warn("Redirected location '" + location + "' is malformed");

1189

<a name="1180" href="#1180">1180</a> return false;

1190

<a name="1181" href="#1181">1181</a> }

1191

1192

<a name="1183" href="#1183">1183</a> //check for redirect to a different protocol, host or port

1193

<a name="1184" href="#1184">1184</a> try {

1194

<a name="1185" href="#1185">1185</a> checkValidRedirect(currentUri, redirectUri);

1195

<a name="1186" href="#1186">1186</a> } catch (HttpException ex) {

1196

<a name="1187" href="#1187">1187</a> //LOG the error and let the client handle the redirect

1197

<a name="1188" href="#1188">1188</a> LOG.warn(ex.getMessage());

1198

<a name="1189" href="#1189">1189</a> return false;

1199

<a name="1190" href="#1190">1190</a> }

1200

1201

<a name="1192" href="#1192">1192</a> //invalidate the list of authentication attempts

1202

<a name="1193" href="#1193">1193</a> this.realms.clear();

1203

<a name="1194" href="#1194">1194</a> //remove exisitng authentication headers

1204

<a name="1195" href="#1195">1195</a> if (this.proxyAuthScheme instanceof NTLMScheme) {

1205

<a name="1196" href="#1196">1196</a> removeRequestHeader(HttpAuthenticator.PROXY_AUTH_RESP);

1206

<a name="1197" href="#1197">1197</a> }

1207

<a name="1198" href="#1198">1198</a> removeRequestHeader(HttpAuthenticator.WWW_AUTH_RESP);

1208

<a name="1199" href="#1199">1199</a> //update the current location with the redirect location.

1209

<a name="1200" href="#1200">1200</a> //avoiding use of URL.getPath() and URL.getQuery() to keep

1210

<a name="1201" href="#1201">1201</a> //jdk1.2 comliance.

1211

<a name="1202" href="#1202">1202</a> setPath(redirectUri.getEscapedPath());

1212

<a name="1203" href="#1203">1203</a> setQueryString(redirectUri.getEscapedQuery());

1213

1214

<a name="1205" href="#1205">1205</a> if (LOG.isDebugEnabled()) {

1215

<a name="1206" href="#1206">1206</a> LOG.debug("Redirecting from '" + currentUri.getEscapedURI()

1216

<a name="1207" href="#1207">1207</a> + "' to '" + redirectUri.getEscapedURI());

1217

<a name="1208" href="#1208">1208</a> }

1218

1219

<a name="1210" href="#1210">1210</a> return true;

1220

<a name="1211" href="#1211">1211</a> }

1221

1222

<a name="1213" href="#1213">1213</a> /***

1223

<a name="1214" href="#1214">1214</a> * Check for a valid redirect given the current connection and new URI.

1224

<a name="1215" href="#1215">1215</a> * Redirect to a different protocol, host or port are checked for validity.

1225

<a name="1216" href="#1216">1216</a> *

1226

<a name="1217" href="#1217">1217</a> * @param currentUri The current URI (redirecting from)

1227

<a name="1218" href="#1218">1218</a> * @param redirectUri The new URI to redirect to

1228

<a name="1219" href="#1219">1219</a> * @throws HttpException if the redirect is invalid

1229

<a name="1220" href="#1220">1220</a> * @since 2.0

1230

<a name="1221" href="#1221">1221</a> */

1231

<a name="1222" href="#1222">1222</a> private static void checkValidRedirect(<a href="../../../../org/apache/commons/httpclient/URI.html">URI</a> currentUri, <a href="../../../../org/apache/commons/httpclient/URI.html">URI</a> redirectUri)

1232

<a name="1223" href="#1223">1223</a> throws <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {

1233

<a name="1224" href="#1224">1224</a> LOG.trace("enter HttpMethodBase.checkValidRedirect(HttpConnection, URL)");

1234

1235

<a name="1226" href="#1226">1226</a> String oldProtocol = currentUri.getScheme();

1236

<a name="1227" href="#1227">1227</a> String newProtocol = redirectUri.getScheme();

1237

<a name="1228" href="#1228">1228</a> if (!oldProtocol.equals(newProtocol)) {

1238

<a name="1229" href="#1229">1229</a> throw new <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a>("Redirect from protocol " + oldProtocol

1239

<a name="1230" href="#1230">1230</a> + " to " + newProtocol + " is not supported");

1240

<a name="1231" href="#1231">1231</a> }

1241

1242

<a name="1233" href="#1233">1233</a> try {

1243

<a name="1234" href="#1234">1234</a> String oldHost = currentUri.getHost();

1244

<a name="1235" href="#1235">1235</a> String newHost = redirectUri.getHost();

1245

<a name="1236" href="#1236">1236</a> if (!oldHost.equalsIgnoreCase(newHost)) {

1246

<a name="1237" href="#1237">1237</a> throw new <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a>("Redirect from host " + oldHost

1247

<a name="1238" href="#1238">1238</a> + " to " + newHost + " is not supported");

1248

<a name="1239" href="#1239">1239</a> }

1249

<a name="1240" href="#1240">1240</a> } catch (URIException e) {

1250

<a name="1241" href="#1241">1241</a> LOG.warn("Error getting URI host", e);

1251

<a name="1242" href="#1242">1242</a> throw new <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a>("Invalid Redirect URI from: "

1252

<a name="1243" href="#1243">1243</a> + currentUri.getEscapedURI() + " to: " + redirectUri.getEscapedURI()

1253

<a name="1244" href="#1244">1244</a> );

1254

<a name="1245" href="#1245">1245</a> }

1255

1256

<a name="1247" href="#1247">1247</a> int oldPort = currentUri.getPort();

1257

<a name="1248" href="#1248">1248</a> if (oldPort < 0) {

1258

<a name="1249" href="#1249">1249</a> oldPort = getDefaultPort(oldProtocol);

1259

<a name="1250" href="#1250">1250</a> }

1260

<a name="1251" href="#1251">1251</a> int newPort = redirectUri.getPort();

1261

<a name="1252" href="#1252">1252</a> if (newPort < 0) {

1262

<a name="1253" href="#1253">1253</a> newPort = getDefaultPort(newProtocol);

1263

<a name="1254" href="#1254">1254</a> }

1264

<a name="1255" href="#1255">1255</a> if (oldPort != newPort) {

1265

<a name="1256" href="#1256">1256</a> throw new <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a>("Redirect from port " + oldPort

1266

<a name="1257" href="#1257">1257</a> + " to " + newPort + " is not supported");

1267

<a name="1258" href="#1258">1258</a> }

1268

<a name="1259" href="#1259">1259</a> }

1269

1270

<a name="1261" href="#1261">1261</a> /***

1271

<a name="1262" href="#1262">1262</a> * Returns the default port for the given protocol.

1272

<a name="1263" href="#1263">1263</a> *

1273

<a name="1264" href="#1264">1264</a> * @param protocol the given protocol.

1274

<a name="1265" href="#1265">1265</a> * @return the default port of the given protocol or -1 if the

1275

<a name="1266" href="#1266">1266</a> * protocol is not recognized.

1276

<a name="1267" href="#1267">1267</a> *

1277

<a name="1268" href="#1268">1268</a> * @since 2.0

1278

<a name="1269" href="#1269">1269</a> *

1279

<a name="1270" href="#1270">1270</a> */

1280

<a name="1271" href="#1271">1271</a> private static int getDefaultPort(String protocol) {

1281

<a name="1272" href="#1272">1272</a> String proto = protocol.toLowerCase().trim();

1282

<a name="1273" href="#1273">1273</a> if (proto.equals("http")) {

1283

<a name="1274" href="#1274">1274</a> return 80;

1284

<a name="1275" href="#1275">1275</a> } else if (proto.equals("https")) {

1285

<a name="1276" href="#1276">1276</a> return 443;

1286

<a name="1277" href="#1277">1277</a> }

1287

<a name="1278" href="#1278">1278</a> return -1;

1288

<a name="1279" href="#1279">1279</a> }

1289

1290

<a name="1281" href="#1281">1281</a> /***

1291

<a name="1282" href="#1282">1282</a> * Returns <tt>true</tt> if the HTTP method has been already {@link #execute executed},

1292

<a name="1283" href="#1283">1283</a> * but not {@link #recycle recycled}.

1293

<a name="1284" href="#1284">1284</a> *

1294

<a name="1285" href="#1285">1285</a> * @return <tt>true</tt> if the method has been executed, <tt>false</tt> otherwise

1295

<a name="1286" href="#1286">1286</a> */

1296

<a name="1287" href="#1287">1287</a> public boolean hasBeenUsed() {

1297

<a name="1288" href="#1288">1288</a> return used;

1298

<a name="1289" href="#1289">1289</a> }

1299

1300

<a name="1291" href="#1291">1291</a> /***

1301

<a name="1292" href="#1292">1292</a> * Recycles the HTTP method so that it can be used again.

1302

<a name="1293" href="#1293">1293</a> * Note that all of the instance variables will be reset

1303

<a name="1294" href="#1294">1294</a> * once this method has been called. This method will also

1304

<a name="1295" href="#1295">1295</a> * release the connection being used by this HTTP method.

1305

<a name="1296" href="#1296">1296</a> *

1306

<a name="1297" href="#1297">1297</a> * @see #releaseConnection()

1307

<a name="1298" href="#1298">1298</a> *

1308

<a name="1299" href="#1299">1299</a> * @deprecated no longer supported and will be removed in the future

1309

<a name="1300" href="#1300">1300</a> * version of HttpClient

1310

<a name="1301" href="#1301">1301</a> */

1311

<a name="1302" href="#1302">1302</a> public void recycle() {

1312

<a name="1303" href="#1303">1303</a> LOG.trace("enter HttpMethodBase.recycle()");

1313

1314

<a name="1305" href="#1305">1305</a> releaseConnection();

1315

1316

<a name="1307" href="#1307">1307</a> path = null;

1317

<a name="1308" href="#1308">1308</a> followRedirects = false;

1318

<a name="1309" href="#1309">1309</a> doAuthentication = true;

1319

<a name="1310" href="#1310">1310</a> authScheme = null;

1320

<a name="1311" href="#1311">1311</a> realm = null;

1321

<a name="1312" href="#1312">1312</a> proxyAuthScheme = null;

1322

<a name="1313" href="#1313">1313</a> proxyRealm = null;

1323

<a name="1314" href="#1314">1314</a> queryString = null;

1324

<a name="1315" href="#1315">1315</a> getRequestHeaderGroup().clear();

1325

<a name="1316" href="#1316">1316</a> getResponseHeaderGroup().clear();

1326

<a name="1317" href="#1317">1317</a> getResponseTrailerHeaderGroup().clear();

1327

<a name="1318" href="#1318">1318</a> statusLine = null;

1328

<a name="1319" href="#1319">1319</a> used = false;

1329

<a name="1320" href="#1320">1320</a> http11 = true;

1330

<a name="1321" href="#1321">1321</a> responseBody = null;

1331

<a name="1322" href="#1322">1322</a> recoverableExceptionCount = 0;

1332

<a name="1323" href="#1323">1323</a> inExecute = false;

1333

<a name="1324" href="#1324">1324</a> doneWithConnection = false;

1334

<a name="1325" href="#1325">1325</a> connectionCloseForced = false;

1335

<a name="1326" href="#1326">1326</a> }

1336

1337

<a name="1328" href="#1328">1328</a> /***

1338

<a name="1329" href="#1329">1329</a> * Releases the connection being used by this HTTP method. In particular the

1339

<a name="1330" href="#1330">1330</a> * connection is used to read the response(if there is one) and will be held

1340

<a name="1331" href="#1331">1331</a> * until the response has been read. If the connection can be reused by other

1341

<a name="1332" href="#1332">1332</a> * HTTP methods it is NOT closed at this point.

1342

<a name="1333" href="#1333">1333</a> *

1343

<a name="1334" href="#1334">1334</a> * @since 2.0

1344

<a name="1335" href="#1335">1335</a> */

1345

<a name="1336" href="#1336">1336</a> public void releaseConnection() {

1346

1347

<a name="1338" href="#1338">1338</a> if (responseStream != null) {

1348

<a name="1339" href="#1339">1339</a> try {

1349

<a name="1340" href="#1340">1340</a> // FYI - this may indirectly invoke responseBodyConsumed.

1350

<a name="1341" href="#1341">1341</a> responseStream.close();

1351

<a name="1342" href="#1342">1342</a> } catch (IOException e) {

1352

<a name="1343" href="#1343">1343</a> // the connection may not have been released, let's make sure

1353

<a name="1344" href="#1344">1344</a> ensureConnectionRelease();

1354

<a name="1345" href="#1345">1345</a> }

1355

<a name="1346" href="#1346">1346</a> } else {

1356

<a name="1347" href="#1347">1347</a> // Make sure the connection has been released. If the response

1357

<a name="1348" href="#1348">1348</a> // stream has not been set, this is the only way to release the

1358

<a name="1349" href="#1349">1349</a> // connection.

1359

<a name="1350" href="#1350">1350</a> ensureConnectionRelease();

1360

<a name="1351" href="#1351">1351</a> }

1361

<a name="1352" href="#1352">1352</a> }

1362

1363

<a name="1354" href="#1354">1354</a> /***

1364

<a name="1355" href="#1355">1355</a> * Remove the request header associated with the given name. Note that

1365

<a name="1356" href="#1356">1356</a> * header-name matching is case insensitive.

1366

<a name="1357" href="#1357">1357</a> *

1367

<a name="1358" href="#1358">1358</a> * @param headerName the header name

1368

<a name="1359" href="#1359">1359</a> */

1369

<a name="1360" href="#1360">1360</a> public void removeRequestHeader(String headerName) {

1370

1371

<a name="1362" href="#1362">1362</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] headers = getRequestHeaderGroup().getHeaders(headerName);

1372

<a name="1363" href="#1363">1363</a> for (int i = 0; i < headers.length; i++) {

1373

<a name="1364" href="#1364">1364</a> getRequestHeaderGroup().removeHeader(headers[i]);

1374

<a name="1365" href="#1365">1365</a> }

1375

1376

<a name="1367" href="#1367">1367</a> }

1377

1378

<a name="1369" href="#1369">1369</a> // ---------------------------------------------------------------- Queries

1379

1380

<a name="1371" href="#1371">1371</a> /***

1381

<a name="1372" href="#1372">1372</a> * Returns <tt>true</tt> the method is ready to execute, <tt>false</tt> otherwise.

1382

<a name="1373" href="#1373">1373</a> *

1383

<a name="1374" href="#1374">1374</a> * @return This implementation always returns <tt>true</tt>.

1384

<a name="1375" href="#1375">1375</a> */

1385

<a name="1376" href="#1376">1376</a> public boolean validate() {

1386

<a name="1377" href="#1377">1377</a> return true;

1387

<a name="1378" href="#1378">1378</a> }

1388

1389

<a name="1380" href="#1380">1380</a> /***

1390

<a name="1381" href="#1381">1381</a> * Return the length (in bytes) of my request body, suitable for use in a

1391

<a name="1382" href="#1382">1382</a> * <tt>Content-Length</tt> header.

1392

<a name="1383" href="#1383">1383</a> *

1393

<a name="1384" href="#1384">1384</a> *

1394

<a name="1385" href="#1385">1385</a> * Return <tt>-1</tt> when the content-length is unknown.

1395

<a name="1386" href="#1386">1386</a> *

1396

<a name="1387" href="#1387">1387</a> *

1397

<a name="1388" href="#1388">1388</a> *

1398

<a name="1389" href="#1389">1389</a> * This implementation returns <tt>0</tt>, indicating that the request has

1399

<a name="1390" href="#1390">1390</a> * no body.

1400

<a name="1391" href="#1391">1391</a> *

1401

<a name="1392" href="#1392">1392</a> *

1402

<a name="1393" href="#1393">1393</a> * @return <tt>0</tt>, indicating that the request has no body.

1403

<a name="1394" href="#1394">1394</a> */

1404

<a name="1395" href="#1395">1395</a> protected int getRequestContentLength() {

1405

<a name="1396" href="#1396">1396</a> return 0;

1406

<a name="1397" href="#1397">1397</a> }

1407

1408

<a name="1399" href="#1399">1399</a> /***

1409

<a name="1400" href="#1400">1400</a> * Generates <tt>Authorization</tt> request header if needed, as long as no

1410

<a name="1401" href="#1401">1401</a> * <tt>Authorization</tt> request header already exists.

1411

<a name="1402" href="#1402">1402</a> *

1412

<a name="1403" href="#1403">1403</a> * @param state the {@link HttpState state} information associated with this method

1413

<a name="1404" href="#1404">1404</a> * @param conn the {@link HttpConnection connection} used to execute

1414

<a name="1405" href="#1405">1405</a> * this HTTP method

1415

<a name="1406" href="#1406">1406</a> *

1416

<a name="1407" href="#1407">1407</a> * @throws IOException if an I/O (transport) error occurs

1417

<a name="1408" href="#1408">1408</a> * @throws HttpException if a protocol exception occurs.

1418

<a name="1409" href="#1409">1409</a> * @throws HttpRecoverableException if a recoverable transport error occurs.

1419

<a name="1410" href="#1410">1410</a> * Usually this kind of exceptions can be recovered from by

1420

<a name="1411" href="#1411">1411</a> * retrying the HTTP method

1421

<a name="1412" href="#1412">1412</a> */

1422

<a name="1413" href="#1413">1413</a> protected void addAuthorizationRequestHeader(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state,

1423

<a name="1414" href="#1414">1414</a> <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)

1424

<a name="1415" href="#1415">1415</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {

1425

<a name="1416" href="#1416">1416</a> LOG.trace("enter HttpMethodBase.addAuthorizationRequestHeader("

1426

<a name="1417" href="#1417">1417</a> + "HttpState, HttpConnection)");

1427

1428

<a name="1419" href="#1419">1419</a> // add authorization header, if needed

1429

<a name="1420" href="#1420">1420</a> if (getRequestHeader(HttpAuthenticator.WWW_AUTH_RESP) == null) {

1430

<a name="1421" href="#1421">1421</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] challenges = getResponseHeaderGroup().getHeaders(

1431

<a name="1422" href="#1422">1422</a> HttpAuthenticator.WWW_AUTH);

1432

<a name="1423" href="#1423">1423</a> if (challenges.length > 0) {

1433

<a name="1424" href="#1424">1424</a> try {

1434

<a name="1425" href="#1425">1425</a> this.authScheme = HttpAuthenticator.selectAuthScheme(challenges);

1435

<a name="1426" href="#1426">1426</a> HttpAuthenticator.authenticate(this.authScheme, this, conn, state);

1436

<a name="1427" href="#1427">1427</a> } catch (HttpException e) {

1437

<a name="1428" href="#1428">1428</a> // log and move on

1438

<a name="1429" href="#1429">1429</a> if (LOG.isErrorEnabled()) {

1439

<a name="1430" href="#1430">1430</a> LOG.error(e.getMessage(), e);

1440

<a name="1431" href="#1431">1431</a> }

1441

<a name="1432" href="#1432">1432</a> }

1442

<a name="1433" href="#1433">1433</a> }

1443

<a name="1434" href="#1434">1434</a> }

1444

<a name="1435" href="#1435">1435</a> }

1445

1446

<a name="1437" href="#1437">1437</a> /***

1447

<a name="1438" href="#1438">1438</a> * Generates <tt>Content-Length</tt> or <tt>Transfer-Encoding: Chunked</tt>

1448

<a name="1439" href="#1439">1439</a> * request header, as long as no <tt>Content-Length</tt> request header

1449

<a name="1440" href="#1440">1440</a> * already exists.

1450

<a name="1441" href="#1441">1441</a> *

1451

<a name="1442" href="#1442">1442</a> * @param state the {@link HttpState state} information associated with this method

1452

<a name="1443" href="#1443">1443</a> * @param conn the {@link HttpConnection connection} used to execute

1453

<a name="1444" href="#1444">1444</a> * this HTTP method

1454

<a name="1445" href="#1445">1445</a> *

1455

<a name="1446" href="#1446">1446</a> * @throws IOException if an I/O (transport) error occurs

1456

<a name="1447" href="#1447">1447</a> * @throws HttpException if a protocol exception occurs.

1457

<a name="1448" href="#1448">1448</a> * @throws HttpRecoverableException if a recoverable transport error occurs.

1458

<a name="1449" href="#1449">1449</a> * Usually this kind of exceptions can be recovered from by

1459

<a name="1450" href="#1450">1450</a> * retrying the HTTP method

1460

<a name="1451" href="#1451">1451</a> */

1461

<a name="1452" href="#1452">1452</a> protected void addContentLengthRequestHeader(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state,

1462

<a name="1453" href="#1453">1453</a> <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)

1463

<a name="1454" href="#1454">1454</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {

1464

<a name="1455" href="#1455">1455</a> LOG.trace("enter HttpMethodBase.addContentLengthRequestHeader("

1465

<a name="1456" href="#1456">1456</a> + "HttpState, HttpConnection)");

1466

1467

<a name="1458" href="#1458">1458</a> // add content length or chunking

1468

<a name="1459" href="#1459">1459</a> int len = getRequestContentLength();

1469

<a name="1460" href="#1460">1460</a> if (getRequestHeader("content-length") == null) {

1470

<a name="1461" href="#1461">1461</a> if (0 < len) {

1471

<a name="1462" href="#1462">1462</a> setRequestHeader("Content-Length", String.valueOf(len));

1472

<a name="1463" href="#1463">1463</a> } else if (http11 && (len < 0)) {

1473

<a name="1464" href="#1464">1464</a> setRequestHeader("Transfer-Encoding", "chunked");

1474

<a name="1465" href="#1465">1465</a> }

1475

<a name="1466" href="#1466">1466</a> }

1476

<a name="1467" href="#1467">1467</a> }

1477

1478

<a name="1469" href="#1469">1469</a> /***

1479

<a name="1470" href="#1470">1470</a> * Generates <tt>Cookie</tt> request headers for those {@link Cookie cookie}s

1480

<a name="1471" href="#1471">1471</a> * that match the given host, port and path.

1481

<a name="1472" href="#1472">1472</a> *

1482

<a name="1473" href="#1473">1473</a> * @param state the {@link HttpState state} information associated with this method

1483

<a name="1474" href="#1474">1474</a> * @param conn the {@link HttpConnection connection} used to execute

1484

<a name="1475" href="#1475">1475</a> * this HTTP method

1485

<a name="1476" href="#1476">1476</a> *

1486

<a name="1477" href="#1477">1477</a> * @throws IOException if an I/O (transport) error occurs

1487

<a name="1478" href="#1478">1478</a> * @throws HttpException if a protocol exception occurs.

1488

<a name="1479" href="#1479">1479</a> * @throws HttpRecoverableException if a recoverable transport error occurs.

1489

<a name="1480" href="#1480">1480</a> * Usually this kind of exceptions can be recovered from by

1490

<a name="1481" href="#1481">1481</a> * retrying the HTTP method

1491

<a name="1482" href="#1482">1482</a> */

1492

<a name="1483" href="#1483">1483</a> protected void addCookieRequestHeader(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)

1493

<a name="1484" href="#1484">1484</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {

1494

1495

<a name="1486" href="#1486">1486</a> LOG.trace("enter HttpMethodBase.addCookieRequestHeader(HttpState, "

1496

<a name="1487" href="#1487">1487</a> + "HttpConnection)");

1497

1498

<a name="1489" href="#1489">1489</a> // Clean up the cookie headers

1499

<a name="1490" href="#1490">1490</a> removeRequestHeader("cookie");

1500

1501

<a name="1492" href="#1492">1492</a> <a href="../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</a> matcher = CookiePolicy.getSpecByPolicy(state.getCookiePolicy());

1502

<a name="1493" href="#1493">1493</a> <a href="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a>[] cookies = matcher.match(conn.getHost(), conn.getPort(),

1503

<a name="1494" href="#1494">1494</a> getPath(), conn.isSecure(), state.getCookies());

1504

<a name="1495" href="#1495">1495</a> if ((cookies != null) && (cookies.length > 0)) {

1505

<a name="1496" href="#1496">1496</a> if (this.isStrictMode()) {

1506

<a name="1497" href="#1497">1497</a> // In strict mode put all cookies on the same header

1507

<a name="1498" href="#1498">1498</a> getRequestHeaderGroup().addHeader(

1508

<a name="1499" href="#1499">1499</a> matcher.formatCookieHeader(cookies));

1509

<a name="1500" href="#1500">1500</a> } else {

1510

<a name="1501" href="#1501">1501</a> // In non-strict mode put each cookie on a separate header

1511

<a name="1502" href="#1502">1502</a> for (int i = 0; i < cookies.length; i++) {

1512

<a name="1503" href="#1503">1503</a> getRequestHeaderGroup().addHeader(

1513

<a name="1504" href="#1504">1504</a> matcher.formatCookieHeader(cookies[i]));

1514

<a name="1505" href="#1505">1505</a> }

1515

<a name="1506" href="#1506">1506</a> }

1516

<a name="1507" href="#1507">1507</a> }

1517

<a name="1508" href="#1508">1508</a> }

1518

1519

<a name="1510" href="#1510">1510</a> /***

1520

<a name="1511" href="#1511">1511</a> * Generates <tt>Host</tt> request header, as long as no <tt>Host</tt> request

1521

<a name="1512" href="#1512">1512</a> * header already exists.

1522

<a name="1513" href="#1513">1513</a> *

1523

<a name="1514" href="#1514">1514</a> * @param state the {@link HttpState state} information associated with this method

1524

<a name="1515" href="#1515">1515</a> * @param conn the {@link HttpConnection connection} used to execute

1525

<a name="1516" href="#1516">1516</a> * this HTTP method

1526

<a name="1517" href="#1517">1517</a> *

1527

<a name="1518" href="#1518">1518</a> * @throws IOException if an I/O (transport) error occurs

1528

<a name="1519" href="#1519">1519</a> * @throws HttpException if a protocol exception occurs.

1529

<a name="1520" href="#1520">1520</a> * @throws HttpRecoverableException if a recoverable transport error occurs.

1530

<a name="1521" href="#1521">1521</a> * Usually this kind of exceptions can be recovered from by

1531

<a name="1522" href="#1522">1522</a> * retrying the HTTP method

1532

<a name="1523" href="#1523">1523</a> */

1533

<a name="1524" href="#1524">1524</a> protected void addHostRequestHeader(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)

1534

<a name="1525" href="#1525">1525</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {

1535

<a name="1526" href="#1526">1526</a> LOG.trace("enter HttpMethodBase.addHostRequestHeader(HttpState, "

1536

<a name="1527" href="#1527">1527</a> + "HttpConnection)");

1537

1538

<a name="1529" href="#1529">1529</a> // Per 19.6.1.1 of RFC 2616, it is legal for HTTP/1.0 based

1539

<a name="1530" href="#1530">1530</a> // applications to send the Host request-header.

1540

<a name="1531" href="#1531">1531</a> // TODO: Add the ability to disable the sending of this header for

1541

<a name="1532" href="#1532">1532</a> // HTTP/1.0 requests.

1542

<a name="1533" href="#1533">1533</a> String host = conn.getVirtualHost();

1543

<a name="1534" href="#1534">1534</a> if (host != null) {

1544

<a name="1535" href="#1535">1535</a> LOG.debug("Using virtual host name: " + host);

1545

<a name="1536" href="#1536">1536</a> } else {

1546

<a name="1537" href="#1537">1537</a> host = conn.getHost();

1547

<a name="1538" href="#1538">1538</a> }

1548

<a name="1539" href="#1539">1539</a> int port = conn.getPort();

1549

1550

<a name="1541" href="#1541">1541</a> if (getRequestHeader("host") != null) {

1551

<a name="1542" href="#1542">1542</a> LOG.debug(

1552

<a name="1543" href="#1543">1543</a> "Request to add Host header ignored: header already added");

1553

<a name="1544" href="#1544">1544</a> return;

1554

<a name="1545" href="#1545">1545</a> }

1555

1556

<a name="1547" href="#1547">1547</a> // Note: RFC 2616 uses the term "internet host name" for what goes on the

1557

<a name="1548" href="#1548">1548</a> // host line. It would seem to imply that host should be blank if the

1558

<a name="1549" href="#1549">1549</a> // host is a number instead of an name. Based on the behavior of web

1559

<a name="1550" href="#1550">1550</a> // browsers, and the fact that RFC 2616 never defines the phrase "internet

1560

<a name="1551" href="#1551">1551</a> // host name", and the bad behavior of HttpClient that follows if we

1561

<a name="1552" href="#1552">1552</a> // send blank, I interpret this as a small misstatement in the RFC, where

1562

<a name="1553" href="#1553">1553</a> // they meant to say "internet host". So IP numbers get sent as host

1563

<a name="1554" href="#1554">1554</a> // entries too. -- Eric Johnson 12/13/2002

1564

<a name="1555" href="#1555">1555</a> if (LOG.isDebugEnabled()) {

1565

<a name="1556" href="#1556">1556</a> LOG.debug("Adding Host request header");

1566

<a name="1557" href="#1557">1557</a> }

1567

1568

<a name="1559" href="#1559">1559</a> //appends the port only if not using the default port for the protocol

1569

<a name="1560" href="#1560">1560</a> if (conn.getProtocol().getDefaultPort() != port) {

1570

<a name="1561" href="#1561">1561</a> host += (":" + port);

1571

<a name="1562" href="#1562">1562</a> }

1572

1573

<a name="1564" href="#1564">1564</a> setRequestHeader("Host", host);

1574

<a name="1565" href="#1565">1565</a> }

1575

1576

<a name="1567" href="#1567">1567</a> /***

1577

<a name="1568" href="#1568">1568</a> * Generates <tt>Proxy-Authorization</tt> request header if needed, as long as no

1578

<a name="1569" href="#1569">1569</a> * <tt>Proxy-Authorization</tt> request header already exists.

1579

<a name="1570" href="#1570">1570</a> *

1580

<a name="1571" href="#1571">1571</a> * @param state the {@link HttpState state} information associated with this method

1581

<a name="1572" href="#1572">1572</a> * @param conn the {@link HttpConnection connection} used to execute

1582

<a name="1573" href="#1573">1573</a> * this HTTP method

1583

<a name="1574" href="#1574">1574</a> *

1584

<a name="1575" href="#1575">1575</a> * @throws IOException if an I/O (transport) error occurs

1585

<a name="1576" href="#1576">1576</a> * @throws HttpException if a protocol exception occurs.

1586

<a name="1577" href="#1577">1577</a> * @throws HttpRecoverableException if a recoverable transport error occurs.

1587

<a name="1578" href="#1578">1578</a> * Usually this kind of exceptions can be recovered from by

1588

<a name="1579" href="#1579">1579</a> * retrying the HTTP method

1589

<a name="1580" href="#1580">1580</a> */

1590

<a name="1581" href="#1581">1581</a> protected void addProxyAuthorizationRequestHeader(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state,

1591

<a name="1582" href="#1582">1582</a> <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)

1592

<a name="1583" href="#1583">1583</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {

1593

<a name="1584" href="#1584">1584</a> LOG.trace("enter HttpMethodBase.addProxyAuthorizationRequestHeader("

1594

<a name="1585" href="#1585">1585</a> + "HttpState, HttpConnection)");

1595

1596

<a name="1587" href="#1587">1587</a> // add proxy authorization header, if needed

1597

<a name="1588" href="#1588">1588</a> if (getRequestHeader(HttpAuthenticator.PROXY_AUTH_RESP) == null) {

1598

<a name="1589" href="#1589">1589</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] challenges = getResponseHeaderGroup().getHeaders(

1599

<a name="1590" href="#1590">1590</a> HttpAuthenticator.PROXY_AUTH);

1600

<a name="1591" href="#1591">1591</a> if (challenges.length > 0) {

1601

<a name="1592" href="#1592">1592</a> try {

1602

<a name="1593" href="#1593">1593</a> this.proxyAuthScheme = HttpAuthenticator.selectAuthScheme(challenges);

1603

<a name="1594" href="#1594">1594</a> HttpAuthenticator.authenticateProxy(this.proxyAuthScheme, this, conn, state);

1604

<a name="1595" href="#1595">1595</a> } catch (HttpException e) {

1605

<a name="1596" href="#1596">1596</a> // log and move on

1606

<a name="1597" href="#1597">1597</a> if (LOG.isErrorEnabled()) {

1607

<a name="1598" href="#1598">1598</a> LOG.error(e.getMessage(), e);

1608

<a name="1599" href="#1599">1599</a> }

1609

<a name="1600" href="#1600">1600</a> }

1610

<a name="1601" href="#1601">1601</a> }

1611

<a name="1602" href="#1602">1602</a> }

1612

<a name="1603" href="#1603">1603</a> }

1613

1614

<a name="1605" href="#1605">1605</a> /***

1615

<a name="1606" href="#1606">1606</a> * Generates <tt>Proxy-Connection: Keep-Alive</tt> request header when

1616

<a name="1607" href="#1607">1607</a> * communicating via a proxy server.

1617

<a name="1608" href="#1608">1608</a> *

1618

<a name="1609" href="#1609">1609</a> * @param state the {@link HttpState state} information associated with this method

1619

<a name="1610" href="#1610">1610</a> * @param conn the {@link HttpConnection connection} used to execute

1620

<a name="1611" href="#1611">1611</a> * this HTTP method

1621

<a name="1612" href="#1612">1612</a> *

1622

<a name="1613" href="#1613">1613</a> * @throws IOException if an I/O (transport) error occurs

1623

<a name="1614" href="#1614">1614</a> * @throws HttpException if a protocol exception occurs.

1624

<a name="1615" href="#1615">1615</a> * @throws HttpRecoverableException if a recoverable transport error occurs.

1625

<a name="1616" href="#1616">1616</a> * Usually this kind of exceptions can be recovered from by

1626

<a name="1617" href="#1617">1617</a> * retrying the HTTP method

1627

<a name="1618" href="#1618">1618</a> */

1628

<a name="1619" href="#1619">1619</a> protected void addProxyConnectionHeader(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state,

1629

<a name="1620" href="#1620">1620</a> <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)

1630

<a name="1621" href="#1621">1621</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {

1631

<a name="1622" href="#1622">1622</a> LOG.trace("enter HttpMethodBase.addProxyConnectionHeader("

1632

<a name="1623" href="#1623">1623</a> + "HttpState, HttpConnection)");

1633

<a name="1624" href="#1624">1624</a> if (!conn.isTransparent()) {

1634

<a name="1625" href="#1625">1625</a> setRequestHeader("Proxy-Connection", "Keep-Alive");

1635

<a name="1626" href="#1626">1626</a> }

1636

<a name="1627" href="#1627">1627</a> }

1637

1638

<a name="1629" href="#1629">1629</a> /***

1639

<a name="1630" href="#1630">1630</a> * Generates all the required request {@link Header header}s

1640

<a name="1631" href="#1631">1631</a> * to be submitted via the given {@link HttpConnection connection}.

1641

<a name="1632" href="#1632">1632</a> *

1642

<a name="1633" href="#1633">1633</a> *

1643

<a name="1634" href="#1634">1634</a> * This implementation adds <tt>User-Agent</tt>, <tt>Host</tt>,

1644

<a name="1635" href="#1635">1635</a> * <tt>Cookie</tt>, <tt>Content-Length</tt>, <tt>Transfer-Encoding</tt>,

1645

<a name="1636" href="#1636">1636</a> * and <tt>Authorization</tt> headers, when appropriate.

1646

<a name="1637" href="#1637">1637</a> *

1647

<a name="1638" href="#1638">1638</a> *

1648

<a name="1639" href="#1639">1639</a> *

1649

<a name="1640" href="#1640">1640</a> * Subclasses may want to override this method to to add additional

1650

<a name="1641" href="#1641">1641</a> * headers, and may choose to invoke this implementation (via

1651

<a name="1642" href="#1642">1642</a> * <tt>super</tt>) to add the "standard" headers.

1652

<a name="1643" href="#1643">1643</a> *

1653

<a name="1644" href="#1644">1644</a> *

1654

<a name="1645" href="#1645">1645</a> * @param state the {@link HttpState state} information associated with this method

1655

<a name="1646" href="#1646">1646</a> * @param conn the {@link HttpConnection connection} used to execute

1656

<a name="1647" href="#1647">1647</a> * this HTTP method

1657

<a name="1648" href="#1648">1648</a> *

1658

<a name="1649" href="#1649">1649</a> * @throws IOException if an I/O (transport) error occurs

1659

<a name="1650" href="#1650">1650</a> * @throws HttpException if a protocol exception occurs.

1660

<a name="1651" href="#1651">1651</a> * @throws HttpRecoverableException if a recoverable transport error occurs.

1661

<a name="1652" href="#1652">1652</a> * Usually this kind of exceptions can be recovered from by

1662

<a name="1653" href="#1653">1653</a> * retrying the HTTP method

1663

<a name="1654" href="#1654">1654</a> *

1664

<a name="1655" href="#1655">1655</a> * @see #writeRequestHeaders

1665

<a name="1656" href="#1656">1656</a> */

1666

<a name="1657" href="#1657">1657</a> protected void addRequestHeaders(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)

1667

<a name="1658" href="#1658">1658</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {

1668

<a name="1659" href="#1659">1659</a> LOG.trace("enter HttpMethodBase.addRequestHeaders(HttpState, "

1669

<a name="1660" href="#1660">1660</a> + "HttpConnection)");

1670

1671

<a name="1662" href="#1662">1662</a> addUserAgentRequestHeader(state, conn);

1672

<a name="1663" href="#1663">1663</a> addHostRequestHeader(state, conn);

1673

<a name="1664" href="#1664">1664</a> addCookieRequestHeader(state, conn);

1674

<a name="1665" href="#1665">1665</a> addAuthorizationRequestHeader(state, conn);

1675

<a name="1666" href="#1666">1666</a> addProxyAuthorizationRequestHeader(state, conn);

1676

<a name="1667" href="#1667">1667</a> addProxyConnectionHeader(state, conn);

1677

<a name="1668" href="#1668">1668</a> addContentLengthRequestHeader(state, conn);

1678

<a name="1669" href="#1669">1669</a> }

1679

1680

<a name="1671" href="#1671">1671</a> /***

1681

<a name="1672" href="#1672">1672</a> * Generates default <tt>User-Agent</tt> request header, as long as no

1682

<a name="1673" href="#1673">1673</a> * <tt>User-Agent</tt> request header already exists.

1683

<a name="1674" href="#1674">1674</a> *

1684

<a name="1675" href="#1675">1675</a> * @param state the {@link HttpState state} information associated with this method

1685

<a name="1676" href="#1676">1676</a> * @param conn the {@link HttpConnection connection} used to execute

1686

<a name="1677" href="#1677">1677</a> * this HTTP method

1687

<a name="1678" href="#1678">1678</a> *

1688

<a name="1679" href="#1679">1679</a> * @throws IOException if an I/O (transport) error occurs

1689

<a name="1680" href="#1680">1680</a> * @throws HttpException if a protocol exception occurs.

1690

<a name="1681" href="#1681">1681</a> * @throws HttpRecoverableException if a recoverable transport error occurs.

1691

<a name="1682" href="#1682">1682</a> * Usually this kind of exceptions can be recovered from by

1692

<a name="1683" href="#1683">1683</a> * retrying the HTTP method

1693

<a name="1684" href="#1684">1684</a> */

1694

<a name="1685" href="#1685">1685</a> protected void addUserAgentRequestHeader(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state,

1695

<a name="1686" href="#1686">1686</a> <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)

1696

<a name="1687" href="#1687">1687</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {

1697

<a name="1688" href="#1688">1688</a> LOG.trace("enter HttpMethodBase.addUserAgentRequestHeaders(HttpState, "

1698

<a name="1689" href="#1689">1689</a> + "HttpConnection)");

1699

1700

<a name="1691" href="#1691">1691</a> if (getRequestHeader("user-agent") == null) {

1701

<a name="1692" href="#1692">1692</a> setRequestHeader(HttpMethodBase.USER_AGENT);

1702

<a name="1693" href="#1693">1693</a> }

1703

<a name="1694" href="#1694">1694</a> }

1704

1705

<a name="1696" href="#1696">1696</a> /***

1706

<a name="1697" href="#1697">1697</a> * Throws an {@link IllegalStateException} if the HTTP method has been already

1707

<a name="1698" href="#1698">1698</a> * {@link #execute executed}, but not {@link #recycle recycled}.

1708

<a name="1699" href="#1699">1699</a> *

1709

<a name="1700" href="#1700">1700</a> * @throws IllegalStateException if the method has been used and not

1710

<a name="1701" href="#1701">1701</a> * recycled

1711

<a name="1702" href="#1702">1702</a> */

1712

<a name="1703" href="#1703">1703</a> protected void checkNotUsed() throws IllegalStateException {

1713

<a name="1704" href="#1704">1704</a> if (used) {

1714

<a name="1705" href="#1705">1705</a> throw new IllegalStateException("Already used.");

1715

<a name="1706" href="#1706">1706</a> }

1716

<a name="1707" href="#1707">1707</a> }

1717

1718

<a name="1709" href="#1709">1709</a> /***

1719

<a name="1710" href="#1710">1710</a> * Throws an {@link IllegalStateException} if the HTTP method has not been

1720

<a name="1711" href="#1711">1711</a> * {@link #execute executed} since last {@link #recycle recycle}.

1721

<a name="1712" href="#1712">1712</a> *

1722

<a name="1713" href="#1713">1713</a> *

1723

<a name="1714" href="#1714">1714</a> * @throws IllegalStateException if not used

1724

<a name="1715" href="#1715">1715</a> */

1725

<a name="1716" href="#1716">1716</a> protected void checkUsed() throws IllegalStateException {

1726

<a name="1717" href="#1717">1717</a> if (!used) {

1727

<a name="1718" href="#1718">1718</a> throw new IllegalStateException("Not Used.");

1728

<a name="1719" href="#1719">1719</a> }

1729

<a name="1720" href="#1720">1720</a> }

1730

1731

<a name="1722" href="#1722">1722</a> // ------------------------------------------------- Static Utility Methods

1732

1733

<a name="1724" href="#1724">1724</a> /***

1734

<a name="1725" href="#1725">1725</a> * Generates HTTP request line according to the specified attributes.

1735

<a name="1726" href="#1726">1726</a> *

1736

<a name="1727" href="#1727">1727</a> * @param connection the {@link HttpConnection connection} used to execute

1737

<a name="1728" href="#1728">1728</a> * this HTTP method

1738

<a name="1729" href="#1729">1729</a> * @param name the method name generate a request for

1739

<a name="1730" href="#1730">1730</a> * @param requestPath the path string for the request

1740

<a name="1731" href="#1731">1731</a> * @param query the query string for the request

1741

<a name="1732" href="#1732">1732</a> * @param version the protocol version to use (e.g. HTTP/1.0)

1742

<a name="1733" href="#1733">1733</a> *

1743

<a name="1734" href="#1734">1734</a> * @return HTTP request line

1744

<a name="1735" href="#1735">1735</a> */

1745

<a name="1736" href="#1736">1736</a> protected static String generateRequestLine(<a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> connection,

1746

<a name="1737" href="#1737">1737</a> String name, String requestPath, String query, String version) {

1747

<a name="1738" href="#1738">1738</a> LOG.trace("enter HttpMethodBase.generateRequestLine(HttpConnection, "

1748

<a name="1739" href="#1739">1739</a> + "String, String, String, String)");

1749

1750

<a name="1741" href="#1741">1741</a> StringBuffer buf = new StringBuffer();

1751

<a name="1742" href="#1742">1742</a> // Append method name

1752

<a name="1743" href="#1743">1743</a> buf.append(name);

1753

<a name="1744" href="#1744">1744</a> buf.append(" ");

1754

<a name="1745" href="#1745">1745</a> // Absolute or relative URL?

1755

<a name="1746" href="#1746">1746</a> if (!connection.isTransparent()) {

1756

<a name="1747" href="#1747">1747</a> <a href="../../../../org/apache/commons/httpclient/protocol/Protocol.html">Protocol</a> protocol = connection.getProtocol();

1757

<a name="1748" href="#1748">1748</a> buf.append(protocol.getScheme().toLowerCase());

1758

<a name="1749" href="#1749">1749</a> buf.append("://");

1759

<a name="1750" href="#1750">1750</a> buf.append(connection.getHost());

1760

<a name="1751" href="#1751">1751</a> if ((connection.getPort() != -1)

1761

<a name="1752" href="#1752">1752</a> && (connection.getPort() != protocol.getDefaultPort())

1762

<a name="1753" href="#1753">1753</a> ) {

1763

<a name="1754" href="#1754">1754</a> buf.append(":");

1764

<a name="1755" href="#1755">1755</a> buf.append(connection.getPort());

1765

<a name="1756" href="#1756">1756</a> }

1766

<a name="1757" href="#1757">1757</a> }

1767

<a name="1758" href="#1758">1758</a> // Append path, if any

1768

<a name="1759" href="#1759">1759</a> if (requestPath == null) {

1769

<a name="1760" href="#1760">1760</a> buf.append("/");

1770

<a name="1761" href="#1761">1761</a> } else {

1771

<a name="1762" href="#1762">1762</a> if (!connection.isTransparent() && !requestPath.startsWith("/")) {

1772

<a name="1763" href="#1763">1763</a> buf.append("/");

1773

<a name="1764" href="#1764">1764</a> }

1774

<a name="1765" href="#1765">1765</a> buf.append(requestPath);

1775

<a name="1766" href="#1766">1766</a> }

1776

<a name="1767" href="#1767">1767</a> // Append query, if any

1777

<a name="1768" href="#1768">1768</a> if (query != null) {

1778

<a name="1769" href="#1769">1769</a> if (query.indexOf("?") != 0) {

1779

<a name="1770" href="#1770">1770</a> buf.append("?");

1780

<a name="1771" href="#1771">1771</a> }

1781

<a name="1772" href="#1772">1772</a> buf.append(query);

1782

<a name="1773" href="#1773">1773</a> }

1783

<a name="1774" href="#1774">1774</a> // Append protocol

1784

<a name="1775" href="#1775">1775</a> buf.append(" ");

1785

<a name="1776" href="#1776">1776</a> buf.append(version);

1786

<a name="1777" href="#1777">1777</a> buf.append("\r\n");

1787

1788

<a name="1779" href="#1779">1779</a> return buf.toString();

1789

<a name="1780" href="#1780">1780</a> }

1790

1791

<a name="1782" href="#1782">1782</a> /***

1792

<a name="1783" href="#1783">1783</a> * This method is invoked immediately after

1793

<a name="1784" href="#1784">1784</a> * {@link #readResponseBody(HttpState,HttpConnection)} and can be overridden by

1794

<a name="1785" href="#1785">1785</a> * sub-classes in order to provide custom body processing.

1795

<a name="1786" href="#1786">1786</a> *

1796

<a name="1787" href="#1787">1787</a> *

1797

<a name="1788" href="#1788">1788</a> * This implementation does nothing.

1798

<a name="1789" href="#1789">1789</a> *

1799

<a name="1790" href="#1790">1790</a> *

1800

<a name="1791" href="#1791">1791</a> * @param state the {@link HttpState state} information associated with this method

1801

<a name="1792" href="#1792">1792</a> * @param conn the {@link HttpConnection connection} used to execute

1802

<a name="1793" href="#1793">1793</a> * this HTTP method

1803

<a name="1794" href="#1794">1794</a> *

1804

<a name="1795" href="#1795">1795</a> * @see #readResponse

1805

<a name="1796" href="#1796">1796</a> * @see #readResponseBody

1806

<a name="1797" href="#1797">1797</a> */

1807

<a name="1798" href="#1798">1798</a> protected void processResponseBody(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn) {

1808

<a name="1799" href="#1799">1799</a> }

1809

1810

<a name="1801" href="#1801">1801</a> /***

1811

<a name="1802" href="#1802">1802</a> * This method is invoked immediately after

1812

<a name="1803" href="#1803">1803</a> * {@link #readResponseHeaders(HttpState,HttpConnection)} and can be overridden by

1813

<a name="1804" href="#1804">1804</a> * sub-classes in order to provide custom response headers processing.

1814

1815

<a name="1806" href="#1806">1806</a> *

1816

<a name="1807" href="#1807">1807</a> * This implementation will handle the <tt>Set-Cookie</tt> and

1817

<a name="1808" href="#1808">1808</a> * <tt>Set-Cookie2</tt> headers, if any, adding the relevant cookies to

1818

<a name="1809" href="#1809">1809</a> * the given {@link HttpState}.

1819

<a name="1810" href="#1810">1810</a> *

1820

<a name="1811" href="#1811">1811</a> *

1821

<a name="1812" href="#1812">1812</a> * @param state the {@link HttpState state} information associated with this method

1822

<a name="1813" href="#1813">1813</a> * @param conn the {@link HttpConnection connection} used to execute

1823

<a name="1814" href="#1814">1814</a> * this HTTP method

1824

<a name="1815" href="#1815">1815</a> *

1825

<a name="1816" href="#1816">1816</a> * @see #readResponse

1826

<a name="1817" href="#1817">1817</a> * @see #readResponseHeaders

1827

<a name="1818" href="#1818">1818</a> */

1828

<a name="1819" href="#1819">1819</a> protected void processResponseHeaders(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state,

1829

<a name="1820" href="#1820">1820</a> <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn) {

1830

<a name="1821" href="#1821">1821</a> LOG.trace("enter HttpMethodBase.processResponseHeaders(HttpState, "

1831

<a name="1822" href="#1822">1822</a> + "HttpConnection)");

1832

1833

<a name="1824" href="#1824">1824</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] headers = getResponseHeaderGroup().getHeaders("set-cookie2");

1834

<a name="1825" href="#1825">1825</a> //Only process old style set-cookie headers if new style headres

1835

<a name="1826" href="#1826">1826</a> //are not present

1836

<a name="1827" href="#1827">1827</a> if (headers.length == 0) {

1837

<a name="1828" href="#1828">1828</a> headers = getResponseHeaderGroup().getHeaders("set-cookie");

1838

<a name="1829" href="#1829">1829</a> }

1839

1840

<a name="1831" href="#1831">1831</a> <a href="../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</a> parser = CookiePolicy.getSpecByPolicy(state.getCookiePolicy());

1841

<a name="1832" href="#1832">1832</a> for (int i = 0; i < headers.length; i++) {

1842

<a name="1833" href="#1833">1833</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> header = headers[i];

1843

<a name="1834" href="#1834">1834</a> <a href="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a>[] cookies = null;

1844

<a name="1835" href="#1835">1835</a> try {

1845

<a name="1836" href="#1836">1836</a> cookies = parser.parse(

1846

<a name="1837" href="#1837">1837</a> conn.getHost(),

1847

<a name="1838" href="#1838">1838</a> conn.getPort(),

1848

<a name="1839" href="#1839">1839</a> getPath(),

1849

<a name="1840" href="#1840">1840</a> conn.isSecure(),

1850

<a name="1841" href="#1841">1841</a> header);

1851

<a name="1842" href="#1842">1842</a> } catch (MalformedCookieException e) {

1852

<a name="1843" href="#1843">1843</a> if (LOG.isWarnEnabled()) {

1853

<a name="1844" href="#1844">1844</a> LOG.warn("Invalid cookie header: \""

1854

<a name="1845" href="#1845">1845</a> + header.getValue()

1855

<a name="1846" href="#1846">1846</a> + "\". " + e.getMessage());

1856

<a name="1847" href="#1847">1847</a> }

1857

<a name="1848" href="#1848">1848</a> }

1858

<a name="1849" href="#1849">1849</a> if (cookies != null) {

1859

<a name="1850" href="#1850">1850</a> for (int j = 0; j < cookies.length; j++) {

1860

<a name="1851" href="#1851">1851</a> <a href="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a> cookie = cookies[j];

1861

<a name="1852" href="#1852">1852</a> try {

1862

<a name="1853" href="#1853">1853</a> parser.validate(

1863

<a name="1854" href="#1854">1854</a> conn.getHost(),

1864

<a name="1855" href="#1855">1855</a> conn.getPort(),

1865

<a name="1856" href="#1856">1856</a> getPath(),

1866

<a name="1857" href="#1857">1857</a> conn.isSecure(),

1867

<a name="1858" href="#1858">1858</a> cookie);

1868

<a name="1859" href="#1859">1859</a> state.addCookie(cookie);

1869

<a name="1860" href="#1860">1860</a> if (LOG.isDebugEnabled()) {

1870

<a name="1861" href="#1861">1861</a> LOG.debug("Cookie accepted: \""

1871

<a name="1862" href="#1862">1862</a> + parser.formatCookie(cookie) + "\"");

1872

<a name="1863" href="#1863">1863</a> }

1873

<a name="1864" href="#1864">1864</a> } catch (MalformedCookieException e) {

1874

<a name="1865" href="#1865">1865</a> if (LOG.isWarnEnabled()) {

1875

<a name="1866" href="#1866">1866</a> LOG.warn("Cookie rejected: \"" + parser.formatCookie(cookie)

1876

<a name="1867" href="#1867">1867</a> + "\". " + e.getMessage());

1877

<a name="1868" href="#1868">1868</a> }

1878

<a name="1869" href="#1869">1869</a> }

1879

<a name="1870" href="#1870">1870</a> }

1880

<a name="1871" href="#1871">1871</a> }

1881

<a name="1872" href="#1872">1872</a> }

1882

<a name="1873" href="#1873">1873</a> }

1883

1884

<a name="1875" href="#1875">1875</a> /***

1885

<a name="1876" href="#1876">1876</a> * This method is invoked immediately after

1886

<a name="1877" href="#1877">1877</a> * {@link #readStatusLine(HttpState,HttpConnection)} and can be overridden by

1887

<a name="1878" href="#1878">1878</a> * sub-classes in order to provide custom response status line processing.

1888

<a name="1879" href="#1879">1879</a> *

1889

<a name="1880" href="#1880">1880</a> * @param state the {@link HttpState state} information associated with this method

1890

<a name="1881" href="#1881">1881</a> * @param conn the {@link HttpConnection connection} used to execute

1891

<a name="1882" href="#1882">1882</a> * this HTTP method

1892

<a name="1883" href="#1883">1883</a> *

1893

<a name="1884" href="#1884">1884</a> * @see #readResponse

1894

<a name="1885" href="#1885">1885</a> * @see #readStatusLine

1895

<a name="1886" href="#1886">1886</a> */

1896

<a name="1887" href="#1887">1887</a> protected void processStatusLine(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn) {

1897

<a name="1888" href="#1888">1888</a> }

1898

1899

<a name="1890" href="#1890">1890</a> /***

1900

<a name="1891" href="#1891">1891</a> * Reads the response from the given {@link HttpConnection connection}.

1901

<a name="1892" href="#1892">1892</a> *

1902

<a name="1893" href="#1893">1893</a> *

1903

<a name="1894" href="#1894">1894</a> * The response is processed as the following sequence of actions:

1904

<a name="1895" href="#1895">1895</a> *

1905

1906

1907

<a name="1898" href="#1898">1898</a> * {@link #readStatusLine(HttpState,HttpConnection)} is

1908

<a name="1899" href="#1899">1899</a> * invoked to read the request line.

1909

1910

1911

<a name="1902" href="#1902">1902</a> * {@link #processStatusLine(HttpState,HttpConnection)}

1912

<a name="1903" href="#1903">1903</a> * is invoked, allowing the method to process the status line if

1913

<a name="1904" href="#1904">1904</a> * desired.

1914

1915

1916

<a name="1907" href="#1907">1907</a> * {@link #readResponseHeaders(HttpState,HttpConnection)} is invoked to read

1917

<a name="1908" href="#1908">1908</a> * the associated headers.

1918

1919

1920

<a name="1911" href="#1911">1911</a> * {@link #processResponseHeaders(HttpState,HttpConnection)} is invoked, allowing

1921

<a name="1912" href="#1912">1912</a> * the method to process the headers if desired.

1922

1923

1924

<a name="1915" href="#1915">1915</a> * {@link #readResponseBody(HttpState,HttpConnection)} is

1925

<a name="1916" href="#1916">1916</a> * invoked to read the associated body (if any).

1926

1927

1928

<a name="1919" href="#1919">1919</a> * {@link #processResponseBody(HttpState,HttpConnection)} is invoked, allowing the

1929

<a name="1920" href="#1920">1920</a> * method to process the response body if desired.

1930

1931

1932

<a name="1923" href="#1923">1923</a> *

1933

<a name="1924" href="#1924">1924</a> * Subclasses may want to override one or more of the above methods to to

1934

<a name="1925" href="#1925">1925</a> * customize the processing. (Or they may choose to override this method

1935

<a name="1926" href="#1926">1926</a> * if dramatically different processing is required.)

1936

<a name="1927" href="#1927">1927</a> *

1937

<a name="1928" href="#1928">1928</a> *

1938

<a name="1929" href="#1929">1929</a> * @param state the {@link HttpState state} information associated with this method

1939

<a name="1930" href="#1930">1930</a> * @param conn the {@link HttpConnection connection} used to execute

1940

<a name="1931" href="#1931">1931</a> * this HTTP method

1941

<a name="1932" href="#1932">1932</a> *

1942

<a name="1933" href="#1933">1933</a> * @throws HttpException if a protocol exception occurs.

1943

<a name="1934" href="#1934">1934</a> * @throws HttpRecoverableException if a recoverable transport error occurs.

1944

<a name="1935" href="#1935">1935</a> * Usually this kind of exceptions can be recovered from by

1945

<a name="1936" href="#1936">1936</a> * retrying the HTTP method

1946

<a name="1937" href="#1937">1937</a> */

1947

<a name="1938" href="#1938">1938</a> protected void readResponse(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)

1948

<a name="1939" href="#1939">1939</a> throws <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {

1949

<a name="1940" href="#1940">1940</a> LOG.trace(

1950

<a name="1941" href="#1941">1941</a> "enter HttpMethodBase.readResponse(HttpState, HttpConnection)");

1951

<a name="1942" href="#1942">1942</a> try {

1952

<a name="1943" href="#1943">1943</a> // Status line & line may have already been received

1953

<a name="1944" href="#1944">1944</a> // if 'expect - continue' handshake has been used

1954

<a name="1945" href="#1945">1945</a> while (this.statusLine == null) {

1955

<a name="1946" href="#1946">1946</a> readStatusLine(state, conn);

1956

<a name="1947" href="#1947">1947</a> processStatusLine(state, conn);

1957

<a name="1948" href="#1948">1948</a> readResponseHeaders(state, conn);

1958

<a name="1949" href="#1949">1949</a> processResponseHeaders(state, conn);

1959

1960

<a name="1951" href="#1951">1951</a> int status = this.statusLine.getStatusCode();

1961

<a name="1952" href="#1952">1952</a> if ((status >= 100) && (status < 200)) {

1962

<a name="1953" href="#1953">1953</a> if (LOG.isInfoEnabled()) {

1963

<a name="1954" href="#1954">1954</a> LOG.info("Discarding unexpected response: " + this.statusLine.toString());

1964

<a name="1955" href="#1955">1955</a> }

1965

<a name="1956" href="#1956">1956</a> this.statusLine = null;

1966

<a name="1957" href="#1957">1957</a> }

1967

<a name="1958" href="#1958">1958</a> }

1968

<a name="1959" href="#1959">1959</a> readResponseBody(state, conn);

1969

<a name="1960" href="#1960">1960</a> processResponseBody(state, conn);

1970

<a name="1961" href="#1961">1961</a> } catch (IOException e) {

1971

<a name="1962" href="#1962">1962</a> throw new <a href="../../../../org/apache/commons/httpclient/HttpRecoverableException.html">HttpRecoverableException</a>(e.toString());

1972

<a name="1963" href="#1963">1963</a> }

1973

<a name="1964" href="#1964">1964</a> }

1974

1975

<a name="1966" href="#1966">1966</a> /***

1976

<a name="1967" href="#1967">1967</a> * Read the response body from the given {@link HttpConnection}.

1977

<a name="1968" href="#1968">1968</a> *

1978

<a name="1969" href="#1969">1969</a> *

1979

<a name="1970" href="#1970">1970</a> * The current implementation wraps the socket level stream with

1980

<a name="1971" href="#1971">1971</a> * an appropriate stream for the type of response (chunked, content-length,

1981

<a name="1972" href="#1972">1972</a> * or auto-close). If there is no response body, the connection associated

1982

<a name="1973" href="#1973">1973</a> * with the request will be returned to the connection manager.

1983

<a name="1974" href="#1974">1974</a> *

1984

<a name="1975" href="#1975">1975</a> *

1985

<a name="1976" href="#1976">1976</a> *

1986

<a name="1977" href="#1977">1977</a> * Subclasses may want to override this method to to customize the

1987

<a name="1978" href="#1978">1978</a> * processing.

1988

<a name="1979" href="#1979">1979</a> *

1989

<a name="1980" href="#1980">1980</a> *

1990

<a name="1981" href="#1981">1981</a> * @param state the {@link HttpState state} information associated with this method

1991

<a name="1982" href="#1982">1982</a> * @param conn the {@link HttpConnection connection} used to execute

1992

<a name="1983" href="#1983">1983</a> * this HTTP method

1993

<a name="1984" href="#1984">1984</a> *

1994

<a name="1985" href="#1985">1985</a> * @throws IOException if an I/O (transport) error occurs

1995

<a name="1986" href="#1986">1986</a> * @throws HttpException if a protocol exception occurs.

1996

<a name="1987" href="#1987">1987</a> * @throws HttpRecoverableException if a recoverable transport error occurs.

1997

<a name="1988" href="#1988">1988</a> * Usually this kind of exceptions can be recovered from by

1998

<a name="1989" href="#1989">1989</a> * retrying the HTTP method

1999

<a name="1990" href="#1990">1990</a> *

2000

<a name="1991" href="#1991">1991</a> * @see #readResponse

2001

<a name="1992" href="#1992">1992</a> * @see #processResponseBody

2002

<a name="1993" href="#1993">1993</a> */

2003

<a name="1994" href="#1994">1994</a> protected void readResponseBody(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)

2004

<a name="1995" href="#1995">1995</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {

2005

<a name="1996" href="#1996">1996</a> LOG.trace(

2006

<a name="1997" href="#1997">1997</a> "enter HttpMethodBase.readResponseBody(HttpState, HttpConnection)");

2007

2008

<a name="1999" href="#1999">1999</a> // assume we are not done with the connection if we get a stream

2009

<a name="2000" href="#2000">2000</a> doneWithConnection = false;

2010

<a name="2001" href="#2001">2001</a> InputStream stream = readResponseBody(conn);

2011

<a name="2002" href="#2002">2002</a> if (stream == null) {

2012

<a name="2003" href="#2003">2003</a> // done using the connection!

2013

<a name="2004" href="#2004">2004</a> responseBodyConsumed();

2014

<a name="2005" href="#2005">2005</a> } else {

2015

<a name="2006" href="#2006">2006</a> conn.setLastResponseInputStream(stream);

2016

<a name="2007" href="#2007">2007</a> setResponseStream(stream);

2017

<a name="2008" href="#2008">2008</a> }

2018

<a name="2009" href="#2009">2009</a> }

2019

2020

<a name="2011" href="#2011">2011</a> /***

2021

<a name="2012" href="#2012">2012</a> * Returns the response body as an {@link InputStream input stream}

2022

<a name="2013" href="#2013">2013</a> * corresponding to the values of the <tt>Content-Length</tt> and

2023

<a name="2014" href="#2014">2014</a> * <tt>Transfer-Encoding</tt> headers. If no response body is available

2024

<a name="2015" href="#2015">2015</a> * returns <tt>null</tt>.

2025

<a name="2016" href="#2016">2016</a> *

2026

<a name="2017" href="#2017">2017</a> *

2027

<a name="2018" href="#2018">2018</a> * @see #readResponse

2028

<a name="2019" href="#2019">2019</a> * @see #processResponseBody

2029

<a name="2020" href="#2020">2020</a> *

2030

<a name="2021" href="#2021">2021</a> * @param conn the {@link HttpConnection connection} used to execute

2031

<a name="2022" href="#2022">2022</a> * this HTTP method

2032

<a name="2023" href="#2023">2023</a> *

2033

<a name="2024" href="#2024">2024</a> * @throws IOException if an I/O (transport) error occurs

2034

<a name="2025" href="#2025">2025</a> * @throws HttpException if a protocol exception occurs.

2035

<a name="2026" href="#2026">2026</a> * @throws HttpRecoverableException if a recoverable transport error occurs.

2036

<a name="2027" href="#2027">2027</a> * Usually this kind of exceptions can be recovered from by

2037

<a name="2028" href="#2028">2028</a> * retrying the HTTP method

2038

<a name="2029" href="#2029">2029</a> */

2039

<a name="2030" href="#2030">2030</a> private InputStream readResponseBody(<a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)

2040

<a name="2031" href="#2031">2031</a> throws IOException {

2041

2042

<a name="2033" href="#2033">2033</a> LOG.trace("enter HttpMethodBase.readResponseBody(HttpConnection)");

2043

2044

<a name="2035" href="#2035">2035</a> responseBody = null;

2045

<a name="2036" href="#2036">2036</a> InputStream is = conn.getResponseInputStream();

2046

<a name="2037" href="#2037">2037</a> if (Wire.CONTENT_WIRE.enabled()) {

2047

<a name="2038" href="#2038">2038</a> is = new <a href="../../../../org/apache/commons/httpclient/WireLogInputStream.html">WireLogInputStream</a>(is, Wire.CONTENT_WIRE);

2048

<a name="2039" href="#2039">2039</a> }

2049

<a name="2040" href="#2040">2040</a> InputStream result = null;

2050

<a name="2041" href="#2041">2041</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> transferEncodingHeader = responseHeaders.getFirstHeader("Transfer-Encoding");

2051

<a name="2042" href="#2042">2042</a> // We use Transfer-Encoding if present and ignore Content-Length.

2052

<a name="2043" href="#2043">2043</a> // RFC2616, 4.4 item number 3

2053

<a name="2044" href="#2044">2044</a> if (transferEncodingHeader != null) {

2054

2055

<a name="2046" href="#2046">2046</a> String transferEncoding = transferEncodingHeader.getValue();

2056

<a name="2047" href="#2047">2047</a> if (!"chunked".equalsIgnoreCase(transferEncoding)

2057

<a name="2048" href="#2048">2048</a> && !"identity".equalsIgnoreCase(transferEncoding)) {

2058

<a name="2049" href="#2049">2049</a> if (LOG.isWarnEnabled()) {

2059

<a name="2050" href="#2050">2050</a> LOG.warn("Unsupported transfer encoding: " + transferEncoding);

2060

<a name="2051" href="#2051">2051</a> }

2061

<a name="2052" href="#2052">2052</a> }

2062

<a name="2053" href="#2053">2053</a> <a href="../../../../org/apache/commons/httpclient/HeaderElement.html">HeaderElement</a>[] encodings = transferEncodingHeader.getValues();

2063

<a name="2054" href="#2054">2054</a> // The chunck encoding must be the last one applied

2064

<a name="2055" href="#2055">2055</a> // RFC2616, 14.41

2065

<a name="2056" href="#2056">2056</a> int len = encodings.length;

2066

<a name="2057" href="#2057">2057</a> if ((len > 0) && ("chunked".equalsIgnoreCase(encodings[len - 1].getName()))) {

2067

<a name="2058" href="#2058">2058</a> // if response body is empty

2068

<a name="2059" href="#2059">2059</a> if (conn.isResponseAvailable(conn.getSoTimeout())) {

2069

<a name="2060" href="#2060">2060</a> result = new ChunkedInputStream(is, this);

2070

<a name="2061" href="#2061">2061</a> } else {

2071

<a name="2062" href="#2062">2062</a> if (isStrictMode()) {

2072

<a name="2063" href="#2063">2063</a> throw new <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a>("Chunk-encoded body declared but not sent");

2073

<a name="2064" href="#2064">2064</a> } else {

2074

<a name="2065" href="#2065">2065</a> LOG.warn("Chunk-encoded body missing");

2075

<a name="2066" href="#2066">2066</a> }

2076

<a name="2067" href="#2067">2067</a> }

2077

<a name="2068" href="#2068">2068</a> } else {

2078

<a name="2069" href="#2069">2069</a> LOG.info("Response content is not chunk-encoded");

2079

<a name="2070" href="#2070">2070</a> // The connection must be terminated by closing

2080

<a name="2071" href="#2071">2071</a> // the socket as per RFC 2616, 3.6

2081

<a name="2072" href="#2072">2072</a> setConnectionCloseForced(true);

2082

<a name="2073" href="#2073">2073</a> result = is;

2083

<a name="2074" href="#2074">2074</a> }

2084

<a name="2075" href="#2075">2075</a> } else {

2085

<a name="2076" href="#2076">2076</a> int expectedLength = getResponseContentLength();

2086

<a name="2077" href="#2077">2077</a> if (expectedLength == -1) {

2087

<a name="2078" href="#2078">2078</a> if (canResponseHaveBody(statusLine.getStatusCode())) {

2088

<a name="2079" href="#2079">2079</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> connectionHeader = responseHeaders.getFirstHeader("Connection");

2089

<a name="2080" href="#2080">2080</a> String connectionDirective = null;

2090

<a name="2081" href="#2081">2081</a> if (connectionHeader != null) {

2091

<a name="2082" href="#2082">2082</a> connectionDirective = connectionHeader.getValue();

2092

<a name="2083" href="#2083">2083</a> }

2093

<a name="2084" href="#2084">2084</a> if (isHttp11() && !"close".equalsIgnoreCase(connectionDirective)) {

2094

<a name="2085" href="#2085">2085</a> LOG.info("Response content length is not known");

2095

<a name="2086" href="#2086">2086</a> setConnectionCloseForced(true);

2096

<a name="2087" href="#2087">2087</a> }

2097

<a name="2088" href="#2088">2088</a> result = is;

2098

<a name="2089" href="#2089">2089</a> }

2099

<a name="2090" href="#2090">2090</a> } else {

2100

<a name="2091" href="#2091">2091</a> result = new <a href="../../../../org/apache/commons/httpclient/ContentLengthInputStream.html">ContentLengthInputStream</a>(is, expectedLength);

2101

<a name="2092" href="#2092">2092</a> }

2102

<a name="2093" href="#2093">2093</a> }

2103

<a name="2094" href="#2094">2094</a> // if there is a result - ALWAYS wrap it in an observer which will

2104

<a name="2095" href="#2095">2095</a> // close the underlying stream as soon as it is consumed, and notify

2105

<a name="2096" href="#2096">2096</a> // the watcher that the stream has been consumed.

2106

<a name="2097" href="#2097">2097</a> if (result != null) {

2107

2108

<a name="2099" href="#2099">2099</a> result = new AutoCloseInputStream(

2109

<a name="2100" href="#2100">2100</a> result,

2110

<a name="2101" href="#2101">2101</a> new <a href="../../../../org/apache/commons/httpclient/ResponseConsumedWatcher.html">ResponseConsumedWatcher</a>() {

2111

<a name="2102" href="#2102">2102</a> public void responseConsumed() {

2112

<a name="2103" href="#2103">2103</a> responseBodyConsumed();

2113

<a name="2104" href="#2104">2104</a> }

2114

<a name="2105" href="#2105">2105</a> }

2115

<a name="2106" href="#2106">2106</a> );

2116

<a name="2107" href="#2107">2107</a> }

2117

2118

<a name="2109" href="#2109">2109</a> return result;

2119

<a name="2110" href="#2110">2110</a> }

2120

2121

<a name="2112" href="#2112">2112</a> /***

2122

<a name="2113" href="#2113">2113</a> * Reads the response headers from the given {@link HttpConnection connection}.

2123

<a name="2114" href="#2114">2114</a> *

2124

<a name="2115" href="#2115">2115</a> *

2125

<a name="2116" href="#2116">2116</a> * Subclasses may want to override this method to to customize the

2126

<a name="2117" href="#2117">2117</a> * processing.

2127

<a name="2118" href="#2118">2118</a> *

2128

<a name="2119" href="#2119">2119</a> *

2129

<a name="2120" href="#2120">2120</a> *

2130

<a name="2121" href="#2121">2121</a> * "It must be possible to combine the multiple header fields into one

2131

<a name="2122" href="#2122">2122</a> * "field-name: field-value" pair, without changing the semantics of the

2132

<a name="2123" href="#2123">2123</a> * message, by appending each subsequent field-value to the first, each

2133

<a name="2124" href="#2124">2124</a> * separated by a comma." - HTTP/1.0 (4.3)

2134

<a name="2125" href="#2125">2125</a> *

2135

<a name="2126" href="#2126">2126</a> *

2136

<a name="2127" href="#2127">2127</a> * @param state the {@link HttpState state} information associated with this method

2137

<a name="2128" href="#2128">2128</a> * @param conn the {@link HttpConnection connection} used to execute

2138

<a name="2129" href="#2129">2129</a> * this HTTP method

2139

<a name="2130" href="#2130">2130</a> *

2140

<a name="2131" href="#2131">2131</a> * @throws IOException if an I/O (transport) error occurs

2141

<a name="2132" href="#2132">2132</a> * @throws HttpException if a protocol exception occurs.

2142

<a name="2133" href="#2133">2133</a> * @throws HttpRecoverableException if a recoverable transport error occurs.

2143

<a name="2134" href="#2134">2134</a> * Usually this kind of exceptions can be recovered from by

2144

<a name="2135" href="#2135">2135</a> * retrying the HTTP method

2145

<a name="2136" href="#2136">2136</a> *

2146

<a name="2137" href="#2137">2137</a> * @see #readResponse

2147

<a name="2138" href="#2138">2138</a> * @see #processResponseHeaders

2148

<a name="2139" href="#2139">2139</a> */

2149

<a name="2140" href="#2140">2140</a> protected void readResponseHeaders(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)

2150

<a name="2141" href="#2141">2141</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {

2151

<a name="2142" href="#2142">2142</a> LOG.trace("enter HttpMethodBase.readResponseHeaders(HttpState,"

2152

<a name="2143" href="#2143">2143</a> + "HttpConnection)");

2153

2154

<a name="2145" href="#2145">2145</a> getResponseHeaderGroup().clear();

2155

<a name="2146" href="#2146">2146</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] headers = HttpParser.parseHeaders(conn.getResponseInputStream());

2156

<a name="2147" href="#2147">2147</a> if (Wire.HEADER_WIRE.enabled()) {

2157

<a name="2148" href="#2148">2148</a> for (int i = 0; i < headers.length; i++) {

2158

<a name="2149" href="#2149">2149</a> Wire.HEADER_WIRE.input(headers[i].toExternalForm());

2159

<a name="2150" href="#2150">2150</a> }

2160

<a name="2151" href="#2151">2151</a> }

2161

<a name="2152" href="#2152">2152</a> getResponseHeaderGroup().setHeaders(headers);

2162

<a name="2153" href="#2153">2153</a> }

2163

2164

<a name="2155" href="#2155">2155</a> /***

2165

<a name="2156" href="#2156">2156</a> * Read the status line from the given {@link HttpConnection}, setting my

2166

<a name="2157" href="#2157">2157</a> * {@link #getStatusCode status code} and {@link #getStatusText status

2167

<a name="2158" href="#2158">2158</a> * text}.

2168

<a name="2159" href="#2159">2159</a> *

2169

<a name="2160" href="#2160">2160</a> *

2170

<a name="2161" href="#2161">2161</a> * Subclasses may want to override this method to to customize the

2171

<a name="2162" href="#2162">2162</a> * processing.

2172

<a name="2163" href="#2163">2163</a> *

2173

<a name="2164" href="#2164">2164</a> *

2174

<a name="2165" href="#2165">2165</a> * @param state the {@link HttpState state} information associated with this method

2175

<a name="2166" href="#2166">2166</a> * @param conn the {@link HttpConnection connection} used to execute

2176

<a name="2167" href="#2167">2167</a> * this HTTP method

2177

<a name="2168" href="#2168">2168</a> *

2178

<a name="2169" href="#2169">2169</a> * @throws IOException if an I/O (transport) error occurs

2179

<a name="2170" href="#2170">2170</a> * @throws HttpException if a protocol exception occurs.

2180

<a name="2171" href="#2171">2171</a> * @throws HttpRecoverableException if a recoverable transport error occurs.

2181

<a name="2172" href="#2172">2172</a> * Usually this kind of exceptions can be recovered from by

2182

<a name="2173" href="#2173">2173</a> * retrying the HTTP method

2183

<a name="2174" href="#2174">2174</a> *

2184

<a name="2175" href="#2175">2175</a> * @see StatusLine

2185

<a name="2176" href="#2176">2176</a> */

2186

<a name="2177" href="#2177">2177</a> protected void readStatusLine(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)

2187

<a name="2178" href="#2178">2178</a> throws IOException, HttpRecoverableException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {

2188

<a name="2179" href="#2179">2179</a> LOG.trace("enter HttpMethodBase.readStatusLine(HttpState, HttpConnection)");

2189

2190

<a name="2181" href="#2181">2181</a> //read out the HTTP status string

2191

<a name="2182" href="#2182">2182</a> String s = conn.readLine();

2192

<a name="2183" href="#2183">2183</a> while ((s != null) && !StatusLine.startsWithHTTP(s)) {

2193

<a name="2184" href="#2184">2184</a> if (Wire.HEADER_WIRE.enabled()) {

2194

<a name="2185" href="#2185">2185</a> Wire.HEADER_WIRE.input(s + "\r\n");

2195

<a name="2186" href="#2186">2186</a> }

2196

<a name="2187" href="#2187">2187</a> s = conn.readLine();

2197

<a name="2188" href="#2188">2188</a> }

2198

<a name="2189" href="#2189">2189</a> if (s == null) {

2199

<a name="2190" href="#2190">2190</a> // A null statusString means the connection was lost before we got a

2200

<a name="2191" href="#2191">2191</a> // response. Try again.

2201

<a name="2192" href="#2192">2192</a> throw new <a href="../../../../org/apache/commons/httpclient/HttpRecoverableException.html">HttpRecoverableException</a>("Error in parsing the status "

2202

<a name="2193" href="#2193">2193</a> + " line from the response: unable to find line starting with"

2203

<a name="2194" href="#2194">2194</a> + " \"HTTP\"");

2204

<a name="2195" href="#2195">2195</a> }

2205

<a name="2196" href="#2196">2196</a> if (Wire.HEADER_WIRE.enabled()) {

2206

<a name="2197" href="#2197">2197</a> Wire.HEADER_WIRE.input(s + "\r\n");

2207

<a name="2198" href="#2198">2198</a> }

2208

<a name="2199" href="#2199">2199</a> //create the status line from the status string

2209

<a name="2200" href="#2200">2200</a> statusLine = new <a href="../../../../org/apache/commons/httpclient/StatusLine.html">StatusLine</a>(s);

2210

2211

<a name="2202" href="#2202">2202</a> //check for a valid HTTP-Version

2212

<a name="2203" href="#2203">2203</a> String httpVersion = statusLine.getHttpVersion();

2213

<a name="2204" href="#2204">2204</a> if (httpVersion.equals("HTTP/1.0")) {

2214

<a name="2205" href="#2205">2205</a> http11 = false;

2215

<a name="2206" href="#2206">2206</a> } else if (httpVersion.equals("HTTP/1.1")) {

2216

<a name="2207" href="#2207">2207</a> http11 = true;

2217

<a name="2208" href="#2208">2208</a> } else if (httpVersion.equals("HTTP")) {

2218

<a name="2209" href="#2209">2209</a> // some servers do not specify the version correctly, we will just assume 1.0

2219

<a name="2210" href="#2210">2210</a> http11 = false;

2220

<a name="2211" href="#2211">2211</a> } else {

2221

<a name="2212" href="#2212">2212</a> throw new <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a>("Unrecognized server protocol: '"

2222

<a name="2213" href="#2213">2213</a> + httpVersion + "'");

2223

<a name="2214" href="#2214">2214</a> }

2224

2225

<a name="2216" href="#2216">2216</a> }

2226

2227

<a name="2218" href="#2218">2218</a> // ------------------------------------------------------ Protected Methods

2228

2229

<a name="2220" href="#2220">2220</a> /***

2230

<a name="2221" href="#2221">2221</a> *

2231

<a name="2222" href="#2222">2222</a> * Sends the request via the given {@link HttpConnection connection}.

2232

<a name="2223" href="#2223">2223</a> *

2233

<a name="2224" href="#2224">2224</a> *

2234

<a name="2225" href="#2225">2225</a> *

2235

<a name="2226" href="#2226">2226</a> * The request is written as the following sequence of actions:

2236

<a name="2227" href="#2227">2227</a> *

2237

<a name="2228" href="#2228">2228</a> *

2238

2239

2240

<a name="2231" href="#2231">2231</a> * {@link #writeRequestLine(HttpState, HttpConnection)} is invoked to

2241

<a name="2232" href="#2232">2232</a> * write the request line.

2242

2243

2244

<a name="2235" href="#2235">2235</a> * {@link #writeRequestHeaders(HttpState, HttpConnection)} is invoked

2245

<a name="2236" href="#2236">2236</a> * to write the associated headers.

2246

2247

2248

<a name="2239" href="#2239">2239</a> * <tt>\r\n</tt> is sent to close the head part of the request.

2249

2250

2251

<a name="2242" href="#2242">2242</a> * {@link #writeRequestBody(HttpState, HttpConnection)} is invoked to

2252

<a name="2243" href="#2243">2243</a> * write the body part of the request.

2253

2254

2255

<a name="2246" href="#2246">2246</a> *

2256

<a name="2247" href="#2247">2247</a> *

2257

<a name="2248" href="#2248">2248</a> * Subclasses may want to override one or more of the above methods to to

2258

<a name="2249" href="#2249">2249</a> * customize the processing. (Or they may choose to override this method

2259

<a name="2250" href="#2250">2250</a> * if dramatically different processing is required.)

2260

<a name="2251" href="#2251">2251</a> *

2261

<a name="2252" href="#2252">2252</a> *

2262

<a name="2253" href="#2253">2253</a> * @param state the {@link HttpState state} information associated with this method

2263

<a name="2254" href="#2254">2254</a> * @param conn the {@link HttpConnection connection} used to execute

2264

<a name="2255" href="#2255">2255</a> * this HTTP method

2265

<a name="2256" href="#2256">2256</a> *

2266

<a name="2257" href="#2257">2257</a> * @throws IOException if an I/O (transport) error occurs

2267

<a name="2258" href="#2258">2258</a> * @throws HttpException if a protocol exception occurs.

2268

<a name="2259" href="#2259">2259</a> * @throws HttpRecoverableException if a recoverable transport error occurs.

2269

<a name="2260" href="#2260">2260</a> * Usually this kind of exceptions can be recovered from by

2270

<a name="2261" href="#2261">2261</a> * retrying the HTTP method

2271

<a name="2262" href="#2262">2262</a> */

2272

<a name="2263" href="#2263">2263</a> protected void writeRequest(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)

2273

<a name="2264" href="#2264">2264</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {

2274

<a name="2265" href="#2265">2265</a> LOG.trace(

2275

<a name="2266" href="#2266">2266</a> "enter HttpMethodBase.writeRequest(HttpState, HttpConnection)");

2276

<a name="2267" href="#2267">2267</a> writeRequestLine(state, conn);

2277

<a name="2268" href="#2268">2268</a> writeRequestHeaders(state, conn);

2278

<a name="2269" href="#2269">2269</a> conn.writeLine(); // close head

2279

<a name="2270" href="#2270">2270</a> // make sure the status line and headers have been sent

2280

<a name="2271" href="#2271">2271</a> conn.flushRequestOutputStream();

2281

<a name="2272" href="#2272">2272</a> if (Wire.HEADER_WIRE.enabled()) {

2282

<a name="2273" href="#2273">2273</a> Wire.HEADER_WIRE.output("\r\n");

2283

<a name="2274" href="#2274">2274</a> }

2284

2285

<a name="2276" href="#2276">2276</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> expectheader = getRequestHeader("Expect");

2286

<a name="2277" href="#2277">2277</a> String expectvalue = null;

2287

<a name="2278" href="#2278">2278</a> if (expectheader != null) {

2288

<a name="2279" href="#2279">2279</a> expectvalue = expectheader.getValue();

2289

<a name="2280" href="#2280">2280</a> }

2290

<a name="2281" href="#2281">2281</a> if ((expectvalue != null)

2291

<a name="2282" href="#2282">2282</a> && (expectvalue.compareToIgnoreCase("100-continue") == 0)) {

2292

<a name="2283" href="#2283">2283</a> if (this.isHttp11()) {

2293

<a name="2284" href="#2284">2284</a> int readTimeout = conn.getSoTimeout();

2294

<a name="2285" href="#2285">2285</a> try {

2295

<a name="2286" href="#2286">2286</a> conn.setSoTimeout(RESPONSE_WAIT_TIME_MS);

2296

<a name="2287" href="#2287">2287</a> readStatusLine(state, conn);

2297

<a name="2288" href="#2288">2288</a> processStatusLine(state, conn);

2298

<a name="2289" href="#2289">2289</a> readResponseHeaders(state, conn);

2299

<a name="2290" href="#2290">2290</a> processResponseHeaders(state, conn);

2300

2301

<a name="2292" href="#2292">2292</a> if (this.statusLine.getStatusCode() == HttpStatus.SC_CONTINUE) {

2302

<a name="2293" href="#2293">2293</a> // Discard status line

2303

<a name="2294" href="#2294">2294</a> this.statusLine = null;

2304

<a name="2295" href="#2295">2295</a> LOG.debug("OK to continue received");

2305

<a name="2296" href="#2296">2296</a> } else {

2306

<a name="2297" href="#2297">2297</a> return;

2307

<a name="2298" href="#2298">2298</a> }

2308

<a name="2299" href="#2299">2299</a> } catch (InterruptedIOException e) {

2309

<a name="2300" href="#2300">2300</a> // Most probably Expect header is not recongnized

2310

<a name="2301" href="#2301">2301</a> // Remove the header to signal the method

2311

<a name="2302" href="#2302">2302</a> // that it's okay to go ahead with sending data

2312

<a name="2303" href="#2303">2303</a> removeRequestHeader("Expect");

2313

<a name="2304" href="#2304">2304</a> LOG.info("100 (continue) read timeout. Resume sending the request");

2314

<a name="2305" href="#2305">2305</a> } finally {

2315

<a name="2306" href="#2306">2306</a> conn.setSoTimeout(readTimeout);

2316

<a name="2307" href="#2307">2307</a> }

2317

2318

<a name="2309" href="#2309">2309</a> } else {

2319

<a name="2310" href="#2310">2310</a> removeRequestHeader("Expect");

2320

<a name="2311" href="#2311">2311</a> LOG.info("'Expect: 100-continue' handshake is only supported by "

2321

<a name="2312" href="#2312">2312</a> + "HTTP/1.1 or higher");

2322

<a name="2313" href="#2313">2313</a> }

2323

<a name="2314" href="#2314">2314</a> }

2324

2325

<a name="2316" href="#2316">2316</a> writeRequestBody(state, conn);

2326

<a name="2317" href="#2317">2317</a> // make sure the entire request body has been sent

2327

<a name="2318" href="#2318">2318</a> conn.flushRequestOutputStream();

2328

<a name="2319" href="#2319">2319</a> }

2329

2330

<a name="2321" href="#2321">2321</a> /***

2331

<a name="2322" href="#2322">2322</a> * Writes the request body to the given {@link HttpConnection connection}.

2332

<a name="2323" href="#2323">2323</a> *

2333

<a name="2324" href="#2324">2324</a> *

2334

<a name="2325" href="#2325">2325</a> * This method should return <tt>true</tt> if the request body was actually

2335

<a name="2326" href="#2326">2326</a> * sent (or is empty), or <tt>false</tt> if it could not be sent for some

2336

<a name="2327" href="#2327">2327</a> * reason.

2337

<a name="2328" href="#2328">2328</a> *

2338

<a name="2329" href="#2329">2329</a> *

2339

<a name="2330" href="#2330">2330</a> *

2340

<a name="2331" href="#2331">2331</a> * This implementation writes nothing and returns <tt>true</tt>.

2341

<a name="2332" href="#2332">2332</a> *

2342

<a name="2333" href="#2333">2333</a> *

2343

<a name="2334" href="#2334">2334</a> * @param state the {@link HttpState state} information associated with this method

2344

<a name="2335" href="#2335">2335</a> * @param conn the {@link HttpConnection connection} used to execute

2345

<a name="2336" href="#2336">2336</a> * this HTTP method

2346

<a name="2337" href="#2337">2337</a> *

2347

<a name="2338" href="#2338">2338</a> * @return <tt>true</tt>

2348

<a name="2339" href="#2339">2339</a> *

2349

<a name="2340" href="#2340">2340</a> * @throws IOException if an I/O (transport) error occurs

2350

<a name="2341" href="#2341">2341</a> * @throws HttpException if a protocol exception occurs.

2351

<a name="2342" href="#2342">2342</a> * @throws HttpRecoverableException if a recoverable transport error occurs.

2352

<a name="2343" href="#2343">2343</a> * Usually this kind of exceptions can be recovered from by

2353

<a name="2344" href="#2344">2344</a> * retrying the HTTP method

2354

<a name="2345" href="#2345">2345</a> */

2355

<a name="2346" href="#2346">2346</a> protected boolean writeRequestBody(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)

2356

<a name="2347" href="#2347">2347</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {

2357

<a name="2348" href="#2348">2348</a> return true;

2358

<a name="2349" href="#2349">2349</a> }

2359

2360

<a name="2351" href="#2351">2351</a> /***

2361

<a name="2352" href="#2352">2352</a> * Writes the request headers to the given {@link HttpConnection connection}.

2362

<a name="2353" href="#2353">2353</a> *

2363

<a name="2354" href="#2354">2354</a> *

2364

<a name="2355" href="#2355">2355</a> * This implementation invokes {@link #addRequestHeaders(HttpState,HttpConnection)},

2365

<a name="2356" href="#2356">2356</a> * and then writes each header to the request stream.

2366

<a name="2357" href="#2357">2357</a> *

2367

<a name="2358" href="#2358">2358</a> *

2368

<a name="2359" href="#2359">2359</a> *

2369

<a name="2360" href="#2360">2360</a> * Subclasses may want to override this method to to customize the

2370

<a name="2361" href="#2361">2361</a> * processing.

2371

<a name="2362" href="#2362">2362</a> *

2372

<a name="2363" href="#2363">2363</a> *

2373

<a name="2364" href="#2364">2364</a> * @param state the {@link HttpState state} information associated with this method

2374

<a name="2365" href="#2365">2365</a> * @param conn the {@link HttpConnection connection} used to execute

2375

<a name="2366" href="#2366">2366</a> * this HTTP method

2376

<a name="2367" href="#2367">2367</a> *

2377

<a name="2368" href="#2368">2368</a> * @throws IOException if an I/O (transport) error occurs

2378

<a name="2369" href="#2369">2369</a> * @throws HttpException if a protocol exception occurs.

2379

<a name="2370" href="#2370">2370</a> * @throws HttpRecoverableException if a recoverable transport error occurs.

2380

<a name="2371" href="#2371">2371</a> * Usually this kind of exceptions can be recovered from by

2381

<a name="2372" href="#2372">2372</a> * retrying the HTTP method

2382

<a name="2373" href="#2373">2373</a> *

2383

<a name="2374" href="#2374">2374</a> * @see #addRequestHeaders

2384

<a name="2375" href="#2375">2375</a> * @see #getRequestHeaders

2385

<a name="2376" href="#2376">2376</a> */

2386

<a name="2377" href="#2377">2377</a> protected void writeRequestHeaders(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)

2387

<a name="2378" href="#2378">2378</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {

2388

<a name="2379" href="#2379">2379</a> LOG.trace("enter HttpMethodBase.writeRequestHeaders(HttpState,"

2389

<a name="2380" href="#2380">2380</a> + "HttpConnection)");

2390

<a name="2381" href="#2381">2381</a> addRequestHeaders(state, conn);

2391

2392

<a name="2383" href="#2383">2383</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] headers = getRequestHeaders();

2393

<a name="2384" href="#2384">2384</a> for (int i = 0; i < headers.length; i++) {

2394

<a name="2385" href="#2385">2385</a> String s = headers[i].toExternalForm();

2395

<a name="2386" href="#2386">2386</a> if (Wire.HEADER_WIRE.enabled()) {

2396

<a name="2387" href="#2387">2387</a> Wire.HEADER_WIRE.output(s);

2397

<a name="2388" href="#2388">2388</a> }

2398

<a name="2389" href="#2389">2389</a> conn.print(s);

2399

<a name="2390" href="#2390">2390</a> }

2400

<a name="2391" href="#2391">2391</a> }

2401

2402

<a name="2393" href="#2393">2393</a> /***

2403

<a name="2394" href="#2394">2394</a> * Writes the request line to the given {@link HttpConnection connection}.

2404

<a name="2395" href="#2395">2395</a> *

2405

<a name="2396" href="#2396">2396</a> *

2406

<a name="2397" href="#2397">2397</a> * Subclasses may want to override this method to to customize the

2407

<a name="2398" href="#2398">2398</a> * processing.

2408

<a name="2399" href="#2399">2399</a> *

2409

<a name="2400" href="#2400">2400</a> *

2410

<a name="2401" href="#2401">2401</a> * @param state the {@link HttpState state} information associated with this method

2411

<a name="2402" href="#2402">2402</a> * @param conn the {@link HttpConnection connection} used to execute

2412

<a name="2403" href="#2403">2403</a> * this HTTP method

2413

<a name="2404" href="#2404">2404</a> *

2414

<a name="2405" href="#2405">2405</a> * @throws IOException if an I/O (transport) error occurs

2415

<a name="2406" href="#2406">2406</a> * @throws HttpException if a protocol exception occurs.

2416

<a name="2407" href="#2407">2407</a> * @throws HttpRecoverableException if a recoverable transport error occurs.

2417

<a name="2408" href="#2408">2408</a> * Usually this kind of exceptions can be recovered from by

2418

<a name="2409" href="#2409">2409</a> * retrying the HTTP method

2419

<a name="2410" href="#2410">2410</a> *

2420

<a name="2411" href="#2411">2411</a> * @see #generateRequestLine

2421

<a name="2412" href="#2412">2412</a> */

2422

<a name="2413" href="#2413">2413</a> protected void writeRequestLine(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)

2423

<a name="2414" href="#2414">2414</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {

2424

<a name="2415" href="#2415">2415</a> LOG.trace(

2425

<a name="2416" href="#2416">2416</a> "enter HttpMethodBase.writeRequestLine(HttpState, HttpConnection)");

2426

<a name="2417" href="#2417">2417</a> String requestLine = getRequestLine(conn);

2427

<a name="2418" href="#2418">2418</a> if (Wire.HEADER_WIRE.enabled()) {

2428

<a name="2419" href="#2419">2419</a> Wire.HEADER_WIRE.output(requestLine);

2429

<a name="2420" href="#2420">2420</a> }

2430

<a name="2421" href="#2421">2421</a> conn.print(requestLine);

2431

<a name="2422" href="#2422">2422</a> }

2432

2433

<a name="2424" href="#2424">2424</a> /***

2434

<a name="2425" href="#2425">2425</a> * Returns the request line.

2435

<a name="2426" href="#2426">2426</a> *

2436

<a name="2427" href="#2427">2427</a> * @param conn the {@link HttpConnection connection} used to execute

2437

<a name="2428" href="#2428">2428</a> * this HTTP method

2438

<a name="2429" href="#2429">2429</a> *

2439

<a name="2430" href="#2430">2430</a> * @return The request line.

2440

<a name="2431" href="#2431">2431</a> */

2441

<a name="2432" href="#2432">2432</a> private String getRequestLine(<a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn) {

2442

<a name="2433" href="#2433">2433</a> return HttpMethodBase.generateRequestLine(conn, getName(),

2443

<a name="2434" href="#2434">2434</a> getPath(), getQueryString(), getHttpVersion());

2444

<a name="2435" href="#2435">2435</a> }

2445

2446

<a name="2437" href="#2437">2437</a> /***

2447

<a name="2438" href="#2438">2438</a> * Get the HTTP version.

2448

<a name="2439" href="#2439">2439</a> *

2449

<a name="2440" href="#2440">2440</a> * @return HTTP/1.1 if version 1.1 of HTTP protocol is used, HTTP/1.0 otherwise

2450

<a name="2441" href="#2441">2441</a> *

2451

<a name="2442" href="#2442">2442</a> * @since 2.0

2452

<a name="2443" href="#2443">2443</a> */

2453

<a name="2444" href="#2444">2444</a> private String getHttpVersion() {

2454

<a name="2445" href="#2445">2445</a> return (http11 ? "HTTP/1.1" : "HTTP/1.0");

2455

<a name="2446" href="#2446">2446</a> }

2456

2457

<a name="2448" href="#2448">2448</a> /***

2458

<a name="2449" href="#2449">2449</a> * Per RFC 2616 section 4.3, some response can never contain a message

2459

<a name="2450" href="#2450">2450</a> * body.

2460

<a name="2451" href="#2451">2451</a> *

2461

<a name="2452" href="#2452">2452</a> * @param status - the HTTP status code

2462

<a name="2453" href="#2453">2453</a> *

2463

<a name="2454" href="#2454">2454</a> * @return <tt>true</tt> if the message may contain a body, <tt>false</tt> if it can not

2464

<a name="2455" href="#2455">2455</a> * contain a message body

2465

<a name="2456" href="#2456">2456</a> */

2466

<a name="2457" href="#2457">2457</a> private static boolean canResponseHaveBody(int status) {

2467

<a name="2458" href="#2458">2458</a> LOG.trace("enter HttpMethodBase.canResponseHaveBody(int)");

2468

2469

<a name="2460" href="#2460">2460</a> boolean result = true;

2470

2471

<a name="2462" href="#2462">2462</a> if ((status >= 100 && status <= 199) || (status == 204)

2472

<a name="2463" href="#2463">2463</a> || (status == 304)) { // NOT MODIFIED

2473

<a name="2464" href="#2464">2464</a> result = false;

2474

<a name="2465" href="#2465">2465</a> }

2475

2476

<a name="2467" href="#2467">2467</a> return result;

2477

<a name="2468" href="#2468">2468</a> }

2478

2479

<a name="2470" href="#2470">2470</a> /***

2480

<a name="2471" href="#2471">2471</a> * Processes a response that requires authentication

2481

<a name="2472" href="#2472">2472</a> *

2482

<a name="2473" href="#2473">2473</a> * @param state the {@link HttpState state} information associated with this method

2483

<a name="2474" href="#2474">2474</a> * @param conn the {@link HttpConnection connection} used to execute

2484

<a name="2475" href="#2475">2475</a> * this HTTP method

2485

<a name="2476" href="#2476">2476</a> *

2486

<a name="2477" href="#2477">2477</a> * @return true if the request has completed process, false if more

2487

<a name="2478" href="#2478">2478</a> * attempts are needed

2488

<a name="2479" href="#2479">2479</a> */

2489

<a name="2480" href="#2480">2480</a> private boolean processAuthenticationResponse(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn) {

2490

<a name="2481" href="#2481">2481</a> LOG.trace("enter HttpMethodBase.processAuthenticationResponse("

2491

<a name="2482" href="#2482">2482</a> + "HttpState, HttpConnection)");

2492

2493

<a name="2484" href="#2484">2484</a> if (this.proxyAuthScheme instanceof NTLMScheme) {

2494

<a name="2485" href="#2485">2485</a> removeRequestHeader(HttpAuthenticator.PROXY_AUTH_RESP);

2495

<a name="2486" href="#2486">2486</a> }

2496

<a name="2487" href="#2487">2487</a> if (this.authScheme instanceof NTLMScheme) {

2497

<a name="2488" href="#2488">2488</a> removeRequestHeader(HttpAuthenticator.WWW_AUTH_RESP);

2498

<a name="2489" href="#2489">2489</a> }

2499

<a name="2490" href="#2490">2490</a> int statusCode = statusLine.getStatusCode();

2500

<a name="2491" href="#2491">2491</a> // handle authentication required

2501

<a name="2492" href="#2492">2492</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] challenges = null;

2502

<a name="2493" href="#2493">2493</a> Set realmsUsed = null;

2503

<a name="2494" href="#2494">2494</a> String host = null;

2504

<a name="2495" href="#2495">2495</a> switch (statusCode) {

2505

<a name="2496" href="#2496">2496</a> case HttpStatus.SC_UNAUTHORIZED:

2506

<a name="2497" href="#2497">2497</a> challenges = getResponseHeaderGroup().getHeaders(HttpAuthenticator.WWW_AUTH);

2507

<a name="2498" href="#2498">2498</a> realmsUsed = realms;

2508

<a name="2499" href="#2499">2499</a> host = conn.getVirtualHost();

2509

<a name="2500" href="#2500">2500</a> if (host == null) {

2510

<a name="2501" href="#2501">2501</a> host = conn.getHost();

2511

<a name="2502" href="#2502">2502</a> }

2512

<a name="2503" href="#2503">2503</a> break;

2513

<a name="2504" href="#2504">2504</a> case HttpStatus.SC_PROXY_AUTHENTICATION_REQUIRED:

2514

<a name="2505" href="#2505">2505</a> challenges = getResponseHeaderGroup().getHeaders(HttpAuthenticator.PROXY_AUTH);

2515

<a name="2506" href="#2506">2506</a> realmsUsed = proxyRealms;

2516

<a name="2507" href="#2507">2507</a> host = conn.getProxyHost();

2517

<a name="2508" href="#2508">2508</a> break;

2518

<a name="2509" href="#2509">2509</a> }

2519

<a name="2510" href="#2510">2510</a> boolean authenticated = false;

2520

<a name="2511" href="#2511">2511</a> // if there was a header requesting authentication

2521

<a name="2512" href="#2512">2512</a> if (challenges.length > 0) {

2522

<a name="2513" href="#2513">2513</a> <a href="../../../../org/apache/commons/httpclient/auth/AuthScheme.html">AuthScheme</a> authscheme = null;

2523

<a name="2514" href="#2514">2514</a> try {

2524

<a name="2515" href="#2515">2515</a> authscheme = HttpAuthenticator.selectAuthScheme(challenges);

2525

<a name="2516" href="#2516">2516</a> } catch (MalformedChallengeException e) {

2526

<a name="2517" href="#2517">2517</a> if (LOG.isErrorEnabled()) {

2527

<a name="2518" href="#2518">2518</a> LOG.error(e.getMessage(), e);

2528

<a name="2519" href="#2519">2519</a> }

2529

<a name="2520" href="#2520">2520</a> return true;

2530

<a name="2521" href="#2521">2521</a> } catch (UnsupportedOperationException e) {

2531

<a name="2522" href="#2522">2522</a> if (LOG.isErrorEnabled()) {

2532

<a name="2523" href="#2523">2523</a> LOG.error(e.getMessage(), e);

2533

<a name="2524" href="#2524">2524</a> }

2534

<a name="2525" href="#2525">2525</a> return true;

2535

<a name="2526" href="#2526">2526</a> }

2536

2537

<a name="2528" href="#2528">2528</a> StringBuffer buffer = new StringBuffer();

2538

<a name="2529" href="#2529">2529</a> buffer.append(host);

2539

<a name="2530" href="#2530">2530</a> buffer.append('#');

2540

<a name="2531" href="#2531">2531</a> buffer.append(authscheme.getID());

2541

<a name="2532" href="#2532">2532</a> String realm = buffer.toString();

2542

2543

<a name="2534" href="#2534">2534</a> if (realmsUsed.contains(realm)) {

2544

<a name="2535" href="#2535">2535</a> if (LOG.isInfoEnabled()) {

2545

<a name="2536" href="#2536">2536</a> buffer = new StringBuffer();

2546

<a name="2537" href="#2537">2537</a> buffer.append("Already tried to authenticate with '");

2547

<a name="2538" href="#2538">2538</a> buffer.append(authscheme.getRealm());

2548

<a name="2539" href="#2539">2539</a> buffer.append("' authentication realm at ");

2549

<a name="2540" href="#2540">2540</a> buffer.append(host);

2550

<a name="2541" href="#2541">2541</a> buffer.append(", but still receiving: ");

2551

<a name="2542" href="#2542">2542</a> buffer.append(statusLine.toString());

2552

<a name="2543" href="#2543">2543</a> LOG.info(buffer.toString());

2553

<a name="2544" href="#2544">2544</a> }

2554

<a name="2545" href="#2545">2545</a> return true;

2555

<a name="2546" href="#2546">2546</a> } else {

2556

<a name="2547" href="#2547">2547</a> realmsUsed.add(realm);

2557

<a name="2548" href="#2548">2548</a> }

2558

2559

<a name="2550" href="#2550">2550</a> try {

2560

<a name="2551" href="#2551">2551</a> //remove preemptive header and reauthenticate

2561

<a name="2552" href="#2552">2552</a> switch (statusCode) {

2562

<a name="2553" href="#2553">2553</a> case HttpStatus.SC_UNAUTHORIZED:

2563

<a name="2554" href="#2554">2554</a> removeRequestHeader(HttpAuthenticator.WWW_AUTH_RESP);

2564

<a name="2555" href="#2555">2555</a> authenticated = HttpAuthenticator.authenticate(

2565

<a name="2556" href="#2556">2556</a> authscheme, this, conn, state);

2566

<a name="2557" href="#2557">2557</a> this.realm = authscheme.getRealm();

2567

<a name="2558" href="#2558">2558</a> this.authScheme = authscheme;

2568

<a name="2559" href="#2559">2559</a> break;

2569

<a name="2560" href="#2560">2560</a> case HttpStatus.SC_PROXY_AUTHENTICATION_REQUIRED:

2570

<a name="2561" href="#2561">2561</a> removeRequestHeader(HttpAuthenticator.PROXY_AUTH_RESP);

2571

<a name="2562" href="#2562">2562</a> authenticated = HttpAuthenticator.authenticateProxy(

2572

<a name="2563" href="#2563">2563</a> authscheme, this, conn, state);

2573

<a name="2564" href="#2564">2564</a> this.proxyRealm = authscheme.getRealm();

2574

<a name="2565" href="#2565">2565</a> this.proxyAuthScheme = authscheme;

2575

<a name="2566" href="#2566">2566</a> break;

2576

<a name="2567" href="#2567">2567</a> }

2577

<a name="2568" href="#2568">2568</a> } catch (AuthenticationException e) {

2578

<a name="2569" href="#2569">2569</a> LOG.warn(e.getMessage());

2579

<a name="2570" href="#2570">2570</a> return true; // finished request

2580

<a name="2571" href="#2571">2571</a> }

2581

<a name="2572" href="#2572">2572</a> if (!authenticated) {

2582

<a name="2573" href="#2573">2573</a> // won't be able to authenticate to this challenge

2583

<a name="2574" href="#2574">2574</a> // without additional information

2584

<a name="2575" href="#2575">2575</a> LOG.debug("HttpMethodBase.execute(): Server demands "

2585

<a name="2576" href="#2576">2576</a> + "authentication credentials, but none are "

2586

<a name="2577" href="#2577">2577</a> + "available, so aborting.");

2587

<a name="2578" href="#2578">2578</a> } else {

2588

<a name="2579" href="#2579">2579</a> LOG.debug("HttpMethodBase.execute(): Server demanded "

2589

<a name="2580" href="#2580">2580</a> + "authentication credentials, will try again.");

2590

<a name="2581" href="#2581">2581</a> // let's try it again, using the credentials

2591

<a name="2582" href="#2582">2582</a> }

2592

<a name="2583" href="#2583">2583</a> }

2593

2594

<a name="2585" href="#2585">2585</a> return !authenticated; // finished processing if we aren't authenticated

2595

<a name="2586" href="#2586">2586</a> }

2596

2597

<a name="2588" href="#2588">2588</a> /***

2598

<a name="2589" href="#2589">2589</a> * Returns proxy authentication realm, if it has been used during authentication process.

2599

<a name="2590" href="#2590">2590</a> * Otherwise returns <tt>null</tt>.

2600

<a name="2591" href="#2591">2591</a> *

2601

<a name="2592" href="#2592">2592</a> * @return proxy authentication realm

2602

<a name="2593" href="#2593">2593</a> */

2603

<a name="2594" href="#2594">2594</a> public String getProxyAuthenticationRealm() {

2604

<a name="2595" href="#2595">2595</a> return this.proxyRealm;

2605

<a name="2596" href="#2596">2596</a> }

2606

2607

<a name="2598" href="#2598">2598</a> /***

2608

<a name="2599" href="#2599">2599</a> * Returns authentication realm, if it has been used during authentication process.

2609

<a name="2600" href="#2600">2600</a> * Otherwise returns <tt>null</tt>.

2610

<a name="2601" href="#2601">2601</a> *

2611

<a name="2602" href="#2602">2602</a> * @return authentication realm

2612

<a name="2603" href="#2603">2603</a> */

2613

<a name="2604" href="#2604">2604</a> public String getAuthenticationRealm() {

2614

<a name="2605" href="#2605">2605</a> return this.realm;

2615

<a name="2606" href="#2606">2606</a> }

2616

2617

<a name="2608" href="#2608">2608</a> /***

2618

<a name="2609" href="#2609">2609</a> * Sends the request and reads the response. The request will be retried

2619

<a name="2610" href="#2610">2610</a> * {@link #maxRetries} times if the operation fails with a

2620

<a name="2611" href="#2611">2611</a> * {@link HttpRecoverableException}.

2621

<a name="2612" href="#2612">2612</a> *

2622

<a name="2613" href="#2613">2613</a> *

2623

<a name="2614" href="#2614">2614</a> * The {@link #isUsed()} is set to true if the write succeeds.

2624

<a name="2615" href="#2615">2615</a> *

2625

<a name="2616" href="#2616">2616</a> *

2626

<a name="2617" href="#2617">2617</a> * @param state the {@link HttpState state} information associated with this method

2627

<a name="2618" href="#2618">2618</a> * @param conn the {@link HttpConnection connection} used to execute

2628

<a name="2619" href="#2619">2619</a> * this HTTP method

2629

<a name="2620" href="#2620">2620</a> *

2630

<a name="2621" href="#2621">2621</a> * @throws IOException if an I/O (transport) error occurs

2631

<a name="2622" href="#2622">2622</a> * @throws HttpException if a protocol exception occurs.

2632

<a name="2623" href="#2623">2623</a> * @throws HttpRecoverableException if a recoverable transport error occurs.

2633

<a name="2624" href="#2624">2624</a> * Usually this kind of exceptions can be recovered from by

2634

<a name="2625" href="#2625">2625</a> * retrying the HTTP method

2635

<a name="2626" href="#2626">2626</a> *

2636

<a name="2627" href="#2627">2627</a> * @see #writeRequest(HttpState,HttpConnection)

2637

<a name="2628" href="#2628">2628</a> * @see #readResponse(HttpState,HttpConnection)

2638

<a name="2629" href="#2629">2629</a> */

2639

<a name="2630" href="#2630">2630</a> private void processRequest(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> connection)

2640

<a name="2631" href="#2631">2631</a> throws HttpException, IOException {

2641

<a name="2632" href="#2632">2632</a> LOG.trace("enter HttpMethodBase.processRequest(HttpState, HttpConnection)");

2642

2643

<a name="2634" href="#2634">2634</a> int execCount = 0;

2644

<a name="2635" href="#2635">2635</a> boolean requestSent = false;

2645

2646

<a name="2637" href="#2637">2637</a> // loop until the method is successfully processed, the retryHandler

2647

<a name="2638" href="#2638">2638</a> // returns false or a non-recoverable exception is thrown

2648

<a name="2639" href="#2639">2639</a> while (true) {

2649

<a name="2640" href="#2640">2640</a> execCount++;

2650

<a name="2641" href="#2641">2641</a> requestSent = false;

2651

2652

<a name="2643" href="#2643">2643</a> if (LOG.isTraceEnabled()) {

2653

<a name="2644" href="#2644">2644</a> LOG.trace("Attempt number " + execCount + " to process request");

2654

<a name="2645" href="#2645">2645</a> }

2655

<a name="2646" href="#2646">2646</a> try {

2656

<a name="2647" href="#2647">2647</a> if (!connection.isOpen()) {

2657

<a name="2648" href="#2648">2648</a> LOG.debug("Opening the connection.");

2658

<a name="2649" href="#2649">2649</a> connection.open();

2659

<a name="2650" href="#2650">2650</a> }

2660

<a name="2651" href="#2651">2651</a> writeRequest(state, connection);

2661

<a name="2652" href="#2652">2652</a> requestSent = true;

2662

<a name="2653" href="#2653">2653</a> readResponse(state, connection);

2663

<a name="2654" href="#2654">2654</a> // the method has successfully executed

2664

<a name="2655" href="#2655">2655</a> used = true;

2665

<a name="2656" href="#2656">2656</a> break;

2666

<a name="2657" href="#2657">2657</a> } catch (HttpRecoverableException httpre) {

2667

<a name="2658" href="#2658">2658</a> if (LOG.isDebugEnabled()) {

2668

<a name="2659" href="#2659">2659</a> LOG.debug("Closing the connection.");

2669

<a name="2660" href="#2660">2660</a> }

2670

<a name="2661" href="#2661">2661</a> connection.close();

2671

<a name="2662" href="#2662">2662</a> LOG.info("Recoverable exception caught when processing request");

2672

<a name="2663" href="#2663">2663</a> // update the recoverable exception count.

2673

<a name="2664" href="#2664">2664</a> recoverableExceptionCount++;

2674

2675

<a name="2666" href="#2666">2666</a> // test if this method should be retried

2676

<a name="2667" href="#2667">2667</a> if (!getMethodRetryHandler().retryMethod(

2677

<a name="2668" href="#2668">2668</a> this,

2678

<a name="2669" href="#2669">2669</a> connection,

2679

<a name="2670" href="#2670">2670</a> httpre,

2680

<a name="2671" href="#2671">2671</a> execCount,

2681

<a name="2672" href="#2672">2672</a> requestSent)

2682

<a name="2673" href="#2673">2673</a> ) {

2683

<a name="2674" href="#2674">2674</a> LOG.warn(

2684

<a name="2675" href="#2675">2675</a> "Recoverable exception caught but MethodRetryHandler.retryMethod() "

2685

<a name="2676" href="#2676">2676</a> + "returned false, rethrowing exception"

2686

<a name="2677" href="#2677">2677</a> );

2687

<a name="2678" href="#2678">2678</a> // this connection can no longer be used, it has been closed

2688

<a name="2679" href="#2679">2679</a> doneWithConnection = true;

2689

<a name="2680" href="#2680">2680</a> throw httpre;

2690

<a name="2681" href="#2681">2681</a> }

2691

<a name="2682" href="#2682">2682</a> } catch (IOException e) {

2692

<a name="2683" href="#2683">2683</a> connection.close();

2693

<a name="2684" href="#2684">2684</a> doneWithConnection = true;

2694

<a name="2685" href="#2685">2685</a> throw e;

2695

<a name="2686" href="#2686">2686</a> } catch (RuntimeException e) {

2696

<a name="2687" href="#2687">2687</a> connection.close();

2697

<a name="2688" href="#2688">2688</a> doneWithConnection = true;

2698

<a name="2689" href="#2689">2689</a> throw e;

2699

<a name="2690" href="#2690">2690</a> }

2700

<a name="2691" href="#2691">2691</a> }

2701

<a name="2692" href="#2692">2692</a> }

2702

2703

<a name="2694" href="#2694">2694</a> /***

2704

<a name="2695" href="#2695">2695</a> * Returns the character set from the <tt>Content-Type</tt> header.

2705

<a name="2696" href="#2696">2696</a> * @param contentheader The content header.

2706

<a name="2697" href="#2697">2697</a> * @return String The character set.

2707

<a name="2698" href="#2698">2698</a> */

2708

<a name="2699" href="#2699">2699</a> protected static String getContentCharSet(<a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> contentheader) {

2709

<a name="2700" href="#2700">2700</a> LOG.trace("enter getContentCharSet( Header contentheader )");

2710

<a name="2701" href="#2701">2701</a> String charset = null;

2711

<a name="2702" href="#2702">2702</a> if (contentheader != null) {

2712

<a name="2703" href="#2703">2703</a> try {

2713

<a name="2704" href="#2704">2704</a> <a href="../../../../org/apache/commons/httpclient/HeaderElement.html">HeaderElement</a> values[] = contentheader.getValues();

2714

<a name="2705" href="#2705">2705</a> // I expect only one header element to be there

2715

<a name="2706" href="#2706">2706</a> // No more. no less

2716

<a name="2707" href="#2707">2707</a> if (values.length == 1) {

2717

<a name="2708" href="#2708">2708</a> <a href="../../../../org/apache/commons/httpclient/NameValuePair.html">NameValuePair</a> param = values[0].getParameterByName("charset");

2718

<a name="2709" href="#2709">2709</a> if (param != null) {

2719

<a name="2710" href="#2710">2710</a> // If I get anything "funny"

2720

<a name="2711" href="#2711">2711</a> // UnsupportedEncondingException will result

2721

<a name="2712" href="#2712">2712</a> charset = param.getValue();

2722

<a name="2713" href="#2713">2713</a> }

2723

<a name="2714" href="#2714">2714</a> }

2724

<a name="2715" href="#2715">2715</a> } catch (HttpException e) {

2725

<a name="2716" href="#2716">2716</a> LOG.error(e);

2726

<a name="2717" href="#2717">2717</a> }

2727

<a name="2718" href="#2718">2718</a> }

2728

<a name="2719" href="#2719">2719</a> if (charset == null) {

2729

<a name="2720" href="#2720">2720</a> if (LOG.isDebugEnabled()) {

2730

<a name="2721" href="#2721">2721</a> LOG.debug("Default charset used: " + HttpConstants.DEFAULT_CONTENT_CHARSET);

2731

<a name="2722" href="#2722">2722</a> }

2732

<a name="2723" href="#2723">2723</a> charset = HttpConstants.DEFAULT_CONTENT_CHARSET;

2733

<a name="2724" href="#2724">2724</a> }

2734

<a name="2725" href="#2725">2725</a> return charset;

2735

<a name="2726" href="#2726">2726</a> }

2736

2737

2738

<a name="2729" href="#2729">2729</a> /***

2739

<a name="2730" href="#2730">2730</a> * Returns the character encoding of the request from the <tt>Content-Type</tt> header.

2740

<a name="2731" href="#2731">2731</a> *

2741

<a name="2732" href="#2732">2732</a> * @return String The character set.

2742

<a name="2733" href="#2733">2733</a> */

2743

<a name="2734" href="#2734">2734</a> public String getRequestCharSet() {

2744

<a name="2735" href="#2735">2735</a> return getContentCharSet(getRequestHeader("Content-Type"));

2745

<a name="2736" href="#2736">2736</a> }

2746

2747

2748

<a name="2739" href="#2739">2739</a> /***

2749

<a name="2740" href="#2740">2740</a> * Returns the character encoding of the response from the <tt>Content-Type</tt> header.

2750

<a name="2741" href="#2741">2741</a> *

2751

<a name="2742" href="#2742">2742</a> * @return String The character set.

2752

<a name="2743" href="#2743">2743</a> */

2753

<a name="2744" href="#2744">2744</a> public String getResponseCharSet() {

2754

<a name="2745" href="#2745">2745</a> return getContentCharSet(getResponseHeader("Content-Type"));

2755

<a name="2746" href="#2746">2746</a> }

2756

2757

<a name="2748" href="#2748">2748</a> /***

2758

<a name="2749" href="#2749">2749</a> * Returns the number of "recoverable" exceptions thrown and handled, to

2759

<a name="2750" href="#2750">2750</a> * allow for monitoring the quality of the connection.

2760

<a name="2751" href="#2751">2751</a> *

2761

<a name="2752" href="#2752">2752</a> * @return The number of recoverable exceptions handled by the method.

2762

<a name="2753" href="#2753">2753</a> */

2763

<a name="2754" href="#2754">2754</a> public int getRecoverableExceptionCount() {

2764

<a name="2755" href="#2755">2755</a> return recoverableExceptionCount;

2765

<a name="2756" href="#2756">2756</a> }

2766

2767

<a name="2758" href="#2758">2758</a> /***

2768

<a name="2759" href="#2759">2759</a> * A response has been consumed.

2769

<a name="2760" href="#2760">2760</a> *

2770

<a name="2761" href="#2761">2761</a> * The default behavior for this class is to check to see if the connection

2771

<a name="2762" href="#2762">2762</a> * should be closed, and close if need be, and to ensure that the connection

2772

<a name="2763" href="#2763">2763</a> * is returned to the connection manager - if and only if we are not still

2773

<a name="2764" href="#2764">2764</a> * inside the execute call.

2774

<a name="2765" href="#2765">2765</a> *

2775

<a name="2766" href="#2766">2766</a> */

2776

<a name="2767" href="#2767">2767</a> protected void responseBodyConsumed() {

2777

2778

<a name="2769" href="#2769">2769</a> // make sure this is the initial invocation of the notification,

2779

<a name="2770" href="#2770">2770</a> // ignore subsequent ones.

2780

<a name="2771" href="#2771">2771</a> responseStream = null;

2781

<a name="2772" href="#2772">2772</a> if (responseConnection != null) {

2782

<a name="2773" href="#2773">2773</a> responseConnection.setLastResponseInputStream(null);

2783

2784

<a name="2775" href="#2775">2775</a> if (shouldCloseConnection(responseConnection)) {

2785

<a name="2776" href="#2776">2776</a> responseConnection.close();

2786

<a name="2777" href="#2777">2777</a> }

2787

<a name="2778" href="#2778">2778</a> }

2788

<a name="2779" href="#2779">2779</a> this.connectionCloseForced = false;

2789

<a name="2780" href="#2780">2780</a> doneWithConnection = true;

2790

<a name="2781" href="#2781">2781</a> if (!inExecute) {

2791

<a name="2782" href="#2782">2782</a> ensureConnectionRelease();

2792

<a name="2783" href="#2783">2783</a> }

2793

<a name="2784" href="#2784">2784</a> }

2794

2795

<a name="2786" href="#2786">2786</a> /***

2796

<a name="2787" href="#2787">2787</a> * Insure that the connection is released back to the pool.

2797

<a name="2788" href="#2788">2788</a> */

2798

<a name="2789" href="#2789">2789</a> private void ensureConnectionRelease() {

2799

<a name="2790" href="#2790">2790</a> if (responseConnection != null) {

2800

<a name="2791" href="#2791">2791</a> responseConnection.releaseConnection();

2801

<a name="2792" href="#2792">2792</a> responseConnection = null;

2802

<a name="2793" href="#2793">2793</a> }

2803

<a name="2794" href="#2794">2794</a> }

2804

2805

<a name="2796" href="#2796">2796</a> /***

2806

<a name="2797" href="#2797">2797</a> * Returns the {@link HostConfiguration host configuration}.

2807

<a name="2798" href="#2798">2798</a> *

2808

<a name="2799" href="#2799">2799</a> * @return the host configuration

2809

<a name="2800" href="#2800">2800</a> */

2810

<a name="2801" href="#2801">2801</a> public <a href="../../../../org/apache/commons/httpclient/HostConfiguration.html">HostConfiguration</a> getHostConfiguration() {

2811

<a name="2802" href="#2802">2802</a> return hostConfiguration;

2812

<a name="2803" href="#2803">2803</a> }

2813

2814

<a name="2805" href="#2805">2805</a> /***

2815

<a name="2806" href="#2806">2806</a> * Sets the {@link HostConfiguration host configuration}.

2816

<a name="2807" href="#2807">2807</a> *

2817

<a name="2808" href="#2808">2808</a> * @param hostConfiguration The hostConfiguration to set

2818

<a name="2809" href="#2809">2809</a> */

2819

<a name="2810" href="#2810">2810</a> public void setHostConfiguration(<a href="../../../../org/apache/commons/httpclient/HostConfiguration.html">HostConfiguration</a> hostConfiguration) {

2820

<a name="2811" href="#2811">2811</a> this.hostConfiguration = hostConfiguration;

2821

<a name="2812" href="#2812">2812</a> }

2822

2823

<a name="2814" href="#2814">2814</a> /***

2824

<a name="2815" href="#2815">2815</a> * Returns the {@link MethodRetryHandler retry handler} for this HTTP method

2825

<a name="2816" href="#2816">2816</a> *

2826

<a name="2817" href="#2817">2817</a> * @return the methodRetryHandler

2827

<a name="2818" href="#2818">2818</a> */

2828

<a name="2819" href="#2819">2819</a> public <a href="../../../../org/apache/commons/httpclient/MethodRetryHandler.html">MethodRetryHandler</a> getMethodRetryHandler() {

2829

2830

<a name="2821" href="#2821">2821</a> if (methodRetryHandler == null) {

2831

<a name="2822" href="#2822">2822</a> methodRetryHandler = new <a href="../../../../org/apache/commons/httpclient/DefaultMethodRetryHandler.html">DefaultMethodRetryHandler</a>();

2832

<a name="2823" href="#2823">2823</a> }

2833

2834

<a name="2825" href="#2825">2825</a> return methodRetryHandler;

2835

<a name="2826" href="#2826">2826</a> }

2836

2837

<a name="2828" href="#2828">2828</a> /***

2838

<a name="2829" href="#2829">2829</a> * Sets the {@link MethodRetryHandler retry handler} for this HTTP method

2839

<a name="2830" href="#2830">2830</a> *

2840

<a name="2831" href="#2831">2831</a> * @param handler the methodRetryHandler to use when this method executed

2841

<a name="2832" href="#2832">2832</a> */

2842

<a name="2833" href="#2833">2833</a> public void setMethodRetryHandler(<a href="../../../../org/apache/commons/httpclient/MethodRetryHandler.html">MethodRetryHandler</a> handler) {

2843

<a name="2834" href="#2834">2834</a> methodRetryHandler = handler;

2844

<a name="2835" href="#2835">2835</a> }

2845

2846

<a name="2837" href="#2837">2837</a> /***

2847

<a name="2838" href="#2838">2838</a> * This method is a dirty hack intended to work around

2848

<a name="2839" href="#2839">2839</a> * current (2.0) design flaw that prevents the user from

2849

<a name="2840" href="#2840">2840</a> * obtaining correct status code, headers and response body from the

2850

<a name="2841" href="#2841">2841</a> * preceding HTTP CONNECT method.

2851

<a name="2842" href="#2842">2842</a> *

2852

<a name="2843" href="#2843">2843</a> * TODO: Remove this crap as soon as possible

2853

<a name="2844" href="#2844">2844</a> */

2854

<a name="2845" href="#2845">2845</a> protected void fakeResponse(

2855

<a name="2846" href="#2846">2846</a> <a href="../../../../org/apache/commons/httpclient/StatusLine.html">StatusLine</a> statusline,

2856

<a name="2847" href="#2847">2847</a> <a href="../../../../org/apache/commons/httpclient/HeaderGroup.html">HeaderGroup</a> responseheaders,

2857

<a name="2848" href="#2848">2848</a> InputStream responseStream

2858

<a name="2849" href="#2849">2849</a> ) {

2859

<a name="2850" href="#2850">2850</a> // set used so that the response can be read

2860

<a name="2851" href="#2851">2851</a> this.used = true;

2861

<a name="2852" href="#2852">2852</a> this.statusLine = statusline;

2862

<a name="2853" href="#2853">2853</a> this.responseHeaders = responseheaders;

2863

<a name="2854" href="#2854">2854</a> this.responseBody = null;

2864

<a name="2855" href="#2855">2855</a> this.responseStream = responseStream;

2865

<a name="2856" href="#2856">2856</a> }

2866

<a name="2857" href="#2857">2857</a> }

2867

</pre>

2868

<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>

2869

</html>

2870

Older »