~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/ChunkedOutputStream.java,v 1.10.2.1 2004/02/22 18:21:13 olegk Exp $

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

<a name="4" href="#4">4</a> * $Date: 2004/02/22 18:21:13 $

<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.IOException;

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

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

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

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

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

<a name="41" href="#41">41</a> * Wrapper supporting the chunked transfer encoding.

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

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

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

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

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

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

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

<a name="49" href="#49">49</a> * @version $Revision: 1.10.2.1 $ $Date: 2004/02/22 18:21:13 $

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

<a name="51" href="#51">51</a> * @see ChunkedInputStream

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

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

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

<a name="55" href="#55">55</a> public class <a href="../../../../org/apache/commons/httpclient/ChunkedOutputStream.html">ChunkedOutputStream</a> extends OutputStream {

<a name="57" href="#57">57</a> // ------------------------------------------------------- Static Variables

<a name="59" href="#59">59</a> /*** <tt>"\r\n"</tt>, as bytes. */

<a name="60" href="#60">60</a> private static final byte CRLF[] = new byte[] {(byte) 13, (byte) 10};

<a name="62" href="#62">62</a> /*** End chunk */

<a name="63" href="#63">63</a> private static final byte ENDCHUNK[] = CRLF;

<a name="65" href="#65">65</a> /*** 0 */

<a name="66" href="#66">66</a> private static final byte ZERO[] = new byte[] {(byte) '0'};

<a name="68" href="#68">68</a> /*** 1 */

<a name="69" href="#69">69</a> private static final byte ONE[] = new byte[] {(byte) '1'};

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

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

<a name="74" href="#74">74</a> // ----------------------------------------------------- Instance Variables

<a name="76" href="#76">76</a> /*** Has this stream been closed? */

<a name="77" href="#77">77</a> private boolean closed = false;

<a name="79" href="#79">79</a> /*** The underlying output stream to which we will write data */

<a name="80" href="#80">80</a> private OutputStream stream = null;

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

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

<a name="85" href="#85">85</a> * Construct an output stream wrapping the given stream.

<a name="86" href="#86">86</a> * The stream will not use chunking.

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

<a name="88" href="#88">88</a> * @param stream wrapped output stream. Must be non-null.

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

<a name="90" href="#90">90</a> public <a href="../../../../org/apache/commons/httpclient/ChunkedOutputStream.html">ChunkedOutputStream</a>(OutputStream stream) {

100

<a name="91" href="#91">91</a> if (stream == null) {

101

<a name="92" href="#92">92</a> throw new NullPointerException("stream parameter is null");

102

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

103

<a name="94" href="#94">94</a> this.stream = stream;

104

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

105

106

107

<a name="98" href="#98">98</a> // --------------------------------------------------------- Public Methods

108

109

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

110

<a name="101" href="#101">101</a> * Writes a <code>String</code> to the client, without a carriage return

111

<a name="102" href="#102">102</a> * line feed (CRLF) character at the end. The platform default encoding is

112

<a name="103" href="#103">103</a> * used!

113

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

114

<a name="105" href="#105">105</a> * @param s the <code>String</code> to send to the client. Must be non-null.

115

<a name="106" href="#106">106</a> * @throws IOException if an input or output exception occurred

116

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

117

<a name="108" href="#108">108</a> public void print(String s) throws IOException {

118

<a name="109" href="#109">109</a> LOG.trace("enter ChunckedOutputStream.print(String)");

119

<a name="110" href="#110">110</a> if (s == null) {

120

<a name="111" href="#111">111</a> s = "null";

121

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

122

<a name="113" href="#113">113</a> write(HttpConstants.getBytes(s));

123

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

124

125

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

126

<a name="117" href="#117">117</a> * Writes a carriage return-line feed (CRLF) to the client.

127

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

128

<a name="119" href="#119">119</a> * @throws IOException if an input or output exception occurred

129

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

130

<a name="121" href="#121">121</a> public void println() throws IOException {

131

<a name="122" href="#122">122</a> print("\r\n");

132

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

133

134

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

135

<a name="126" href="#126">126</a> * Writes a <code>String</code> to the client,

136

<a name="127" href="#127">127</a> * followed by a carriage return-line feed (CRLF).

137

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

138

<a name="129" href="#129">129</a> * @param s the </code>String</code> to write to the client

139

<a name="130" href="#130">130</a> * @exception IOException if an input or output exception occurred

140

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

141

<a name="132" href="#132">132</a> public void println(String s) throws IOException {

142

<a name="133" href="#133">133</a> print(s);

143

<a name="134" href="#134">134</a> println();

144

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

145

146

<a name="137" href="#137">137</a> // -------------------------------------------- OutputStream Methods

147

148

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

149

<a name="140" href="#140">140</a> * Write the specified byte to our output stream.

150

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

151

<a name="142" href="#142">142</a> * @param b The byte to be written

152

<a name="143" href="#143">143</a> * @throws IOException if an input/output error occurs

153

<a name="144" href="#144">144</a> * @throws IllegalStateException if stream already closed

154

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

155

<a name="146" href="#146">146</a> public void write (int b) throws IOException, IllegalStateException {

156

<a name="147" href="#147">147</a> if (closed) {

157

<a name="148" href="#148">148</a> throw new IllegalStateException("Output stream already closed");

158

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

159

<a name="150" href="#150">150</a> //FIXME: If using chunking, the chunks are ONE byte long!

160

<a name="151" href="#151">151</a> stream.write(ONE, 0, ONE.length);

161

<a name="152" href="#152">152</a> stream.write(CRLF, 0, CRLF.length);

162

<a name="153" href="#153">153</a> stream.write(b);

163

<a name="154" href="#154">154</a> stream.write(ENDCHUNK, 0, ENDCHUNK.length);

164

<a name="155" href="#155">155</a> LOG.debug("Writing chunk (length: 1)");

165

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

166

167

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

168

<a name="159" href="#159">159</a> * Write the specified byte array.

169

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

170

<a name="161" href="#161">161</a> * @param b the byte array to write out

171

<a name="162" href="#162">162</a> * @param off the offset within <code>b</code> to start writing from

172

<a name="163" href="#163">163</a> * @param len the length of data within <code>b</code> to write

173

<a name="164" href="#164">164</a> * @throws IOException when errors occur writing output

174

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

175

<a name="166" href="#166">166</a> public void write (byte[] b, int off, int len) throws IOException {

176

<a name="167" href="#167">167</a> LOG.trace("enter ChunckedOutputStream.write(byte[], int, int)");

177

178

<a name="169" href="#169">169</a> if (closed) {

179

<a name="170" href="#170">170</a> throw new IllegalStateException("Output stream already closed");

180

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

181

<a name="172" href="#172">172</a> byte chunkHeader[] = HttpConstants.getBytes (

182

<a name="173" href="#173">173</a> Integer.toHexString(len) + "\r\n");

183

<a name="174" href="#174">174</a> stream.write(chunkHeader, 0, chunkHeader.length);

184

<a name="175" href="#175">175</a> stream.write(b, off, len);

185

<a name="176" href="#176">176</a> stream.write(ENDCHUNK, 0, ENDCHUNK.length);

186

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

187

<a name="178" href="#178">178</a> LOG.debug("Writing chunk (length: " + len + ")");

188

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

189

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

190

191

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

192

<a name="183" href="#183">183</a> * Close this output stream, causing any buffered data to be flushed and

193

<a name="184" href="#184">184</a> * any further output data to throw an IOException. The underlying stream

194

<a name="185" href="#185">185</a> * is not closed!

195

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

196

<a name="187" href="#187">187</a> * @throws IOException if an error occurs closing the stream

197

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

198

<a name="189" href="#189">189</a> public void writeClosingChunk() throws IOException {

199

<a name="190" href="#190">190</a> LOG.trace("enter ChunkedOutputStream.writeClosingChunk()");

200

201

<a name="192" href="#192">192</a> if (!closed) {

202

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

203

<a name="194" href="#194">194</a> // Write the final chunk.

204

<a name="195" href="#195">195</a> stream.write(ZERO, 0, ZERO.length);

205

<a name="196" href="#196">196</a> stream.write(CRLF, 0, CRLF.length);

206

<a name="197" href="#197">197</a> stream.write(ENDCHUNK, 0, ENDCHUNK.length);

207

<a name="198" href="#198">198</a> LOG.debug("Writing closing chunk");

208

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

209

<a name="200" href="#200">200</a> LOG.debug("Unexpected exception caught when closing "

210

<a name="201" href="#201">201</a> + "output stream", e);

211

<a name="202" href="#202">202</a> throw e;

212

<a name="203" href="#203">203</a> } finally {

213

<a name="204" href="#204">204</a> // regardless of what happens, mark the stream as closed.

214

<a name="205" href="#205">205</a> // if there are errors closing it, there's not much we can do

215

<a name="206" href="#206">206</a> // about it

216

<a name="207" href="#207">207</a> closed = true;

217

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

218

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

219

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

220

221

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

222

<a name="213" href="#213">213</a> * Flushes the underlying stream.

223

<a name="214" href="#214">214</a> * @throws IOException If an IO problem occurs.

224

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

225

<a name="216" href="#216">216</a> public void flush() throws IOException {

226

<a name="217" href="#217">217</a> stream.flush();

227

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

228

229

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

230

<a name="221" href="#221">221</a> * Close this output stream, causing any buffered data to be flushed and

231

<a name="222" href="#222">222</a> * any further output data to throw an IOException. The underlying stream

232

<a name="223" href="#223">223</a> * is not closed!

233

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

234

<a name="225" href="#225">225</a> * @throws IOException if an error occurs closing the stream

235

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

236

<a name="227" href="#227">227</a> public void close() throws IOException {

237

<a name="228" href="#228">228</a> LOG.trace("enter ChunkedOutputStream.close()");

238

<a name="229" href="#229">229</a> writeClosingChunk();

239

<a name="230" href="#230">230</a> super.close();

240

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

241

242

243

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

244

</pre>

245

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

246

</html>

247

Older »