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

« back to all changes in this revision

Viewing changes to docs/xref/org/apache/commons/httpclient/ResponseInputStream.html

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

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
3
<head>
 
4
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>ResponseInputStream xref</title>
 
5
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
 
6
</head>
 
7
<body>
 
8
<div id="overview"><a href="../../../../../apidocs/org/apache/commons/httpclient/ResponseInputStream.html">View Javadoc</a></div><pre>
 
9
 
 
10
<a name="1" href="#1">1</a>   <em class="comment">/*</em>
 
11
<a name="2" href="#2">2</a>   <em class="comment"> * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/Attic/ResponseInputStream.java,v 1.23.2.1 2004/02/22 18:21:13 olegk Exp $</em>
 
12
<a name="3" href="#3">3</a>   <em class="comment"> * $Revision: 1.23.2.1 $</em>
 
13
<a name="4" href="#4">4</a>   <em class="comment"> * $Date: 2004/02/22 18:21:13 $</em>
 
14
<a name="5" href="#5">5</a>   <em class="comment"> *</em>
 
15
<a name="6" href="#6">6</a>   <em class="comment"> * ====================================================================</em>
 
16
<a name="7" href="#7">7</a>   <em class="comment"> *</em>
 
17
<a name="8" href="#8">8</a>   <em class="comment"> *  Copyright 1999-2004 The Apache Software Foundation</em>
 
18
<a name="9" href="#9">9</a>   <em class="comment"> *</em>
 
19
<a name="10" href="#10">10</a>  <em class="comment"> *  Licensed under the Apache License, Version 2.0 (the "License");</em>
 
20
<a name="11" href="#11">11</a>  <em class="comment"> *  you may not use this file except in compliance with the License.</em>
 
21
<a name="12" href="#12">12</a>  <em class="comment"> *  You may obtain a copy of the License at</em>
 
22
<a name="13" href="#13">13</a>  <em class="comment"> *</em>
 
23
<a name="14" href="#14">14</a>  <em class="comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
 
24
<a name="15" href="#15">15</a>  <em class="comment"> *</em>
 
25
<a name="16" href="#16">16</a>  <em class="comment"> *  Unless required by applicable law or agreed to in writing, software</em>
 
26
<a name="17" href="#17">17</a>  <em class="comment"> *  distributed under the License is distributed on an "AS IS" BASIS,</em>
 
27
<a name="18" href="#18">18</a>  <em class="comment"> *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
 
28
<a name="19" href="#19">19</a>  <em class="comment"> *  See the License for the specific language governing permissions and</em>
 
29
<a name="20" href="#20">20</a>  <em class="comment"> *  limitations under the License.</em>
 
30
<a name="21" href="#21">21</a>  <em class="comment"> * ====================================================================</em>
 
31
<a name="22" href="#22">22</a>  <em class="comment"> *</em>
 
32
<a name="23" href="#23">23</a>  <em class="comment"> * This software consists of voluntary contributions made by many</em>
 
33
<a name="24" href="#24">24</a>  <em class="comment"> * individuals on behalf of the Apache Software Foundation.  For more</em>
 
34
<a name="25" href="#25">25</a>  <em class="comment"> * information on the Apache Software Foundation, please see</em>
 
35
<a name="26" href="#26">26</a>  <em class="comment"> * &lt;<a href="http://www.apache.org/" target="alexandria_uri">http://www.apache.org/</a>>.</em>
 
36
<a name="27" href="#27">27</a>  <em class="comment"> *</em>
 
37
<a name="28" href="#28">28</a>  <em class="comment"> * [Additional notices, if required by prior licensing conditions]</em>
 
38
<a name="29" href="#29">29</a>  <em class="comment"> *</em>
 
39
<a name="30" href="#30">30</a>  <em class="comment"> */</em>
 
40
<a name="31" href="#31">31</a>  
 
41
<a name="32" href="#32">32</a>  <strong>package</strong> <a href="../../../../org/apache/commons/httpclient/package-summary.html">org.apache.commons.httpclient</a>;
 
42
<a name="33" href="#33">33</a>  
 
43
<a name="34" href="#34">34</a>  <strong>import</strong> java.io.IOException;
 
44
<a name="35" href="#35">35</a>  <strong>import</strong> java.io.InputStream;
 
45
<a name="36" href="#36">36</a>  
 
46
<a name="37" href="#37">37</a>  <strong>import</strong> org.apache.commons.logging.LogFactory;
 
47
<a name="38" href="#38">38</a>  <strong>import</strong> org.apache.commons.logging.Log;
 
48
<a name="39" href="#39">39</a>  
 
49
<a name="40" href="#40">40</a>  <em>/**<em>*</em></em>
 
50
<a name="41" href="#41">41</a>  <em> * &lt;p>{@link InputStream} wrapper supporting the chunked transfer encoding.&lt;/p></em>
 
51
<a name="42" href="#42">42</a>  <em> *</em>
 
52
<a name="43" href="#43">43</a>  <em> * @author &lt;a href="<a href="mailto:remm@apache.org" target="alexandria_uri">mailto:remm@apache.org</a>">Remy Maucherat&lt;/a></em>
 
53
<a name="44" href="#44">44</a>  <em> * @author Sean C. Sullivan</em>
 
54
<a name="45" href="#45">45</a>  <em> * @author &lt;a href="<a href="mailto:dion@apache.org" target="alexandria_uri">mailto:dion@apache.org</a>">dIon Gillard&lt;/a></em>
 
55
<a name="46" href="#46">46</a>  <em> * @author &lt;a href="<a href="mailto:mbowler@GargoyleSoftware.com" target="alexandria_uri">mailto:mbowler@GargoyleSoftware.com</a>">Mike Bowler&lt;/a></em>
 
56
<a name="47" href="#47">47</a>  <em> * @version $Revision: 1.23.2.1 $ $Date: 2004/02/22 18:21:13 $</em>
 
57
<a name="48" href="#48">48</a>  <em> *</em>
 
58
<a name="49" href="#49">49</a>  <em> * @deprecated Use new ChunkedInputStream(HttpConnecion#getResponseInputStream());</em>
 
59
<a name="50" href="#50">50</a>  <em> *</em>
 
60
<a name="51" href="#51">51</a>  <em> */</em>
 
61
<a name="52" href="#52">52</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../org/apache/commons/httpclient/ResponseInputStream.html">ResponseInputStream</a> <strong>extends</strong> InputStream {
 
62
<a name="53" href="#53">53</a>  
 
63
<a name="54" href="#54">54</a>      <em class="comment">// -------------------------------------------------------- Class Variables</em>
 
64
<a name="55" href="#55">55</a>      
 
65
<a name="56" href="#56">56</a>      <em>/**<em>* Log object for this class. */</em></em>
 
66
<a name="57" href="#57">57</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> Log LOG = LogFactory.getLog(ResponseInputStream.<strong>class</strong>);
 
67
<a name="58" href="#58">58</a>  
 
68
<a name="59" href="#59">59</a>      <em class="comment">// ----------------------------------------------------------- Constructors</em>
 
69
<a name="60" href="#60">60</a>  
 
70
<a name="61" href="#61">61</a>      <em>/**<em>*</em></em>
 
71
<a name="62" href="#62">62</a>  <em>     *</em>
 
72
<a name="63" href="#63">63</a>  <em>     * @param stream Must be non-null.</em>
 
73
<a name="64" href="#64">64</a>  <em>     * @param chunked &lt;code>true&lt;/code> if the input stream is chunked</em>
 
74
<a name="65" href="#65">65</a>  <em>     * @param contentLength content length</em>
 
75
<a name="66" href="#66">66</a>  <em>     *</em>
 
76
<a name="67" href="#67">67</a>  <em>     * @deprecated Use ChunkedInputStream;</em>
 
77
<a name="68" href="#68">68</a>  <em>     */</em>
 
78
<a name="69" href="#69">69</a>      <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/ResponseInputStream.html">ResponseInputStream</a>(InputStream stream, <strong>boolean</strong> chunked, <strong>int</strong> contentLength) {
 
79
<a name="70" href="#70">70</a>          LOG.trace(<span class="string">"enter ResponseInputStream(InputStream, boolean, int)"</span>);
 
80
<a name="71" href="#71">71</a>  
 
81
<a name="72" href="#72">72</a>          <strong>if</strong> (<strong>null</strong> == stream) {
 
82
<a name="73" href="#73">73</a>              <strong>throw</strong> <strong>new</strong> NullPointerException(<span class="string">"InputStream parameter is null"</span>);
 
83
<a name="74" href="#74">74</a>          }
 
84
<a name="75" href="#75">75</a>          closed = false;
 
85
<a name="76" href="#76">76</a>          count = 0;
 
86
<a name="77" href="#77">77</a>          <strong>this</strong>.chunk = chunked;
 
87
<a name="78" href="#78">78</a>          <strong>this</strong>.contentLength = contentLength;
 
88
<a name="79" href="#79">79</a>          <strong>this</strong>.stream = stream;
 
89
<a name="80" href="#80">80</a>      }
 
90
<a name="81" href="#81">81</a>  
 
91
<a name="82" href="#82">82</a>      <em>/**<em>*</em></em>
 
92
<a name="83" href="#83">83</a>  <em>     * Construct a servlet input stream associated with the specified Request.</em>
 
93
<a name="84" href="#84">84</a>  <em>     *</em>
 
94
<a name="85" href="#85">85</a>  <em>     * @param stream Must be non-null.</em>
 
95
<a name="86" href="#86">86</a>  <em>     * @param method Must be non-null.</em>
 
96
<a name="87" href="#87">87</a>  <em>     *</em>
 
97
<a name="88" href="#88">88</a>  <em>     * @deprecated Use ChunkedInputStream;</em>
 
98
<a name="89" href="#89">89</a>  <em>     *</em>
 
99
<a name="90" href="#90">90</a>  <em>     */</em>
 
100
<a name="91" href="#91">91</a>      <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/ResponseInputStream.html">ResponseInputStream</a>(InputStream stream, <a href="../../../../org/apache/commons/httpclient/HttpMethod.html">HttpMethod</a> method) {
 
101
<a name="92" href="#92">92</a>          <strong>super</strong>();
 
102
<a name="93" href="#93">93</a>          LOG.trace(<span class="string">"enter ResponseInputStream(InputStream, HttpMethod)"</span>);
 
103
<a name="94" href="#94">94</a>  
 
104
<a name="95" href="#95">95</a>          <strong>if</strong> (<strong>null</strong> == stream) {
 
105
<a name="96" href="#96">96</a>              <strong>throw</strong> <strong>new</strong> NullPointerException(<span class="string">"InputStream parameter is null"</span>);
 
106
<a name="97" href="#97">97</a>          }
 
107
<a name="98" href="#98">98</a>  
 
108
<a name="99" href="#99">99</a>          <strong>if</strong> (<strong>null</strong> == method) {
 
109
<a name="100" href="#100">100</a>             <strong>throw</strong> <strong>new</strong> NullPointerException(<span class="string">"HttpMethod parameter is null"</span>);
 
110
<a name="101" href="#101">101</a>         }
 
111
<a name="102" href="#102">102</a> 
 
112
<a name="103" href="#103">103</a>         closed = false;
 
113
<a name="104" href="#104">104</a>         count = 0;
 
114
<a name="105" href="#105">105</a> 
 
115
<a name="106" href="#106">106</a>         <em class="comment">// Retrieving transfer encoding header</em>
 
116
<a name="107" href="#107">107</a>         <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> transferEncoding = method.getResponseHeader(<span class="string">"transfer-encoding"</span>);
 
117
<a name="108" href="#108">108</a>         <strong>if</strong> ((<strong>null</strong> != transferEncoding) &amp;&amp; (transferEncoding.getValue().
 
118
<a name="109" href="#109">109</a>                              toLowerCase().indexOf(<span class="string">"chunked"</span>) != -1)) {
 
119
<a name="110" href="#110">110</a>             chunk = <strong>true</strong>;
 
120
<a name="111" href="#111">111</a>         }
 
121
<a name="112" href="#112">112</a> 
 
122
<a name="113" href="#113">113</a>         <em class="comment">// Retrieving content length header</em>
 
123
<a name="114" href="#114">114</a>         <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> contentLengthHeader = method.getResponseHeader(<span class="string">"content-length"</span>);
 
124
<a name="115" href="#115">115</a>         <strong>if</strong> (<strong>null</strong> != contentLengthHeader) {
 
125
<a name="116" href="#116">116</a>             <strong>try</strong> {
 
126
<a name="117" href="#117">117</a>                 <strong>this</strong>.contentLength =
 
127
<a name="118" href="#118">118</a>                     Integer.parseInt(contentLengthHeader.getValue());
 
128
<a name="119" href="#119">119</a>             } <strong>catch</strong> (NumberFormatException ignored) {
 
129
<a name="120" href="#120">120</a>                    <em class="comment">// we are intentionally ignoring the NumberFormatException</em>
 
130
<a name="121" href="#121">121</a>             }
 
131
<a name="122" href="#122">122</a>         }
 
132
<a name="123" href="#123">123</a> 
 
133
<a name="124" href="#124">124</a>         <strong>this</strong>.stream = stream;
 
134
<a name="125" href="#125">125</a>     }
 
135
<a name="126" href="#126">126</a> 
 
136
<a name="127" href="#127">127</a> 
 
137
<a name="128" href="#128">128</a>     <em class="comment">// ----------------------------------------------------- Instance Variables</em>
 
138
<a name="129" href="#129">129</a> 
 
139
<a name="130" href="#130">130</a>     <em>/**<em>*</em></em>
 
140
<a name="131" href="#131">131</a> <em>     * Has this stream been closed?</em>
 
141
<a name="132" href="#132">132</a> <em>     */</em>
 
142
<a name="133" href="#133">133</a>     <strong>private</strong> <strong>boolean</strong> closed = false;
 
143
<a name="134" href="#134">134</a> 
 
144
<a name="135" href="#135">135</a>     <em>/**<em>*</em></em>
 
145
<a name="136" href="#136">136</a> <em>     * Use chunking ?</em>
 
146
<a name="137" href="#137">137</a> <em>     */</em>
 
147
<a name="138" href="#138">138</a>     <strong>private</strong> <strong>boolean</strong> chunk = false;
 
148
<a name="139" href="#139">139</a> 
 
149
<a name="140" href="#140">140</a>     <em>/**<em>*</em></em>
 
150
<a name="141" href="#141">141</a> <em>     * True if the final chunk was found.</em>
 
151
<a name="142" href="#142">142</a> <em>     */</em>
 
152
<a name="143" href="#143">143</a>     <strong>private</strong> <strong>boolean</strong> endChunk = false;
 
153
<a name="144" href="#144">144</a> 
 
154
<a name="145" href="#145">145</a>     <em>/**<em>*</em></em>
 
155
<a name="146" href="#146">146</a> <em>     * Chunk buffer.</em>
 
156
<a name="147" href="#147">147</a> <em>     */</em>
 
157
<a name="148" href="#148">148</a>     <strong>private</strong> byte[] buffer = <strong>null</strong>;
 
158
<a name="149" href="#149">149</a> 
 
159
<a name="150" href="#150">150</a>     <em>/**<em>*</em></em>
 
160
<a name="151" href="#151">151</a> <em>     * Current chunk length.</em>
 
161
<a name="152" href="#152">152</a> <em>     */</em>
 
162
<a name="153" href="#153">153</a>     <strong>private</strong> <strong>int</strong> length = 0;
 
163
<a name="154" href="#154">154</a> 
 
164
<a name="155" href="#155">155</a>     <em>/**<em>*</em></em>
 
165
<a name="156" href="#156">156</a> <em>     * Current chunk buffer position.</em>
 
166
<a name="157" href="#157">157</a> <em>     */</em>
 
167
<a name="158" href="#158">158</a>     <strong>private</strong> <strong>int</strong> pos = 0;
 
168
<a name="159" href="#159">159</a> 
 
169
<a name="160" href="#160">160</a>     <em>/**<em>*</em></em>
 
170
<a name="161" href="#161">161</a> <em>     * The number of bytes which have already been returned by this stream.</em>
 
171
<a name="162" href="#162">162</a> <em>     */</em>
 
172
<a name="163" href="#163">163</a>     <strong>private</strong> <strong>int</strong> count = 0;
 
173
<a name="164" href="#164">164</a> 
 
174
<a name="165" href="#165">165</a>     <em>/**<em>*</em></em>
 
175
<a name="166" href="#166">166</a> <em>     * The content length past which we will not read, or -1 if there is</em>
 
176
<a name="167" href="#167">167</a> <em>     * no defined content length.</em>
 
177
<a name="168" href="#168">168</a> <em>     */</em>
 
178
<a name="169" href="#169">169</a>     <strong>private</strong> <strong>int</strong> contentLength = -1;
 
179
<a name="170" href="#170">170</a> 
 
180
<a name="171" href="#171">171</a>     <em>/**<em>*</em></em>
 
181
<a name="172" href="#172">172</a> <em>     * The underlying input stream from which we should read data.</em>
 
182
<a name="173" href="#173">173</a> <em>     */</em>
 
183
<a name="174" href="#174">174</a>     <strong>private</strong> InputStream stream = <strong>null</strong>;
 
184
<a name="175" href="#175">175</a> 
 
185
<a name="176" href="#176">176</a>     <em class="comment">// --------------------------------------------------------- Public Methods</em>
 
186
<a name="177" href="#177">177</a> 
 
187
<a name="178" href="#178">178</a>     <em>/**<em>*</em></em>
 
188
<a name="179" href="#179">179</a> <em>     * Close this input stream.  No physical level I-O is performed, but</em>
 
189
<a name="180" href="#180">180</a> <em>     * any further attempt to read from this stream will throw an IOException.</em>
 
190
<a name="181" href="#181">181</a> <em>     * If a content length has been set but not all of the bytes have yet been</em>
 
191
<a name="182" href="#182">182</a> <em>     * consumed, the remaining bytes will be swallowed.</em>
 
192
<a name="183" href="#183">183</a> <em>     * </em>
 
193
<a name="184" href="#184">184</a> <em>     * @throws IOException If an IO problem occurs.</em>
 
194
<a name="185" href="#185">185</a> <em>     *</em>
 
195
<a name="186" href="#186">186</a> <em>     * @deprecated Use ChunkedInputStream;</em>
 
196
<a name="187" href="#187">187</a> <em>     */</em>
 
197
<a name="188" href="#188">188</a>     <strong>public</strong> <strong>void</strong> close() throws IOException {
 
198
<a name="189" href="#189">189</a>         LOG.trace(<span class="string">"enter ResponseInputStream.close()"</span>);
 
199
<a name="190" href="#190">190</a>     <em class="comment">/*</em>
 
200
<a name="191" href="#191">191</a> <em class="comment">        // Xerces appears to doubly-close the input stream...</em>
 
201
<a name="192" href="#192">192</a> <em class="comment">        if(closed) {</em>
 
202
<a name="193" href="#193">193</a> <em class="comment">            throw new IOException("Stream is already closed");</em>
 
203
<a name="194" href="#194">194</a> <em class="comment">        }</em>
 
204
<a name="195" href="#195">195</a> <em class="comment">    */</em>
 
205
<a name="196" href="#196">196</a> 
 
206
<a name="197" href="#197">197</a>         <em class="comment">//TODO: This close code is not very robust</em>
 
207
<a name="198" href="#198">198</a>         <strong>if</strong> (!closed) {
 
208
<a name="199" href="#199">199</a>             <strong>try</strong> {
 
209
<a name="200" href="#200">200</a>                 <strong>if</strong> (chunk) {
 
210
<a name="201" href="#201">201</a>                     <strong>while</strong> (!endChunk) {
 
211
<a name="202" href="#202">202</a>                         <strong>int</strong> b = read();
 
212
<a name="203" href="#203">203</a>                         <strong>if</strong> (b &lt; 0) {
 
213
<a name="204" href="#204">204</a>                             <strong>break</strong>;
 
214
<a name="205" href="#205">205</a>                         }
 
215
<a name="206" href="#206">206</a>                     }
 
216
<a name="207" href="#207">207</a>                 } <strong>else</strong> {
 
217
<a name="208" href="#208">208</a>                     <strong>if</strong> (length > 0) {
 
218
<a name="209" href="#209">209</a>                         <strong>while</strong> (count &lt; length) {
 
219
<a name="210" href="#210">210</a>                             <strong>int</strong> b = read();
 
220
<a name="211" href="#211">211</a>                             <strong>if</strong> (b &lt; 0) {
 
221
<a name="212" href="#212">212</a>                                 <strong>break</strong>;
 
222
<a name="213" href="#213">213</a>                             }
 
223
<a name="214" href="#214">214</a>                         }
 
224
<a name="215" href="#215">215</a>                     }
 
225
<a name="216" href="#216">216</a>                 }
 
226
<a name="217" href="#217">217</a>             } <strong>catch</strong> (java.io.IOException ex) {
 
227
<a name="218" href="#218">218</a>                 <strong>throw</strong> ex;
 
228
<a name="219" href="#219">219</a>             } <strong>finally</strong> {
 
229
<a name="220" href="#220">220</a>                     closed = <strong>true</strong>;
 
230
<a name="221" href="#221">221</a>             }
 
231
<a name="222" href="#222">222</a>         }
 
232
<a name="223" href="#223">223</a>     }
 
233
<a name="224" href="#224">224</a> 
 
234
<a name="225" href="#225">225</a> 
 
235
<a name="226" href="#226">226</a>     <em>/**<em>*</em></em>
 
236
<a name="227" href="#227">227</a> <em>     * Read up to &lt;code>len&lt;/code> bytes of data from the input stream</em>
 
237
<a name="228" href="#228">228</a> <em>     * into an array of bytes.  An attempt is made to read as many as</em>
 
238
<a name="229" href="#229">229</a> <em>     * &lt;code>len&lt;/code> bytes, but a smaller number may be read,</em>
 
239
<a name="230" href="#230">230</a> <em>     * possibly zero.  The number of bytes actually read is returned as</em>
 
240
<a name="231" href="#231">231</a> <em>     * an integer.  This method blocks until input data is available,</em>
 
241
<a name="232" href="#232">232</a> <em>     * end of file is detected, or an exception is thrown.</em>
 
242
<a name="233" href="#233">233</a> <em>     *</em>
 
243
<a name="234" href="#234">234</a> <em>     * @param b The buffer into which the data is read</em>
 
244
<a name="235" href="#235">235</a> <em>     * @param off The start offset into array &lt;code>b&lt;/code> at which</em>
 
245
<a name="236" href="#236">236</a> <em>     *  the data is written</em>
 
246
<a name="237" href="#237">237</a> <em>     * @param len The maximum number of bytes to read</em>
 
247
<a name="238" href="#238">238</a> <em>     * @return The number of bytes that were read.</em>
 
248
<a name="239" href="#239">239</a> <em>     *</em>
 
249
<a name="240" href="#240">240</a> <em>     * @exception IOException if an input/output error occurs</em>
 
250
<a name="241" href="#241">241</a> <em>     *</em>
 
251
<a name="242" href="#242">242</a> <em>     * @deprecated Use ChunkedInputStream;</em>
 
252
<a name="243" href="#243">243</a> <em>     */</em>
 
253
<a name="244" href="#244">244</a>     <strong>public</strong> <strong>int</strong> read(byte b[], <strong>int</strong> off, <strong>int</strong> len)
 
254
<a name="245" href="#245">245</a>     throws IOException {
 
255
<a name="246" href="#246">246</a>         LOG.trace(<span class="string">"enter ResponseInputStream.read(byte, int, int)"</span>);
 
256
<a name="247" href="#247">247</a> 
 
257
<a name="248" href="#248">248</a>         <strong>int</strong> avail = length - pos;
 
258
<a name="249" href="#249">249</a>         <strong>if</strong> ((avail == 0) &amp;&amp; (!fillBuffer())) {
 
259
<a name="250" href="#250">250</a>             <strong>return</strong> (-1);
 
260
<a name="251" href="#251">251</a>         }
 
261
<a name="252" href="#252">252</a> 
 
262
<a name="253" href="#253">253</a>         avail = length - pos;
 
263
<a name="254" href="#254">254</a>         <strong>if</strong> (avail == 0) {
 
264
<a name="255" href="#255">255</a>             <strong>return</strong> (-1);
 
265
<a name="256" href="#256">256</a>         }
 
266
<a name="257" href="#257">257</a> 
 
267
<a name="258" href="#258">258</a>         <strong>int</strong> toCopy = avail;
 
268
<a name="259" href="#259">259</a> 
 
269
<a name="260" href="#260">260</a>         <strong>if</strong> (toCopy &lt; 0) {
 
270
<a name="261" href="#261">261</a>           <strong>return</strong> (-1);
 
271
<a name="262" href="#262">262</a>         }
 
272
<a name="263" href="#263">263</a> 
 
273
<a name="264" href="#264">264</a>         <strong>if</strong> (avail > len) {
 
274
<a name="265" href="#265">265</a>             toCopy = len;
 
275
<a name="266" href="#266">266</a>         }
 
276
<a name="267" href="#267">267</a>         System.arraycopy(buffer, pos, b, off, toCopy);
 
277
<a name="268" href="#268">268</a>         pos += toCopy;
 
278
<a name="269" href="#269">269</a>         <strong>return</strong> toCopy;
 
279
<a name="270" href="#270">270</a>     }
 
280
<a name="271" href="#271">271</a> 
 
281
<a name="272" href="#272">272</a>     <em>/**<em>*</em></em>
 
282
<a name="273" href="#273">273</a> <em>     * Read and return a single byte from this input stream, or -1 if end of</em>
 
283
<a name="274" href="#274">274</a> <em>     * file has been encountered.</em>
 
284
<a name="275" href="#275">275</a> <em>     *</em>
 
285
<a name="276" href="#276">276</a> <em>     * @return The next byte in the stream or -1.</em>
 
286
<a name="277" href="#277">277</a> <em>     * @exception IOException if an input/output error occurs</em>
 
287
<a name="278" href="#278">278</a> <em>     *</em>
 
288
<a name="279" href="#279">279</a> <em>     * @deprecated Use ChunkedInputStream;</em>
 
289
<a name="280" href="#280">280</a> <em>     */</em>
 
290
<a name="281" href="#281">281</a>     <strong>public</strong> <strong>int</strong> read() throws IOException {
 
291
<a name="282" href="#282">282</a>         LOG.trace(<span class="string">"enter ResponseInputStream.read()"</span>);
 
292
<a name="283" href="#283">283</a> 
 
293
<a name="284" href="#284">284</a>         <strong>if</strong> (pos == length) {
 
294
<a name="285" href="#285">285</a>             <strong>if</strong> (!fillBuffer()) {
 
295
<a name="286" href="#286">286</a>                 <strong>return</strong> (-1);
 
296
<a name="287" href="#287">287</a>             }
 
297
<a name="288" href="#288">288</a>         }
 
298
<a name="289" href="#289">289</a> 
 
299
<a name="290" href="#290">290</a>         <strong>return</strong> (buffer[pos++] &amp; 0xff);
 
300
<a name="291" href="#291">291</a> 
 
301
<a name="292" href="#292">292</a>     }
 
302
<a name="293" href="#293">293</a> 
 
303
<a name="294" href="#294">294</a>     <em class="comment">// -------------------------------------------------------- Private Methods</em>
 
304
<a name="295" href="#295">295</a> 
 
305
<a name="296" href="#296">296</a> 
 
306
<a name="297" href="#297">297</a>     <em>/**<em>*</em></em>
 
307
<a name="298" href="#298">298</a> <em>     * Fill the chunk buffer.</em>
 
308
<a name="299" href="#299">299</a> <em>     * @return true If successful</em>
 
309
<a name="300" href="#300">300</a> <em>     * @throws IOException If an IO problem occurs.</em>
 
310
<a name="301" href="#301">301</a> <em>     *</em>
 
311
<a name="302" href="#302">302</a> <em>     * @deprecated Use ChunkedInputStream;</em>
 
312
<a name="303" href="#303">303</a> <em>     */</em>
 
313
<a name="304" href="#304">304</a>     <strong>private</strong> <strong>boolean</strong> fillBuffer() throws IOException {
 
314
<a name="305" href="#305">305</a>         LOG.trace(<span class="string">"enter ResponseInputStream.fillBuffer()"</span>);
 
315
<a name="306" href="#306">306</a> 
 
316
<a name="307" href="#307">307</a>         <em class="comment">// Has this stream been closed?</em>
 
317
<a name="308" href="#308">308</a>         <strong>if</strong> (closed) {
 
318
<a name="309" href="#309">309</a>             <strong>return</strong> false;
 
319
<a name="310" href="#310">310</a>         }
 
320
<a name="311" href="#311">311</a>             <em class="comment">//throw new IOException("Stream is closed");</em>
 
321
<a name="312" href="#312">312</a> 
 
322
<a name="313" href="#313">313</a>         <strong>if</strong> (endChunk) {
 
323
<a name="314" href="#314">314</a>             <strong>return</strong> false;
 
324
<a name="315" href="#315">315</a>         }
 
325
<a name="316" href="#316">316</a> 
 
326
<a name="317" href="#317">317</a>         <em class="comment">// Have we read the specified content length already?</em>
 
327
<a name="318" href="#318">318</a>         <strong>if</strong> ((contentLength >= 0) &amp;&amp; (count >= contentLength)) {
 
328
<a name="319" href="#319">319</a>             <strong>return</strong> false;    <em class="comment">// End of file indicator</em>
 
329
<a name="320" href="#320">320</a>         }
 
330
<a name="321" href="#321">321</a> 
 
331
<a name="322" href="#322">322</a>         pos = 0;
 
332
<a name="323" href="#323">323</a> 
 
333
<a name="324" href="#324">324</a>         <strong>if</strong> (chunk) {
 
334
<a name="325" href="#325">325</a> 
 
335
<a name="326" href="#326">326</a>             <strong>try</strong> {
 
336
<a name="327" href="#327">327</a>                 String numberValue = readLineFromStream();
 
337
<a name="328" href="#328">328</a>                 <strong>if</strong> (numberValue == <strong>null</strong>) {
 
338
<a name="329" href="#329">329</a>                   <strong>throw</strong> <strong>new</strong> NumberFormatException(<span class="string">"unable to find chunk length"</span>);
 
339
<a name="330" href="#330">330</a>                 }
 
340
<a name="331" href="#331">331</a> 
 
341
<a name="332" href="#332">332</a>                 length = Integer.parseInt(numberValue.trim(), 16);
 
342
<a name="333" href="#333">333</a>             } <strong>catch</strong> (NumberFormatException e) {
 
343
<a name="334" href="#334">334</a>                 <em class="comment">// Critical error, unable to parse the chunk length</em>
 
344
<a name="335" href="#335">335</a>                 length = -1;
 
345
<a name="336" href="#336">336</a>                 chunk = false;
 
346
<a name="337" href="#337">337</a>                 endChunk = <strong>true</strong>;
 
347
<a name="338" href="#338">338</a>                 closed = <strong>true</strong>;
 
348
<a name="339" href="#339">339</a>                 <strong>return</strong> false;
 
349
<a name="340" href="#340">340</a>             }
 
350
<a name="341" href="#341">341</a> 
 
351
<a name="342" href="#342">342</a>             <strong>if</strong> (length == 0) {
 
352
<a name="343" href="#343">343</a> 
 
353
<a name="344" href="#344">344</a>                 <em class="comment">// Skipping trailing headers, if any</em>
 
354
<a name="345" href="#345">345</a>                 String trailingLine = readLineFromStream();
 
355
<a name="346" href="#346">346</a>                 <strong>while</strong> (!trailingLine.equals(<span class="string">""</span>)) {
 
356
<a name="347" href="#347">347</a>                     trailingLine = readLineFromStream();
 
357
<a name="348" href="#348">348</a>                 }
 
358
<a name="349" href="#349">349</a>                 endChunk = <strong>true</strong>;
 
359
<a name="350" href="#350">350</a>                 <strong>return</strong> false;
 
360
<a name="351" href="#351">351</a> 
 
361
<a name="352" href="#352">352</a>             } <strong>else</strong> {
 
362
<a name="353" href="#353">353</a> 
 
363
<a name="354" href="#354">354</a>                 <strong>if</strong> ((buffer == <strong>null</strong>) || (length > buffer.length)) {
 
364
<a name="355" href="#355">355</a>                     buffer = <strong>new</strong> byte[length];
 
365
<a name="356" href="#356">356</a>                 }
 
366
<a name="357" href="#357">357</a> 
 
367
<a name="358" href="#358">358</a>                 <em class="comment">// Now read the whole chunk into the buffer</em>
 
368
<a name="359" href="#359">359</a> 
 
369
<a name="360" href="#360">360</a>                 <strong>int</strong> nbRead = 0;
 
370
<a name="361" href="#361">361</a>                 <strong>int</strong> currentRead = 0;
 
371
<a name="362" href="#362">362</a> 
 
372
<a name="363" href="#363">363</a>                 <strong>while</strong> (nbRead &lt; length) {
 
373
<a name="364" href="#364">364</a>                     <strong>try</strong> {
 
374
<a name="365" href="#365">365</a>                         currentRead = stream.read(buffer, nbRead,
 
375
<a name="366" href="#366">366</a>                                         length - nbRead);
 
376
<a name="367" href="#367">367</a>                     } <strong>catch</strong> (Throwable t) {
 
377
<a name="368" href="#368">368</a>                         LOG.debug(<span class="string">"Exception thrown reading chunk from response"</span>, t);
 
378
<a name="369" href="#369">369</a>                         <strong>throw</strong> <strong>new</strong> IOException();
 
379
<a name="370" href="#370">370</a>                     }
 
380
<a name="371" href="#371">371</a>                     <strong>if</strong> (currentRead &lt; 0) {
 
381
<a name="372" href="#372">372</a>                         <strong>throw</strong> <strong>new</strong> IOException(<span class="string">"Not enough bytes read"</span>);
 
382
<a name="373" href="#373">373</a>                     }
 
383
<a name="374" href="#374">374</a>                     nbRead += currentRead;
 
384
<a name="375" href="#375">375</a>                 }
 
385
<a name="376" href="#376">376</a> 
 
386
<a name="377" href="#377">377</a>                 <em class="comment">// Skipping the CRLF</em>
 
387
<a name="378" href="#378">378</a>                 readLineFromStream();
 
388
<a name="379" href="#379">379</a> 
 
389
<a name="380" href="#380">380</a>             }
 
390
<a name="381" href="#381">381</a> 
 
391
<a name="382" href="#382">382</a>         } <strong>else</strong> { <em class="comment">//not using chunking</em>
 
392
<a name="383" href="#383">383</a> 
 
393
<a name="384" href="#384">384</a>             <strong>try</strong> {
 
394
<a name="385" href="#385">385</a>                 <strong>if</strong> (buffer == <strong>null</strong>) {
 
395
<a name="386" href="#386">386</a>                     buffer = <strong>new</strong> byte[4096];
 
396
<a name="387" href="#387">387</a>                 }
 
397
<a name="388" href="#388">388</a>                 length = stream.read(buffer);
 
398
<a name="389" href="#389">389</a>                 count += length;
 
399
<a name="390" href="#390">390</a>             } <strong>catch</strong> (Throwable t) {
 
400
<a name="391" href="#391">391</a>                 LOG.debug(<span class="string">"Exception thrown reading from response"</span>, t);
 
401
<a name="392" href="#392">392</a>                 <strong>throw</strong> <strong>new</strong> IOException(t.getMessage());
 
402
<a name="393" href="#393">393</a>             }
 
403
<a name="394" href="#394">394</a> 
 
404
<a name="395" href="#395">395</a>         }
 
405
<a name="396" href="#396">396</a> 
 
406
<a name="397" href="#397">397</a>         <strong>return</strong> <strong>true</strong>;
 
407
<a name="398" href="#398">398</a> 
 
408
<a name="399" href="#399">399</a>     }
 
409
<a name="400" href="#400">400</a> 
 
410
<a name="401" href="#401">401</a>     <em>/**<em>*</em></em>
 
411
<a name="402" href="#402">402</a> <em>     * Reads the input stream, one line at a time. Reads bytes into an array,</em>
 
412
<a name="403" href="#403">403</a> <em>     * until it reads a certain number of bytes or reaches a newline character,</em>
 
413
<a name="404" href="#404">404</a> <em>     * which it reads into the array as well.</em>
 
414
<a name="405" href="#405">405</a> <em>     *</em>
 
415
<a name="406" href="#406">406</a> <em>     * @return The line that was read, or &lt;code>null&lt;/code> if end-of-file</em>
 
416
<a name="407" href="#407">407</a> <em>     *  was encountered</em>
 
417
<a name="408" href="#408">408</a> <em>     * @exception IOException   if an input or output exception has occurred</em>
 
418
<a name="409" href="#409">409</a> <em>     *</em>
 
419
<a name="410" href="#410">410</a> <em>     * @deprecated Use ChunkedInputStream;</em>
 
420
<a name="411" href="#411">411</a> <em>     */</em>
 
421
<a name="412" href="#412">412</a>     <strong>private</strong> String readLineFromStream()
 
422
<a name="413" href="#413">413</a>     throws IOException {
 
423
<a name="414" href="#414">414</a>         LOG.trace(<span class="string">"enter ResponseInputStream.ReadLineFromStream()"</span>);
 
424
<a name="415" href="#415">415</a> 
 
425
<a name="416" href="#416">416</a>         StringBuffer sb = <strong>new</strong> StringBuffer();
 
426
<a name="417" href="#417">417</a>         <strong>while</strong> (<strong>true</strong>) {
 
427
<a name="418" href="#418">418</a>             <strong>int</strong> ch = stream.read();
 
428
<a name="419" href="#419">419</a>             <strong>if</strong> (ch &lt; 0) {
 
429
<a name="420" href="#420">420</a>                 <strong>if</strong> (sb.length() == 0) {
 
430
<a name="421" href="#421">421</a>                     <strong>return</strong> (<strong>null</strong>);
 
431
<a name="422" href="#422">422</a>                 } <strong>else</strong> {
 
432
<a name="423" href="#423">423</a>                     <strong>break</strong>;
 
433
<a name="424" href="#424">424</a>                 }
 
434
<a name="425" href="#425">425</a>             } <strong>else</strong> <strong>if</strong> (ch == '\r') {
 
435
<a name="426" href="#426">426</a>                 <strong>continue</strong>;
 
436
<a name="427" href="#427">427</a>             } <strong>else</strong> <strong>if</strong> (ch == '\n') {
 
437
<a name="428" href="#428">428</a>                 <strong>break</strong>;
 
438
<a name="429" href="#429">429</a>             }
 
439
<a name="430" href="#430">430</a>             sb.append((<strong>char</strong>) ch);
 
440
<a name="431" href="#431">431</a>         }
 
441
<a name="432" href="#432">432</a>         <strong>return</strong> (sb.toString());
 
442
<a name="433" href="#433">433</a>     }
 
443
<a name="434" href="#434">434</a> }
 
444
</pre>
 
445
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
 
446
</html>
 
447