fileuploadbase.html

ava 项目中

<a name="147" href="#147">147</a> <em>     * HTTP content type header for multiple uploads.</em>
<a name="148" href="#148">148</a> <em>     */</em>
<a name="149" href="#149">149</a>     <strong>public</strong> <strong>static</strong> <strong>final</strong> String MULTIPART_MIXED = <span class="string">"multipart/mixed"</span>;
<a name="150" href="#150">150</a> 
<a name="151" href="#151">151</a> 
<a name="152" href="#152">152</a>     <em>/**</em>
<a name="153" href="#153">153</a> <em>     * The maximum length of a single header line that will be parsed</em>
<a name="154" href="#154">154</a> <em>     * (1024 bytes).</em>
<a name="155" href="#155">155</a> <em>     * @deprecated This constant is no longer used. As of commons-fileupload</em>
<a name="156" href="#156">156</a> <em>     *   1.2, the only applicable limit is the total size of a parts headers,</em>
<a name="157" href="#157">157</a> <em>     *   {@link MultipartStream#HEADER_PART_SIZE_MAX}.</em>
<a name="158" href="#158">158</a> <em>     */</em>
<a name="159" href="#159">159</a>     <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>int</strong> MAX_HEADER_SIZE = 1024;
<a name="160" href="#160">160</a> 
<a name="161" href="#161">161</a> 
<a name="162" href="#162">162</a>     <em class="comment">// ----------------------------------------------------------- Data members</em>
<a name="163" href="#163">163</a> 
<a name="164" href="#164">164</a> 
<a name="165" href="#165">165</a>     <em>/**</em>
<a name="166" href="#166">166</a> <em>     * The maximum size permitted for the complete request, as opposed to</em>
<a name="167" href="#167">167</a> <em>     * {@link #fileSizeMax}. A value of -1 indicates no maximum.</em>
<a name="168" href="#168">168</a> <em>     */</em>
<a name="169" href="#169">169</a>     <strong>private</strong> <strong>long</strong> sizeMax = -1;
<a name="170" href="#170">170</a> 
<a name="171" href="#171">171</a>     <em>/**</em>
<a name="172" href="#172">172</a> <em>     * The maximum size permitted for a single uploaded file, as opposed</em>
<a name="173" href="#173">173</a> <em>     * to {@link #sizeMax}. A value of -1 indicates no maximum.</em>
<a name="174" href="#174">174</a> <em>     */</em>
<a name="175" href="#175">175</a>     <strong>private</strong> <strong>long</strong> fileSizeMax = -1;
<a name="176" href="#176">176</a> 
<a name="177" href="#177">177</a>     <em>/**</em>
<a name="178" href="#178">178</a> <em>     * The content encoding to use when reading part headers.</em>
<a name="179" href="#179">179</a> <em>     */</em>
<a name="180" href="#180">180</a>     <strong>private</strong> String headerEncoding;
<a name="181" href="#181">181</a> 
<a name="182" href="#182">182</a>     <em>/**</em>
<a name="183" href="#183">183</a> <em>     * The progress listener.</em>
<a name="184" href="#184">184</a> <em>     */</em>
<a name="185" href="#185">185</a>     <strong>private</strong> <a href="../../../../org/apache/commons/fileupload/ProgressListener.html">ProgressListener</a> listener;
<a name="186" href="#186">186</a> 
<a name="187" href="#187">187</a>     <em class="comment">// ----------------------------------------------------- Property accessors</em>
<a name="188" href="#188">188</a> 
<a name="189" href="#189">189</a> 
<a name="190" href="#190">190</a>     <em>/**</em>
<a name="191" href="#191">191</a> <em>     * Returns the factory class used when creating file items.</em>
<a name="192" href="#192">192</a> <em>     *</em>
<a name="193" href="#193">193</a> <em>     * @return The factory class for new file items.</em>
<a name="194" href="#194">194</a> <em>     */</em>
<a name="195" href="#195">195</a>     <strong>public</strong> <strong>abstract</strong> <a href="../../../../org/apache/commons/fileupload/FileItemFactory.html">FileItemFactory</a> getFileItemFactory();
<a name="196" href="#196">196</a> 
<a name="197" href="#197">197</a> 
<a name="198" href="#198">198</a>     <em>/**</em>
<a name="199" href="#199">199</a> <em>     * Sets the factory class to use when creating file items.</em>
<a name="200" href="#200">200</a> <em>     *</em>
<a name="201" href="#201">201</a> <em>     * @param factory The factory class for new file items.</em>
<a name="202" href="#202">202</a> <em>     */</em>
<a name="203" href="#203">203</a>     <strong>public</strong> <strong>abstract</strong> <strong>void</strong> setFileItemFactory(<a href="../../../../org/apache/commons/fileupload/FileItemFactory.html">FileItemFactory</a> factory);
<a name="204" href="#204">204</a> 
<a name="205" href="#205">205</a> 
<a name="206" href="#206">206</a>     <em>/**</em>
<a name="207" href="#207">207</a> <em>     * Returns the maximum allowed size of a complete request, as opposed</em>
<a name="208" href="#208">208</a> <em>     * to {@link #getFileSizeMax()}.</em>
<a name="209" href="#209">209</a> <em>     *</em>
<a name="210" href="#210">210</a> <em>     * @return The maximum allowed size, in bytes. The default value of</em>
<a name="211" href="#211">211</a> <em>     *   -1 indicates, that there is no limit.</em>
<a name="212" href="#212">212</a> <em>     *</em>
<a name="213" href="#213">213</a> <em>     * @see #setSizeMax(long)</em>
<a name="214" href="#214">214</a> <em>     *</em>
<a name="215" href="#215">215</a> <em>     */</em>
<a name="216" href="#216">216</a>     <strong>public</strong> <strong>long</strong> getSizeMax() {
<a name="217" href="#217">217</a>         <strong>return</strong> sizeMax;
<a name="218" href="#218">218</a>     }
<a name="219" href="#219">219</a> 
<a name="220" href="#220">220</a> 
<a name="221" href="#221">221</a>     <em>/**</em>
<a name="222" href="#222">222</a> <em>     * Sets the maximum allowed size of a complete request, as opposed</em>
<a name="223" href="#223">223</a> <em>     * to {@link #setFileSizeMax(long)}.</em>
<a name="224" href="#224">224</a> <em>     *</em>
<a name="225" href="#225">225</a> <em>     * @param sizeMax The maximum allowed size, in bytes. The default value of</em>
<a name="226" href="#226">226</a> <em>     *   -1 indicates, that there is no limit.</em>
<a name="227" href="#227">227</a> <em>     *</em>
<a name="228" href="#228">228</a> <em>     * @see #getSizeMax()</em>
<a name="229" href="#229">229</a> <em>     *</em>
<a name="230" href="#230">230</a> <em>     */</em>
<a name="231" href="#231">231</a>     <strong>public</strong> <strong>void</strong> setSizeMax(<strong>long</strong> sizeMax) {
<a name="232" href="#232">232</a>         <strong>this</strong>.sizeMax = sizeMax;
<a name="233" href="#233">233</a>     }
<a name="234" href="#234">234</a> 
<a name="235" href="#235">235</a>     <em>/**</em>
<a name="236" href="#236">236</a> <em>     * Returns the maximum allowed size of a single uploaded file,</em>
<a name="237" href="#237">237</a> <em>     * as opposed to {@link #getSizeMax()}.</em>
<a name="238" href="#238">238</a> <em>     *</em>
<a name="239" href="#239">239</a> <em>     * @see #setFileSizeMax(long)</em>
<a name="240" href="#240">240</a> <em>     * @return Maximum size of a single uploaded file.</em>
<a name="241" href="#241">241</a> <em>     */</em>
<a name="242" href="#242">242</a>     <strong>public</strong> <strong>long</strong> getFileSizeMax() {
<a name="243" href="#243">243</a>         <strong>return</strong> fileSizeMax;
<a name="244" href="#244">244</a>     }
<a name="245" href="#245">245</a> 
<a name="246" href="#246">246</a>     <em>/**</em>
<a name="247" href="#247">247</a> <em>     * Sets the maximum allowed size of a single uploaded file,</em>
<a name="248" href="#248">248</a> <em>     * as opposed to {@link #getSizeMax()}.</em>
<a name="249" href="#249">249</a> <em>     *</em>
<a name="250" href="#250">250</a> <em>     * @see #getFileSizeMax()</em>
<a name="251" href="#251">251</a> <em>     * @param fileSizeMax Maximum size of a single uploaded file.</em>
<a name="252" href="#252">252</a> <em>     */</em>
<a name="253" href="#253">253</a>     <strong>public</strong> <strong>void</strong> setFileSizeMax(<strong>long</strong> fileSizeMax) {
<a name="254" href="#254">254</a>         <strong>this</strong>.fileSizeMax = fileSizeMax;
<a name="255" href="#255">255</a>     }
<a name="256" href="#256">256</a> 
<a name="257" href="#257">257</a>     <em>/**</em>
<a name="258" href="#258">258</a> <em>     * Retrieves the character encoding used when reading the headers of an</em>
<a name="259" href="#259">259</a> <em>     * individual part. When not specified, or &lt;code>null&lt;/code>, the request</em>
<a name="260" href="#260">260</a> <em>     * encoding is used. If that is also not specified, or &lt;code>null&lt;/code>,</em>
<a name="261" href="#261">261</a> <em>     * the platform default encoding is used.</em>
<a name="262" href="#262">262</a> <em>     *</em>
<a name="263" href="#263">263</a> <em>     * @return The encoding used to read part headers.</em>
<a name="264" href="#264">264</a> <em>     */</em>
<a name="265" href="#265">265</a>     <strong>public</strong> String getHeaderEncoding() {
<a name="266" href="#266">266</a>         <strong>return</strong> headerEncoding;
<a name="267" href="#267">267</a>     }
<a name="268" href="#268">268</a> 
<a name="269" href="#269">269</a> 
<a name="270" href="#270">270</a>     <em>/**</em>
<a name="271" href="#271">271</a> <em>     * Specifies the character encoding to be used when reading the headers of</em>
<a name="272" href="#272">272</a> <em>     * individual part. When not specified, or &lt;code>null&lt;/code>, the request</em>
<a name="273" href="#273">273</a> <em>     * encoding is used. If that is also not specified, or &lt;code>null&lt;/code>,</em>
<a name="274" href="#274">274</a> <em>     * the platform default encoding is used.</em>
<a name="275" href="#275">275</a> <em>     *</em>
<a name="276" href="#276">276</a> <em>     * @param encoding The encoding used to read part headers.</em>
<a name="277" href="#277">277</a> <em>     */</em>
<a name="278" href="#278">278</a>     <strong>public</strong> <strong>void</strong> setHeaderEncoding(String encoding) {
<a name="279" href="#279">279</a>         headerEncoding = encoding;
<a name="280" href="#280">280</a>     }
<a name="281" href="#281">281</a> 
<a name="282" href="#282">282</a> 
<a name="283" href="#283">283</a>     <em class="comment">// --------------------------------------------------------- Public methods</em>
<a name="284" href="#284">284</a> 
<a name="285" href="#285">285</a> 
<a name="286" href="#286">286</a>     <em>/**</em>
<a name="287" href="#287">287</a> <em>     * Processes an &lt;a href="<a href="http://www.ietf.org/rfc/rfc1867.txt" target="alexandria_uri">http://www.ietf.org/rfc/rfc1867.txt</a>">RFC 1867&lt;/a></em>
<a name="288" href="#288">288</a> <em>     * compliant &lt;code>multipart/form-data&lt;/code> stream.</em>
<a name="289" href="#289">289</a> <em>     *</em>
<a name="290" href="#290">290</a> <em>     * @param req The servlet request to be parsed.</em>
<a name="291" href="#291">291</a> <em>     *</em>
<a name="292" href="#292">292</a> <em>     * @return A list of &lt;code>FileItem&lt;/code> instances parsed from the</em>
<a name="293" href="#293">293</a> <em>     *         request, in the order that they were transmitted.</em>
<a name="294" href="#294">294</a> <em>     *</em>
<a name="295" href="#295">295</a> <em>     * @throws FileUploadException if there are problems reading/parsing</em>
<a name="296" href="#296">296</a> <em>     *                             the request or storing files.</em>
<a name="297" href="#297">297</a> <em>     *</em>
<a name="298" href="#298">298</a> <em>     * @deprecated Use the method in &lt;code>ServletFileUpload&lt;/code> instead.</em>
<a name="299" href="#299">299</a> <em>     */</em>
<a name="300" href="#300">300</a>     <strong>public</strong> List <em class="comment">/*<em class="comment"> <a href="../../../../org/apache/commons/fileupload/FileItem.html">FileItem</a> */</em> parseRequest(HttpServletRequest req)</em>
<a name="301" href="#301">301</a>     throws <a href="../../../../org/apache/commons/fileupload/FileUploadException.html">FileUploadException</a> {