📄 multipartstream.html
字号:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head><meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>MultipartStream xref</title><link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /></head><body><div id="overview"><a href="../../../../../apidocs/org/apache/commons/fileupload/MultipartStream.html">View Javadoc</a></div><pre><a name="1" href="#1">1</a> <em class="comment">/*</em><a name="2" href="#2">2</a> <em class="comment"> * Copyright 2001-2005 The Apache Software Foundation</em><a name="3" href="#3">3</a> <em class="comment"> *</em><a name="4" href="#4">4</a> <em class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em><a name="5" href="#5">5</a> <em class="comment"> * you may not use this file except in compliance with the License.</em><a name="6" href="#6">6</a> <em class="comment"> * You may obtain a copy of the License at</em><a name="7" href="#7">7</a> <em class="comment"> *</em><a name="8" href="#8">8</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><a name="9" href="#9">9</a> <em class="comment"> *</em><a name="10" href="#10">10</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em><a name="11" href="#11">11</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em><a name="12" href="#12">12</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em><a name="13" href="#13">13</a> <em class="comment"> * See the License for the specific language governing permissions and</em><a name="14" href="#14">14</a> <em class="comment"> * limitations under the License.</em><a name="15" href="#15">15</a> <em class="comment"> */</em><a name="16" href="#16">16</a> <strong>package</strong> <a href="../../../../org/apache/commons/fileupload/package-summary.html">org.apache.commons.fileupload</a>;<a name="17" href="#17">17</a> <a name="18" href="#18">18</a> <strong>import</strong> java.io.ByteArrayOutputStream;<a name="19" href="#19">19</a> <strong>import</strong> java.io.IOException;<a name="20" href="#20">20</a> <strong>import</strong> java.io.InputStream;<a name="21" href="#21">21</a> <strong>import</strong> java.io.OutputStream;<a name="22" href="#22">22</a> <strong>import</strong> java.io.UnsupportedEncodingException;<a name="23" href="#23">23</a> <a name="24" href="#24">24</a> <em>/**<em>*</em></em><a name="25" href="#25">25</a> <em> * <p> Low level API for processing file uploads.</em><a name="26" href="#26">26</a> <em> *</em><a name="27" href="#27">27</a> <em> * <p> This class can be used to process data streams conforming to MIME</em><a name="28" href="#28">28</a> <em> * 'multipart' format as defined in</em><a name="29" href="#29">29</a> <em> * <a href="<a href="http://www.ietf.org/rfc/rfc1867.txt" target="alexandria_uri">http://www.ietf.org/rfc/rfc1867.txt</a>">RFC 1867</a>. Arbitrarily</em><a name="30" href="#30">30</a> <em> * large amounts of data in the stream can be processed under constant</em><a name="31" href="#31">31</a> <em> * memory usage.</em><a name="32" href="#32">32</a> <em> *</em><a name="33" href="#33">33</a> <em> * <p> The format of the stream is defined in the following way:<br></em><a name="34" href="#34">34</a> <em> *</em><a name="35" href="#35">35</a> <em> * <code></em><a name="36" href="#36">36</a> <em> * multipart-body := preamble 1*encapsulation close-delimiter epilogue<br></em><a name="37" href="#37">37</a> <em> * encapsulation := delimiter body CRLF<br></em><a name="38" href="#38">38</a> <em> * delimiter := "--" boundary CRLF<br></em><a name="39" href="#39">39</a> <em> * close-delimiter := "--" boudary "--"<br></em><a name="40" href="#40">40</a> <em> * preamble := &lt;ignore&gt;<br></em><a name="41" href="#41">41</a> <em> * epilogue := &lt;ignore&gt;<br></em><a name="42" href="#42">42</a> <em> * body := header-part CRLF body-part<br></em><a name="43" href="#43">43</a> <em> * header-part := 1*header CRLF<br></em><a name="44" href="#44">44</a> <em> * header := header-name ":" header-value<br></em><a name="45" href="#45">45</a> <em> * header-name := &lt;printable ascii characters except ":"&gt;<br></em><a name="46" href="#46">46</a> <em> * header-value := &lt;any ascii characters except CR & LF&gt;<br></em><a name="47" href="#47">47</a> <em> * body-data := &lt;arbitrary data&gt;<br></em><a name="48" href="#48">48</a> <em> * </code></em><a name="49" href="#49">49</a> <em> *</em><a name="50" href="#50">50</a> <em> * <p>Note that body-data can contain another mulipart entity. There</em><a name="51" href="#51">51</a> <em> * is limited support for single pass processing of such nested</em><a name="52" href="#52">52</a> <em> * streams. The nested stream is <strong>required</strong> to have a</em><a name="53" href="#53">53</a> <em> * boundary token of the same length as the parent stream (see {@link</em><a name="54" href="#54">54</a> <em> * #setBoundary(byte[])}).</em><a name="55" href="#55">55</a> <em> *</em><a name="56" href="#56">56</a> <em> * <p>Here is an example of usage of this class.<br></em><a name="57" href="#57">57</a> <em> *</em><a name="58" href="#58">58</a> <em> * <pre></em><a name="59" href="#59">59</a> <em> * try {</em><a name="60" href="#60">60</a> <em> * MultipartStream multipartStream = new MultipartStream(input,</em><a name="61" href="#61">61</a> <em> * boundary);</em><a name="62" href="#62">62</a> <em> * boolean nextPart = multipartStream.skipPreamble();</em><a name="63" href="#63">63</a> <em> * OutputStream output;</em><a name="64" href="#64">64</a> <em> * while(nextPart) {</em><a name="65" href="#65">65</a> <em> * header = chunks.readHeader();</em><a name="66" href="#66">66</a> <em> * // process headers</em><a name="67" href="#67">67</a> <em> * // create some output stream</em><a name="68" href="#68">68</a> <em> * multipartStream.readBodyPart(output);</em><a name="69" href="#69">69</a> <em> * nextPart = multipartStream.readBoundary();</em><a name="70" href="#70">70</a> <em> * }</em><a name="71" href="#71">71</a> <em> * } catch(MultipartStream.MalformedStreamException e) {</em><a name="72" href="#72">72</a> <em> * // the stream failed to follow required syntax</em><a name="73" href="#73">73</a> <em> * } catch(IOException) {</em><a name="74" href="#74">74</a> <em> * // a read or write error occurred</em><a name="75" href="#75">75</a> <em> * }</em><a name="76" href="#76">76</a> <em> *</em><a name="77" href="#77">77</a> <em> * </pre></em><a name="78" href="#78">78</a> <em> *</em><a name="79" href="#79">79</a> <em> * @author <a href="<a href="mailto:Rafal.Krzewski@e-point.pl" target="alexandria_uri">mailto:Rafal.Krzewski@e-point.pl</a>">Rafal Krzewski</a></em><a name="80" href="#80">80</a> <em> * @author <a href="<a href="mailto:martinc@apache.org" target="alexandria_uri">mailto:martinc@apache.org</a>">Martin Cooper</a></em><a name="81" href="#81">81</a> <em> * @author Sean C. Sullivan</em><a name="82" href="#82">82</a> <em> *</em><a name="83" href="#83">83</a> <em> * @version $Id: MultipartStream.java 353822 2005-12-04 06:33:55Z martinc $</em><a name="84" href="#84">84</a> <em> */</em><a name="85" href="#85">85</a> <strong>public</strong> <strong>class</strong> <a href="../../../../org/apache/commons/fileupload/MultipartStream.html">MultipartStream</a> {<a name="86" href="#86">86</a> <a name="87" href="#87">87</a> <em class="comment">// ----------------------------------------------------- Manifest constants</em><a name="88" href="#88">88</a> <a name="89" href="#89">89</a> <a name="90" href="#90">90</a> <em>/**<em>*</em></em><a name="91" href="#91">91</a> <em> * The Carriage Return ASCII character value.</em><a name="92" href="#92">92</a> <em> */</em><a name="93" href="#93">93</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> byte CR = 0x0D;<a name="94" href="#94">94</a> <a name="95" href="#95">95</a> <a name="96" href="#96">96</a> <em>/**<em>*</em></em><a name="97" href="#97">97</a> <em> * The Line Feed ASCII character value.</em><a name="98" href="#98">98</a> <em> */</em><a name="99" href="#99">99</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> byte LF = 0x0A;<a name="100" href="#100">100</a> <a name="101" href="#101">101</a> <a name="102" href="#102">102</a> <em>/**<em>*</em></em><a name="103" href="#103">103</a> <em> * The dash (-) ASCII character value.</em><a name="104" href="#104">104</a> <em> */</em><a name="105" href="#105">105</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> byte DASH = 0x2D;<a name="106" href="#106">106</a> <a name="107" href="#107">107</a> <a name="108" href="#108">108</a> <em>/**<em>*</em></em><a name="109" href="#109">109</a> <em> * The maximum length of <code>header-part</code> that will be</em><a name="110" href="#110">110</a> <em> * processed (10 kilobytes = 10240 bytes.).</em><a name="111" href="#111">111</a> <em> */</em><a name="112" href="#112">112</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>int</strong> HEADER_PART_SIZE_MAX = 10240;<a name="113" href="#113">113</a> <a name="114" href="#114">114</a> <a name="115" href="#115">115</a> <em>/**<em>*</em></em><a name="116" href="#116">116</a> <em> * The default length of the buffer used for processing a request.</em><a name="117" href="#117">117</a> <em> */</em><a name="118" href="#118">118</a> <strong>protected</strong> <strong>static</strong> <strong>final</strong> <strong>int</strong> DEFAULT_BUFSIZE = 4096;<a name="119" href="#119">119</a> <a name="120" href="#120">120</a> <a name="121" href="#121">121</a> <em>/**<em>*</em></em><a name="122" href="#122">122</a> <em> * A byte sequence that marks the end of <code>header-part</code></em><a name="123" href="#123">123</a> <em> * (<code>CRLFCRLF</code>).</em><a name="124" href="#124">124</a> <em> */</em><a name="125" href="#125">125</a> <strong>protected</strong> <strong>static</strong> <strong>final</strong> byte[] HEADER_SEPARATOR = {<a name="126" href="#126">126</a> CR, LF, CR, LF };<a name="127" href="#127">127</a> <a name="128" href="#128">128</a> <a name="129" href="#129">129</a> <em>/**<em>*</em></em><a name="130" href="#130">130</a> <em> * A byte sequence that that follows a delimiter that will be</em><a name="131" href="#131">131</a> <em> * followed by an encapsulation (<code>CRLF</code>).</em><a name="132" href="#132">132</a> <em> */</em><a name="133" href="#133">133</a> <strong>protected</strong> <strong>static</strong> <strong>final</strong> byte[] FIELD_SEPARATOR = {<a name="134" href="#134">134</a> CR, LF};<a name="135" href="#135">135</a> <a name="136" href="#136">136</a> <a name="137" href="#137">137</a> <em>/**<em>*</em></em><a name="138" href="#138">138</a> <em> * A byte sequence that that follows a delimiter of the last</em><a name="139" href="#139">139</a> <em> * encapsulation in the stream (<code>--</code>).</em><a name="140" href="#140">140</a> <em> */</em><a name="141" href="#141">141</a> <strong>protected</strong> <strong>static</strong> <strong>final</strong> byte[] STREAM_TERMINATOR = {<a name="142" href="#142">142</a> DASH, DASH};<a name="143" href="#143">143</a> <a name="144" href="#144">144</a> <a name="145" href="#145">145</a> <em>/**<em>*</em></em><a name="146" href="#146">146</a> <em> * A byte sequence that precedes a boundary (<code>CRLF--</code>).</em><a name="147" href="#147">147</a> <em> */</em><a name="148" href="#148">148</a> <strong>protected</strong> <strong>static</strong> <strong>final</strong> byte[] BOUNDARY_PREFIX = {<a name="149" href="#149">149</a> CR, LF, DASH, DASH};<a name="150" href="#150">150</a> <a name="151" href="#151">151</a> <a name="152" href="#152">152</a> <em>/**<em>*</em></em><a name="153" href="#153">153</a> <em> * The number of bytes, over and above the boundary size, to use for the</em><a name="154" href="#154">154</a> <em> * keep region.</em><a name="155" href="#155">155</a> <em> */</em><a name="156" href="#156">156</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>int</strong> KEEP_REGION_PAD = 3;<a name="157" href="#157">157</a> <a name="158" href="#158">158</a> <a name="159" href="#159">159</a> <em class="comment">// ----------------------------------------------------------- Data members</em>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -