~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/methods/EntityEnclosingMethod.java,v 1.18.2.5 2004/06/13 20:24:49 olegk Exp $

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

<a name="4" href="#4">4</a> * $Date: 2004/06/13 20:24:49 $

<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/methods/package-summary.html">org.apache.commons.httpclient.methods</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.OutputStream;

<a name="40" href="#40">40</a> import org.apache.commons.httpclient.ChunkedOutputStream;

<a name="41" href="#41">41</a> import org.apache.commons.httpclient.ContentLengthInputStream;

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

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

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

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

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

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

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

<a name="50" href="#50">50</a> * This abstract class serves as a foundation for all HTTP methods

<a name="51" href="#51">51</a> * that can enclose an entity within requests

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

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

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

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

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

<a name="57" href="#57">57</a> * @version $Revision: 1.18.2.5 $

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

<a name="59" href="#59">59</a> public abstract class <a href="../../../../../org/apache/commons/httpclient/methods/EntityEnclosingMethod.html">EntityEnclosingMethod</a> extends <a href="../../../../../org/apache/commons/httpclient/methods/ExpectContinueMethod.html">ExpectContinueMethod</a> {

<a name="61" href="#61">61</a> // ----------------------------------------- Static variables/initializers

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

<a name="64" href="#64">64</a> * The content length will be calculated automatically. This implies

<a name="65" href="#65">65</a> * buffering of the content.

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

<a name="67" href="#67">67</a> public static final int CONTENT_LENGTH_AUTO = -2;

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

<a name="70" href="#70">70</a> * The request will use chunked transfer encoding. Content length is not

<a name="71" href="#71">71</a> * calculated and the content is not buffered.

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

<a name="73" href="#73">73</a> public static final int CONTENT_LENGTH_CHUNKED = -1;

<a name="75" href="#75">75</a> /*** LOG object for this class. */

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

<a name="78" href="#78">78</a> /*** The buffered request body, if any. */

<a name="79" href="#79">79</a> private byte[] buffer = null;

<a name="81" href="#81">81</a> /*** The unbuffered request body, if any. */

<a name="82" href="#82">82</a> private InputStream requestStream = null;

<a name="84" href="#84">84</a> /*** The request body as string, if any. */

<a name="85" href="#85">85</a> private String requestString = null;

<a name="87" href="#87">87</a> /*** for optimization purpose, the generated request body may be

<a name="88" href="#88">88</a> * cached when the method is being executed.

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

<a name="90" href="#90">90</a> private byte[] contentCache = null;

100

101

<a name="92" href="#92">92</a> /*** Counts how often the request was sent to the server. */

102

<a name="93" href="#93">93</a> private int repeatCount = 0;

103

104

<a name="95" href="#95">95</a> /*** The content length of the <code>requestBodyStream</code> or one of

105

<a name="96" href="#96">96</a> * <code>CONTENT_LENGTH_AUTO</code> and <code>CONTENT_LENGTH_CHUNKED</code>.

106

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

107

<a name="98" href="#98">98</a> private int requestContentLength = CONTENT_LENGTH_AUTO;

108

109

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

110

111

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

112

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

113

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

114

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

115

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

116

<a name="107" href="#107">107</a> public <a href="../../../../../org/apache/commons/httpclient/methods/EntityEnclosingMethod.html">EntityEnclosingMethod</a>() {

117

<a name="108" href="#108">108</a> super();

118

<a name="109" href="#109">109</a> setFollowRedirects(false);

119

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

120

121

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

122

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

123

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

124

<a name="115" href="#115">115</a> * @param uri either an absolute or relative URI

125

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

126

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

127

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

128

<a name="119" href="#119">119</a> public <a href="../../../../../org/apache/commons/httpclient/methods/EntityEnclosingMethod.html">EntityEnclosingMethod</a>(String uri) {

129

<a name="120" href="#120">120</a> super(uri);

130

<a name="121" href="#121">121</a> setFollowRedirects(false);

131

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

132

133

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

134

<a name="125" href="#125">125</a> * Constructor specifying a URI and a tempDir.

135

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

136

<a name="127" href="#127">127</a> * @param uri either an absolute or relative URI

137

<a name="128" href="#128">128</a> * @param tempDir directory to store temp files in

138

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

139

<a name="130" href="#130">130</a> * @deprecated the client is responsible for disk I/O

140

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

141

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

142

<a name="133" href="#133">133</a> public <a href="../../../../../org/apache/commons/httpclient/methods/EntityEnclosingMethod.html">EntityEnclosingMethod</a>(String uri, String tempDir) {

143

<a name="134" href="#134">134</a> super(uri, tempDir);

144

<a name="135" href="#135">135</a> setFollowRedirects(false);

145

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

146

147

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

148

<a name="139" href="#139">139</a> * Constructor specifying a URI, tempDir and tempFile.

149

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

150

<a name="141" href="#141">141</a> * @param uri either an absolute or relative URI

151

<a name="142" href="#142">142</a> * @param tempDir directory to store temp files in

152

<a name="143" href="#143">143</a> * @param tempFile file to store temporary data in

153

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

154

<a name="145" href="#145">145</a> * @deprecated the client is responsible for disk I/O

155

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

156

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

157

<a name="148" href="#148">148</a> public <a href="../../../../../org/apache/commons/httpclient/methods/EntityEnclosingMethod.html">EntityEnclosingMethod</a>(String uri, String tempDir, String tempFile) {

158

<a name="149" href="#149">149</a> super(uri, tempDir, tempFile);

159

<a name="150" href="#150">150</a> setFollowRedirects(false);

160

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

161

162

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

163

<a name="154" href="#154">154</a> * Returns <tt>true</tt> if there is a request body to be sent.

164

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

165

<a name="156" href="#156">156</a> * This method must be overridden by sub-classes that implement

166

<a name="157" href="#157">157</a> * alternative request content input methods

167

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

168

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

169

<a name="160" href="#160">160</a> * @return boolean

170

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

171

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

172

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

173

<a name="164" href="#164">164</a> protected boolean hasRequestContent() {

174

<a name="165" href="#165">165</a> LOG.trace("enter EntityEnclosingMethod.hasRequestContent()");

175

<a name="166" href="#166">166</a> return (this.buffer != null)

176

<a name="167" href="#167">167</a> || (this.requestStream != null)

177

<a name="168" href="#168">168</a> || (this.requestString != null);

178

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

179

180

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

181

<a name="172" href="#172">172</a> * Clears request body.

182

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

183

<a name="174" href="#174">174</a> * This method must be overridden by sub-classes that implement

184

<a name="175" href="#175">175</a> * alternative request content input methods.

185

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

186

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

187

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

188

<a name="179" href="#179">179</a> protected void clearRequestBody() {

189

<a name="180" href="#180">180</a> LOG.trace("enter EntityEnclosingMethod.clearRequestBody()");

190

<a name="181" href="#181">181</a> this.requestStream = null;

191

<a name="182" href="#182">182</a> this.requestString = null;

192

<a name="183" href="#183">183</a> this.buffer = null;

193

<a name="184" href="#184">184</a> this.contentCache = null;

194

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

195

196

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

197

<a name="188" href="#188">188</a> * Generates request body.

198

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

199

<a name="190" href="#190">190</a> * This method must be overridden by sub-classes that implement

200

<a name="191" href="#191">191</a> * alternative request content input methods.

201

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

202

<a name="193" href="#193">193</a> * @return request body as an array of bytes. If the request content

203

<a name="194" href="#194">194</a> * has not been set, returns <tt>null</tt>.

204

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

205

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

206

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

207

<a name="198" href="#198">198</a> protected byte[] generateRequestBody() {

208

<a name="199" href="#199">199</a> LOG.trace("enter EntityEnclosingMethod.renerateRequestBody()");

209

<a name="200" href="#200">200</a> if (this.requestStream != null) {

210

<a name="201" href="#201">201</a> bufferContent();

211

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

212

213

<a name="204" href="#204">204</a> if (this.buffer != null) {

214

<a name="205" href="#205">205</a> return this.buffer;

215

<a name="206" href="#206">206</a> } else if (this.requestString != null) {

216

<a name="207" href="#207">207</a> return HttpConstants.getContentBytes(this.requestString, getRequestCharSet());

217

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

218

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

219

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

220

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

221

222

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

223

<a name="214" href="#214">214</a> * Entity enclosing requests cannot be redirected without user intervention

224

<a name="215" href="#215">215</a> * according to RFC 2616.

225

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

226

<a name="217" href="#217">217</a> * @return <code>false</code>.

227

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

228

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

229

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

230

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

231

<a name="222" href="#222">222</a> return false;

232

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

233

234

235

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

236

<a name="227" href="#227">227</a> * Entity enclosing requests cannot be redirected without user intervention

237

<a name="228" href="#228">228</a> * according to RFC 2616.

238

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

239

<a name="230" href="#230">230</a> * @param followRedirects must always be <code>false</code>

240

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

241

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

242

<a name="233" href="#233">233</a> if (followRedirects == true) {

243

<a name="234" href="#234">234</a> // TODO: EntityEnclosingMethod should inherit from HttpMethodBase rather than GetMethod

244

<a name="235" href="#235">235</a> // Enable exception once the inheritence is fixed

245

<a name="236" href="#236">236</a> //throw new IllegalArgumentException(

246

<a name="237" href="#237">237</a> // "Entity enclosing requests cannot be redirected without user intervention");

247

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

248

<a name="239" href="#239">239</a> super.setFollowRedirects(false);

249

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

250

251

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

252

<a name="243" href="#243">243</a> * Sets length information about the request body.

253

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

254

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

255

<a name="246" href="#246">246</a> * Note: If you specify a content length the request is unbuffered. This

256

<a name="247" href="#247">247</a> * prevents redirection and automatic retry if a request fails the first

257

<a name="248" href="#248">248</a> * time. This means that the HttpClient can not perform authorization

258

<a name="249" href="#249">249</a> * automatically but will throw an Exception. You will have to set the

259

<a name="250" href="#250">250</a> * necessary 'Authorization' or 'Proxy-Authorization' headers manually.

260

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

261

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

262

<a name="253" href="#253">253</a> * @param length size in bytes or any of CONTENT_LENGTH_AUTO,

263

<a name="254" href="#254">254</a> * CONTENT_LENGTH_CHUNKED. If number of bytes or CONTENT_LENGTH_CHUNKED

264

<a name="255" href="#255">255</a> * is specified the content will not be buffered internally and the

265

<a name="256" href="#256">256</a> * Content-Length header of the request will be used. In this case

266

<a name="257" href="#257">257</a> * the user is responsible to supply the correct content length.

267

<a name="258" href="#258">258</a> * If CONTENT_LENGTH_AUTO is specified the request will be buffered

268

<a name="259" href="#259">259</a> * before it is sent over the network.

269

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

270

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

271

<a name="262" href="#262">262</a> public void setRequestContentLength(int length) {

272

<a name="263" href="#263">263</a> LOG.trace("enter EntityEnclosingMethod.setRequestContentLength(int)");

273

<a name="264" href="#264">264</a> this.requestContentLength = length;

274

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

275

276

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

277

<a name="268" href="#268">268</a> * Overrides method of {@link org.apache.commons.httpclient.HttpMethodBase}

278

<a name="269" href="#269">269</a> * to return the length of the request body.

279

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

280

<a name="271" href="#271">271</a> * @return number of bytes in the request body

281

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

282

<a name="273" href="#273">273</a> protected int getRequestContentLength() {

283

<a name="274" href="#274">274</a> LOG.trace("enter EntityEnclosingMethod.getRequestContentLength()");

284

285

<a name="276" href="#276">276</a> if (!hasRequestContent()) {

286

<a name="277" href="#277">277</a> return 0;

287

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

288

<a name="279" href="#279">279</a> if (this.requestContentLength != CONTENT_LENGTH_AUTO) {

289

<a name="280" href="#280">280</a> return this.requestContentLength;

290

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

291

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

292

<a name="283" href="#283">283</a> this.contentCache = generateRequestBody();

293

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

294

<a name="285" href="#285">285</a> return (this.contentCache == null) ? 0 : this.contentCache.length;

295

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

296

297

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

298

<a name="289" href="#289">289</a> * Generates <tt>Content-Length</tt> or <tt>Transfer-Encoding: Chunked</tt>

299

<a name="290" href="#290">290</a> * request header, as long as no <tt>Content-Length</tt> request header

300

<a name="291" href="#291">291</a> * already exists.

301

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

302

<a name="293" href="#293">293</a> * @param state the {@link HttpState state} information associated with this method

303

<a name="294" href="#294">294</a> * @param conn the {@link HttpConnection connection} used to execute

304

<a name="295" href="#295">295</a> * this HTTP method

305

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

306

<a name="297" href="#297">297</a> * @throws IOException if an I/O (transport) error occurs

307

<a name="298" href="#298">298</a> * @throws HttpException if a protocol exception occurs.

308

<a name="299" href="#299">299</a> * @throws HttpRecoverableException if a recoverable transport error occurs.

309

<a name="300" href="#300">300</a> * Usually this kind of exceptions can be recovered from by

310

<a name="301" href="#301">301</a> * retrying the HTTP method

311

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

312

<a name="303" href="#303">303</a> protected void addContentLengthRequestHeader(<a href="../../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state,

313

<a name="304" href="#304">304</a> <a href="../../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)

314

<a name="305" href="#305">305</a> throws IOException, <a href="../../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {

315

<a name="306" href="#306">306</a> LOG.trace("enter HttpMethodBase.addContentLengthRequestHeader("

316

<a name="307" href="#307">307</a> + "HttpState, HttpConnection)");

317

318

<a name="309" href="#309">309</a> if ((getRequestHeader("content-length") == null)

319

<a name="310" href="#310">310</a> && (getRequestHeader("Transfer-Encoding") == null)) {

320

<a name="311" href="#311">311</a> int len = getRequestContentLength();

321

<a name="312" href="#312">312</a> if (len >= 0) {

322

<a name="313" href="#313">313</a> addRequestHeader("Content-Length", String.valueOf(len));

323

<a name="314" href="#314">314</a> } else if ((len == CONTENT_LENGTH_CHUNKED) && (isHttp11())) {

324

<a name="315" href="#315">315</a> addRequestHeader("Transfer-Encoding", "chunked");

325

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

326

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

327

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

328

329

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

330

<a name="321" href="#321">321</a> * Sets the request body to be the specified inputstream.

331

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

332

<a name="323" href="#323">323</a> * @param body Request body content as {@link java.io.InputStream}

333

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

334

<a name="325" href="#325">325</a> public void setRequestBody(InputStream body) {

335

<a name="326" href="#326">326</a> LOG.trace("enter EntityEnclosingMethod.setRequestBody(InputStream)");

336

<a name="327" href="#327">327</a> clearRequestBody();

337

<a name="328" href="#328">328</a> this.requestStream = body;

338

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

339

340

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

341

<a name="332" href="#332">332</a> * Returns the request body as a {@link java.io.InputStream}.

342

<a name="333" href="#333">333</a> * Calling this method will cause the content to be buffered.

343

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

344

<a name="335" href="#335">335</a> * @return The request body as a {@link java.io.InputStream} if it has been set.

345

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

346

<a name="337" href="#337">337</a> public InputStream getRequestBody() {

347

<a name="338" href="#338">338</a> LOG.trace("enter EntityEnclosingMethod.getRequestBody()");

348

<a name="339" href="#339">339</a> byte [] content = generateRequestBody();

349

<a name="340" href="#340">340</a> if (content != null) {

350

<a name="341" href="#341">341</a> return new ByteArrayInputStream(content);

351

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

352

<a name="343" href="#343">343</a> return new ByteArrayInputStream(new byte[] {});

353

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

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> * Sets the request body to be the specified string.

358

<a name="349" href="#349">349</a> * The string will be submitted, using the encoding

359

<a name="350" href="#350">350</a> * specified in the Content-Type request header.

360

<a name="351" href="#351">351</a> * Example: <code>setRequestHeader("Content-type", "text/xml; charset=UTF-8");</code>

361

<a name="352" href="#352">352</a> * Would use the UTF-8 encoding.

362

<a name="353" href="#353">353</a> * If no charset is specified, the

363

<a name="354" href="#354">354</a> * {@link org.apache.commons.httpclient.HttpConstants#DEFAULT_CONTENT_CHARSET default}

364

<a name="355" href="#355">355</a> * content encoding is used (ISO-8859-1).

365

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

366

<a name="357" href="#357">357</a> * @param body Request body content as a string

367

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

368

<a name="359" href="#359">359</a> public void setRequestBody(String body) {

369

<a name="360" href="#360">360</a> LOG.trace("enter EntityEnclosingMethod.setRequestBody(String)");

370

<a name="361" href="#361">361</a> clearRequestBody();

371

<a name="362" href="#362">362</a> this.requestString = body;

372

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

373

374

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

375

<a name="366" href="#366">366</a> * Returns the request body as a {@link java.lang.String}.

376

<a name="367" href="#367">367</a> * Calling this method will cause the content to be buffered.

377

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

378

<a name="369" href="#369">369</a> * @return the request body as a {@link java.lang.String}

379

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

380

<a name="371" href="#371">371</a> * @throws IOException when i/o error occurs while reading the request

381

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

382

<a name="373" href="#373">373</a> public String getRequestBodyAsString() throws IOException {

383

<a name="374" href="#374">374</a> LOG.trace("enter EntityEnclosingMethod.getRequestBodyAsString()");

384

<a name="375" href="#375">375</a> byte [] content = generateRequestBody();

385

<a name="376" href="#376">376</a> if (content != null) {

386

<a name="377" href="#377">377</a> return HttpConstants.getContentString(content, getRequestCharSet());

387

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

388

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

389

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

390

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

391

392

393

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

394

<a name="385" href="#385">385</a> * Writes the request body to the given {@link HttpConnection connection}.

395

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

396

<a name="387" href="#387">387</a> * @param state the {@link HttpState state} information associated with this method

397

<a name="388" href="#388">388</a> * @param conn the {@link HttpConnection connection} used to execute

398

<a name="389" href="#389">389</a> * this HTTP method

399

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

400

<a name="391" href="#391">391</a> * @return <tt>true</tt>

401

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

402

<a name="393" href="#393">393</a> * @throws IOException if an I/O (transport) error occurs

403

<a name="394" href="#394">394</a> * @throws HttpException if a protocol exception occurs.

404

<a name="395" href="#395">395</a> * @throws HttpRecoverableException if a recoverable transport error occurs.

405

<a name="396" href="#396">396</a> * Usually this kind of exceptions can be recovered from by

406

<a name="397" href="#397">397</a> * retrying the HTTP method

407

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

408

<a name="399" href="#399">399</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)

409

<a name="400" href="#400">400</a> throws IOException, <a href="../../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {

410

<a name="401" href="#401">401</a> LOG.trace(

411

<a name="402" href="#402">402</a> "enter EntityEnclosingMethod.writeRequestBody(HttpState, HttpConnection)");

412

413

<a name="404" href="#404">404</a> if (!hasRequestContent()) {

414

<a name="405" href="#405">405</a> LOG.debug("Request body has not been specified");

415

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

416

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

417

418

<a name="409" href="#409">409</a> int contentLength = getRequestContentLength();

419

420

<a name="411" href="#411">411</a> if ((contentLength == CONTENT_LENGTH_CHUNKED) && !isHttp11()) {

421

<a name="412" href="#412">412</a> throw new <a href="../../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a>(

422

<a name="413" href="#413">413</a> "Chunked transfer encoding not allowed for HTTP/1.0");

423

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

424

425

<a name="416" href="#416">416</a> InputStream instream = null;

426

<a name="417" href="#417">417</a> if (this.requestStream != null) {

427

<a name="418" href="#418">418</a> LOG.debug("Using unbuffered request body");

428

<a name="419" href="#419">419</a> instream = this.requestStream;

429

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

430

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

431

<a name="422" href="#422">422</a> this.contentCache = generateRequestBody();

432

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

433

<a name="424" href="#424">424</a> if (this.contentCache != null) {

434

<a name="425" href="#425">425</a> LOG.debug("Using buffered request body");

435

<a name="426" href="#426">426</a> instream = new ByteArrayInputStream(this.contentCache);

436

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

437

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

438

439

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

440

<a name="431" href="#431">431</a> LOG.debug("Request body is empty");

441

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

442

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

443

444

<a name="435" href="#435">435</a> if ((this.repeatCount > 0) && (this.contentCache == null)) {

445

<a name="436" href="#436">436</a> throw new <a href="../../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a>(

446

<a name="437" href="#437">437</a> "Unbuffered entity enclosing request can not be repeated.");

447

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

448

449

<a name="440" href="#440">440</a> this.repeatCount++;

450

451

<a name="442" href="#442">442</a> OutputStream outstream = conn.getRequestOutputStream();

452

453

<a name="444" href="#444">444</a> if (contentLength == CONTENT_LENGTH_CHUNKED) {

454

<a name="445" href="#445">445</a> outstream = new <a href="../../../../../org/apache/commons/httpclient/ChunkedOutputStream.html">ChunkedOutputStream</a>(outstream);

455

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

456

<a name="447" href="#447">447</a> if (contentLength >= 0) {

457

<a name="448" href="#448">448</a> // don't need a watcher here - we're reading from something local,

458

<a name="449" href="#449">449</a> // not server-side.

459

<a name="450" href="#450">450</a> instream = new <a href="../../../../../org/apache/commons/httpclient/ContentLengthInputStream.html">ContentLengthInputStream</a>(instream, contentLength);

460

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

461

462

<a name="453" href="#453">453</a> byte[] tmp = new byte[4096];

463

<a name="454" href="#454">454</a> int total = 0;

464

<a name="455" href="#455">455</a> int i = 0;

465

<a name="456" href="#456">456</a> while ((i = instream.read(tmp)) >= 0) {

466

<a name="457" href="#457">457</a> outstream.write(tmp, 0, i);

467

<a name="458" href="#458">458</a> total += i;

468

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

469

<a name="460" href="#460">460</a> // This is hardly the most elegant solution to closing chunked stream

470

<a name="461" href="#461">461</a> if (outstream instanceof ChunkedOutputStream) {

471

<a name="462" href="#462">462</a> ((<a href="../../../../../org/apache/commons/httpclient/ChunkedOutputStream.html">ChunkedOutputStream</a>) outstream).writeClosingChunk();

472

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

473

<a name="464" href="#464">464</a> if ((contentLength > 0) && (total < contentLength)) {

474

<a name="465" href="#465">465</a> throw new IOException("Unexpected end of input stream after "

475

<a name="466" href="#466">466</a> + total + " bytes (expected " + contentLength + " bytes)");

476

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

477

<a name="468" href="#468">468</a> LOG.debug("Request body sent");

478

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

479

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

480

481

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

482

<a name="473" href="#473">473</a> * Recycles the HTTP method so that it can be used again.

483

<a name="474" href="#474">474</a> * Note that all of the instance variables will be reset

484

<a name="475" href="#475">475</a> * once this method has been called. This method will also

485

<a name="476" href="#476">476</a> * release the connection being used by this HTTP method.

486

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

487

<a name="478" href="#478">478</a> * @see #releaseConnection()

488

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

489

<a name="480" href="#480">480</a> * @deprecated no longer supported and will be removed in the future

490

<a name="481" href="#481">481</a> * version of HttpClient

491

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

492

<a name="483" href="#483">483</a> public void recycle() {

493

<a name="484" href="#484">484</a> LOG.trace("enter EntityEnclosingMethod.recycle()");

494

<a name="485" href="#485">485</a> clearRequestBody();

495

<a name="486" href="#486">486</a> this.requestContentLength = CONTENT_LENGTH_AUTO;

496

<a name="487" href="#487">487</a> this.repeatCount = 0;

497

<a name="488" href="#488">488</a> super.recycle();

498

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

499

500

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

501

<a name="492" href="#492">492</a> * Buffers request body input stream.

502

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

503

<a name="494" href="#494">494</a> private void bufferContent() {

504

<a name="495" href="#495">495</a> LOG.trace("enter EntityEnclosingMethod.bufferContent()");

505

506

<a name="497" href="#497">497</a> if (this.buffer != null) {

507

<a name="498" href="#498">498</a> // Already been buffered

508

<a name="499" href="#499">499</a> return;

509

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

510

<a name="501" href="#501">501</a> if (this.requestStream != null) {

511

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

512

<a name="503" href="#503">503</a> ByteArrayOutputStream tmp = new ByteArrayOutputStream();

513

<a name="504" href="#504">504</a> byte[] data = new byte[4096];

514

<a name="505" href="#505">505</a> int l = 0;

515

<a name="506" href="#506">506</a> while ((l = this.requestStream.read(data)) >= 0) {

516

<a name="507" href="#507">507</a> tmp.write(data, 0, l);

517

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

518

<a name="509" href="#509">509</a> this.buffer = tmp.toByteArray();

519

<a name="510" href="#510">510</a> this.requestStream = null;

520

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

521

<a name="512" href="#512">512</a> LOG.error(e.getMessage(), e);

522

<a name="513" href="#513">513</a> this.buffer = null;

523

<a name="514" href="#514">514</a> this.requestStream = null;

524

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

525

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

526

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

527

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

528

</pre>

529

<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>

530

</html>

531

Older »