Modified: websites/production/commons/content/proper/commons-fileupload/xref/org/apache/commons/fileupload/disk/DiskFileItem.html ============================================================================== --- websites/production/commons/content/proper/commons-fileupload/xref/org/apache/commons/fileupload/disk/DiskFileItem.html (original) +++ websites/production/commons/content/proper/commons-fileupload/xref/org/apache/commons/fileupload/disk/DiskFileItem.html Wed Jan 16 11:35:52 2019 @@ -160,458 +160,498 @@ <a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> */</em> <a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/commons/fileupload/FileItemHeaders.html">FileItemHeaders</a> headers; <a class="jxr_linenumber" name="L154" href="#L154">154</a> -<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_comment">// ----------------------------------------------------------- Constructors</em> -<a class="jxr_linenumber" name="L156" href="#L156">156</a> -<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * Constructs a new <code>DiskFileItem</code> instance.</em> -<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * @param fieldName The name of the form field.</em> -<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * @param contentType The content type passed by the browser or</em> -<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * <code>null</code> if not specified.</em> -<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * @param isFormField Whether or not this item is a plain form field, as</em> -<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * opposed to a file upload.</em> -<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * @param fileName The original filename in the user's filesystem, or</em> -<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * <code>null</code> if not specified.</em> -<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * @param sizeThreshold The threshold, in bytes, below which items will be</em> -<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * retained in memory and above which they will be</em> -<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * stored as a file.</em> -<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * @param repository The data repository, which is the directory in</em> -<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * which files will be created, should the item size</em> -<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> * exceed the threshold.</em> -<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/commons/fileupload/disk/DiskFileItem.html">DiskFileItem</a>(String fieldName, -<a class="jxr_linenumber" name="L175" href="#L175">175</a> String contentType, <strong class="jxr_keyword">boolean</strong> isFormField, String fileName, -<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">int</strong> sizeThreshold, File repository) { -<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">this</strong>.fieldName = fieldName; -<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">this</strong>.contentType = contentType; -<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">this</strong>.isFormField = isFormField; -<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">this</strong>.fileName = fileName; -<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">this</strong>.sizeThreshold = sizeThreshold; -<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">this</strong>.repository = repository; -<a class="jxr_linenumber" name="L183" href="#L183">183</a> } -<a class="jxr_linenumber" name="L184" href="#L184">184</a> -<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_comment">// ------------------------------- Methods from javax.activation.DataSource</em> -<a class="jxr_linenumber" name="L186" href="#L186">186</a> -<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * Returns an {@link java.io.InputStream InputStream} that can be</em> -<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * used to retrieve the contents of the file.</em> -<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * @return An {@link java.io.InputStream InputStream} that can be</em> -<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * used to retrieve the contents of the file.</em> -<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * @throws IOException if an error occurs.</em> -<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L196" href="#L196">196</a> <strong class="jxr_keyword">public</strong> InputStream getInputStream() -<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">throws</strong> IOException { -<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">if</strong> (!isInMemory()) { -<a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> FileInputStream(dfos.getFile()); -<a class="jxr_linenumber" name="L200" href="#L200">200</a> } -<a class="jxr_linenumber" name="L201" href="#L201">201</a> -<a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">if</strong> (cachedContent == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L203" href="#L203">203</a> cachedContent = dfos.getData(); -<a class="jxr_linenumber" name="L204" href="#L204">204</a> } -<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> ByteArrayInputStream(cachedContent); -<a class="jxr_linenumber" name="L206" href="#L206">206</a> } -<a class="jxr_linenumber" name="L207" href="#L207">207</a> -<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> * Returns the content type passed by the agent or <code>null</code> if</em> -<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> * not defined.</em> -<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> * @return The content type passed by the agent or <code>null</code> if</em> -<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> * not defined.</em> -<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L215" href="#L215">215</a> <strong class="jxr_keyword">public</strong> String getContentType() { -<a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">return</strong> contentType; -<a class="jxr_linenumber" name="L217" href="#L217">217</a> } -<a class="jxr_linenumber" name="L218" href="#L218">218</a> -<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> * Returns the content charset passed by the agent or <code>null</code> if</em> -<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> * not defined.</em> -<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> * @return The content charset passed by the agent or <code>null</code> if</em> -<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment"> * not defined.</em> -<a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong class="jxr_keyword">public</strong> String getCharSet() { -<a class="jxr_linenumber" name="L227" href="#L227">227</a> <a href="../../../../../org/apache/commons/fileupload/ParameterParser.html">ParameterParser</a> parser = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/commons/fileupload/ParameterParser.html">ParameterParser</a>(); -<a class="jxr_linenumber" name="L228" href="#L228">228</a> parser.setLowerCaseNames(<strong class="jxr_keyword">true</strong>); -<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_comment">// Parameter parser can handle null input</em> -<a class="jxr_linenumber" name="L230" href="#L230">230</a> Map<String, String> params = parser.parse(getContentType(), ';'); -<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">return</strong> params.get(<span class="jxr_string">"charset"</span>); -<a class="jxr_linenumber" name="L232" href="#L232">232</a> } -<a class="jxr_linenumber" name="L233" href="#L233">233</a> -<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment"> * Returns the original filename in the client's filesystem.</em> -<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment"> * @return The original filename in the client's filesystem.</em> -<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * @throws org.apache.commons.fileupload.InvalidFileNameException The file name contains a NUL character,</em> -<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> * which might be an indicator of a security attack. If you intend to</em> -<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> * use the file name anyways, catch the exception and use</em> -<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> * {@link org.apache.commons.fileupload.InvalidFileNameException#getName()}.</em> -<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">public</strong> String getName() { -<a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">return</strong> Streams.checkFileName(fileName); -<a class="jxr_linenumber" name="L245" href="#L245">245</a> } -<a class="jxr_linenumber" name="L246" href="#L246">246</a> -<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_comment">// ------------------------------------------------------- FileItem methods</em> -<a class="jxr_linenumber" name="L248" href="#L248">248</a> -<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment"> * Provides a hint as to whether or not the file contents will be read</em> -<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment"> * from memory.</em> -<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the file contents will be read</em> -<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment"> * from memory; <code>false</code> otherwise.</em> -<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L256" href="#L256">256</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isInMemory() { -<a class="jxr_linenumber" name="L257" href="#L257">257</a> <strong class="jxr_keyword">if</strong> (cachedContent != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; -<a class="jxr_linenumber" name="L259" href="#L259">259</a> } -<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">return</strong> dfos.isInMemory(); -<a class="jxr_linenumber" name="L261" href="#L261">261</a> } -<a class="jxr_linenumber" name="L262" href="#L262">262</a> -<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> * Returns the size of the file.</em> -<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> * @return The size of the file, in bytes.</em> -<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> getSize() { -<a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong class="jxr_keyword">if</strong> (size >= 0) { -<a class="jxr_linenumber" name="L270" href="#L270">270</a> <strong class="jxr_keyword">return</strong> size; -<a class="jxr_linenumber" name="L271" href="#L271">271</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (cachedContent != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">return</strong> cachedContent.length; -<a class="jxr_linenumber" name="L273" href="#L273">273</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (dfos.isInMemory()) { -<a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong class="jxr_keyword">return</strong> dfos.getData().length; -<a class="jxr_linenumber" name="L275" href="#L275">275</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L276" href="#L276">276</a> <strong class="jxr_keyword">return</strong> dfos.getFile().length(); -<a class="jxr_linenumber" name="L277" href="#L277">277</a> } -<a class="jxr_linenumber" name="L278" href="#L278">278</a> } -<a class="jxr_linenumber" name="L279" href="#L279">279</a> -<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_javadoccomment"> * Returns the contents of the file as an array of bytes. If the</em> -<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_javadoccomment"> * contents of the file were not yet cached in memory, they will be</em> -<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment"> * loaded from the disk storage and cached.</em> -<a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> * @return The contents of the file as an array of bytes</em> -<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> * or {@code null} if the data cannot be read</em> -<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L288" href="#L288">288</a> <strong class="jxr_keyword">public</strong> byte[] get() { -<a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong class="jxr_keyword">if</strong> (isInMemory()) { -<a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">if</strong> (cachedContent == <strong class="jxr_keyword">null</strong> && dfos != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L291" href="#L291">291</a> cachedContent = dfos.getData(); -<a class="jxr_linenumber" name="L292" href="#L292">292</a> } -<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">return</strong> cachedContent; -<a class="jxr_linenumber" name="L294" href="#L294">294</a> } -<a class="jxr_linenumber" name="L295" href="#L295">295</a> -<a class="jxr_linenumber" name="L296" href="#L296">296</a> byte[] fileData = <strong class="jxr_keyword">new</strong> byte[(<strong class="jxr_keyword">int</strong>) getSize()]; -<a class="jxr_linenumber" name="L297" href="#L297">297</a> InputStream fis = <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L298" href="#L298">298</a> -<a class="jxr_linenumber" name="L299" href="#L299">299</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L300" href="#L300">300</a> fis = <strong class="jxr_keyword">new</strong> FileInputStream(dfos.getFile()); -<a class="jxr_linenumber" name="L301" href="#L301">301</a> IOUtils.readFully(fis, fileData); -<a class="jxr_linenumber" name="L302" href="#L302">302</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { -<a class="jxr_linenumber" name="L303" href="#L303">303</a> fileData = <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L304" href="#L304">304</a> } <strong class="jxr_keyword">finally</strong> { -<a class="jxr_linenumber" name="L305" href="#L305">305</a> IOUtils.closeQuietly(fis); +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * Default content charset to be used when no explicit charset</em> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * parameter is provided by the sender.</em> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">private</strong> String defaultCharset = DEFAULT_CHARSET; +<a class="jxr_linenumber" name="L160" href="#L160">160</a> +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_comment">// ----------------------------------------------------------- Constructors</em> +<a class="jxr_linenumber" name="L162" href="#L162">162</a> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * Constructs a new <code>DiskFileItem</code> instance.</em> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * @param fieldName The name of the form field.</em> +<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * @param contentType The content type passed by the browser or</em> +<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * <code>null</code> if not specified.</em> +<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * @param isFormField Whether or not this item is a plain form field, as</em> +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * opposed to a file upload.</em> +<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * @param fileName The original filename in the user's filesystem, or</em> +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> * <code>null</code> if not specified.</em> +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> * @param sizeThreshold The threshold, in bytes, below which items will be</em> +<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * retained in memory and above which they will be</em> +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * stored as a file.</em> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * @param repository The data repository, which is the directory in</em> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * which files will be created, should the item size</em> +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * exceed the threshold.</em> +<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/commons/fileupload/disk/DiskFileItem.html">DiskFileItem</a>(String fieldName, +<a class="jxr_linenumber" name="L181" href="#L181">181</a> String contentType, <strong class="jxr_keyword">boolean</strong> isFormField, String fileName, +<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">int</strong> sizeThreshold, File repository) { +<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">this</strong>.fieldName = fieldName; +<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">this</strong>.contentType = contentType; +<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">this</strong>.isFormField = isFormField; +<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">this</strong>.fileName = fileName; +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">this</strong>.sizeThreshold = sizeThreshold; +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">this</strong>.repository = repository; +<a class="jxr_linenumber" name="L189" href="#L189">189</a> } +<a class="jxr_linenumber" name="L190" href="#L190">190</a> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_comment">// ------------------------------- Methods from javax.activation.DataSource</em> +<a class="jxr_linenumber" name="L192" href="#L192">192</a> +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * Returns an {@link java.io.InputStream InputStream} that can be</em> +<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> * used to retrieve the contents of the file.</em> +<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> * @return An {@link java.io.InputStream InputStream} that can be</em> +<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * used to retrieve the contents of the file.</em> +<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * @throws IOException if an error occurs.</em> +<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L202" href="#L202">202</a> @Override +<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">public</strong> InputStream getInputStream() +<a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">if</strong> (!isInMemory()) { +<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> FileInputStream(dfos.getFile()); +<a class="jxr_linenumber" name="L207" href="#L207">207</a> } +<a class="jxr_linenumber" name="L208" href="#L208">208</a> +<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">if</strong> (cachedContent == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L210" href="#L210">210</a> cachedContent = dfos.getData(); +<a class="jxr_linenumber" name="L211" href="#L211">211</a> } +<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> ByteArrayInputStream(cachedContent); +<a class="jxr_linenumber" name="L213" href="#L213">213</a> } +<a class="jxr_linenumber" name="L214" href="#L214">214</a> +<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * Returns the content type passed by the agent or <code>null</code> if</em> +<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> * not defined.</em> +<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment"> * @return The content type passed by the agent or <code>null</code> if</em> +<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> * not defined.</em> +<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L222" href="#L222">222</a> @Override +<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">public</strong> String getContentType() { +<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">return</strong> contentType; +<a class="jxr_linenumber" name="L225" href="#L225">225</a> } +<a class="jxr_linenumber" name="L226" href="#L226">226</a> +<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment"> * Returns the content charset passed by the agent or <code>null</code> if</em> +<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment"> * not defined.</em> +<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> * @return The content charset passed by the agent or <code>null</code> if</em> +<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment"> * not defined.</em> +<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L234" href="#L234">234</a> <strong class="jxr_keyword">public</strong> String getCharSet() { +<a class="jxr_linenumber" name="L235" href="#L235">235</a> <a href="../../../../../org/apache/commons/fileupload/ParameterParser.html">ParameterParser</a> parser = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/commons/fileupload/ParameterParser.html">ParameterParser</a>(); +<a class="jxr_linenumber" name="L236" href="#L236">236</a> parser.setLowerCaseNames(<strong class="jxr_keyword">true</strong>); +<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_comment">// Parameter parser can handle null input</em> +<a class="jxr_linenumber" name="L238" href="#L238">238</a> Map<String, String> params = parser.parse(getContentType(), ';'); +<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">return</strong> params.get(<span class="jxr_string">"charset"</span>); +<a class="jxr_linenumber" name="L240" href="#L240">240</a> } +<a class="jxr_linenumber" name="L241" href="#L241">241</a> +<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment"> * Returns the original filename in the client's filesystem.</em> +<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment"> * @return The original filename in the client's filesystem.</em> +<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment"> * @throws org.apache.commons.fileupload.InvalidFileNameException The file name contains a NUL character,</em> +<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment"> * which might be an indicator of a security attack. If you intend to</em> +<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> * use the file name anyways, catch the exception and use</em> +<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment"> * {@link org.apache.commons.fileupload.InvalidFileNameException#getName()}.</em> +<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L251" href="#L251">251</a> @Override +<a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">public</strong> String getName() { +<a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong class="jxr_keyword">return</strong> Streams.checkFileName(fileName); +<a class="jxr_linenumber" name="L254" href="#L254">254</a> } +<a class="jxr_linenumber" name="L255" href="#L255">255</a> +<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_comment">// ------------------------------------------------------- FileItem methods</em> +<a class="jxr_linenumber" name="L257" href="#L257">257</a> +<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> * Provides a hint as to whether or not the file contents will be read</em> +<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment"> * from memory.</em> +<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the file contents will be read</em> +<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> * from memory; <code>false</code> otherwise.</em> +<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L265" href="#L265">265</a> @Override +<a class="jxr_linenumber" name="L266" href="#L266">266</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isInMemory() { +<a class="jxr_linenumber" name="L267" href="#L267">267</a> <strong class="jxr_keyword">if</strong> (cachedContent != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L269" href="#L269">269</a> } +<a class="jxr_linenumber" name="L270" href="#L270">270</a> <strong class="jxr_keyword">return</strong> dfos.isInMemory(); +<a class="jxr_linenumber" name="L271" href="#L271">271</a> } +<a class="jxr_linenumber" name="L272" href="#L272">272</a> +<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment"> * Returns the size of the file.</em> +<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_javadoccomment"> * @return The size of the file, in bytes.</em> +<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L278" href="#L278">278</a> @Override +<a class="jxr_linenumber" name="L279" href="#L279">279</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> getSize() { +<a class="jxr_linenumber" name="L280" href="#L280">280</a> <strong class="jxr_keyword">if</strong> (size >= 0) { +<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">return</strong> size; +<a class="jxr_linenumber" name="L282" href="#L282">282</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (cachedContent != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">return</strong> cachedContent.length; +<a class="jxr_linenumber" name="L284" href="#L284">284</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (dfos.isInMemory()) { +<a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong class="jxr_keyword">return</strong> dfos.getData().length; +<a class="jxr_linenumber" name="L286" href="#L286">286</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L287" href="#L287">287</a> <strong class="jxr_keyword">return</strong> dfos.getFile().length(); +<a class="jxr_linenumber" name="L288" href="#L288">288</a> } +<a class="jxr_linenumber" name="L289" href="#L289">289</a> } +<a class="jxr_linenumber" name="L290" href="#L290">290</a> +<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_javadoccomment"> * Returns the contents of the file as an array of bytes. If the</em> +<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_javadoccomment"> * contents of the file were not yet cached in memory, they will be</em> +<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_javadoccomment"> * loaded from the disk storage and cached.</em> +<a class="jxr_linenumber" name="L295" href="#L295">295</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment"> * @return The contents of the file as an array of bytes</em> +<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment"> * or {@code null} if the data cannot be read</em> +<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L299" href="#L299">299</a> @Override +<a class="jxr_linenumber" name="L300" href="#L300">300</a> <strong class="jxr_keyword">public</strong> byte[] get() { +<a class="jxr_linenumber" name="L301" href="#L301">301</a> <strong class="jxr_keyword">if</strong> (isInMemory()) { +<a class="jxr_linenumber" name="L302" href="#L302">302</a> <strong class="jxr_keyword">if</strong> (cachedContent == <strong class="jxr_keyword">null</strong> && dfos != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L303" href="#L303">303</a> cachedContent = dfos.getData(); +<a class="jxr_linenumber" name="L304" href="#L304">304</a> } +<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">return</strong> cachedContent; <a class="jxr_linenumber" name="L306" href="#L306">306</a> } <a class="jxr_linenumber" name="L307" href="#L307">307</a> -<a class="jxr_linenumber" name="L308" href="#L308">308</a> <strong class="jxr_keyword">return</strong> fileData; -<a class="jxr_linenumber" name="L309" href="#L309">309</a> } +<a class="jxr_linenumber" name="L308" href="#L308">308</a> byte[] fileData = <strong class="jxr_keyword">new</strong> byte[(<strong class="jxr_keyword">int</strong>) getSize()]; +<a class="jxr_linenumber" name="L309" href="#L309">309</a> InputStream fis = <strong class="jxr_keyword">null</strong>; <a class="jxr_linenumber" name="L310" href="#L310">310</a> -<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment"> * Returns the contents of the file as a String, using the specified</em> -<a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_javadoccomment"> * encoding. This method uses {@link #get()} to retrieve the</em> -<a class="jxr_linenumber" name="L314" href="#L314">314</a> <em class="jxr_javadoccomment"> * contents of the file.</em> -<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment"> * @param charset The charset to use.</em> -<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment"> * @return The contents of the file, as a string.</em> -<a class="jxr_linenumber" name="L319" href="#L319">319</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment"> * @throws UnsupportedEncodingException if the requested character</em> -<a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment"> * encoding is not available.</em> -<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L323" href="#L323">323</a> <strong class="jxr_keyword">public</strong> String getString(<strong class="jxr_keyword">final</strong> String charset) -<a class="jxr_linenumber" name="L324" href="#L324">324</a> <strong class="jxr_keyword">throws</strong> UnsupportedEncodingException { -<a class="jxr_linenumber" name="L325" href="#L325">325</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> String(get(), charset); -<a class="jxr_linenumber" name="L326" href="#L326">326</a> } -<a class="jxr_linenumber" name="L327" href="#L327">327</a> -<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> * Returns the contents of the file as a String, using the default</em> -<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> * character encoding. This method uses {@link #get()} to retrieve the</em> -<a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment"> * contents of the file.</em> -<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment"> * <b>TODO</b> Consider making this method throw UnsupportedEncodingException.</em> -<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment"> * @return The contents of the file, as a string.</em> -<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L337" href="#L337">337</a> <strong class="jxr_keyword">public</strong> String getString() { -<a class="jxr_linenumber" name="L338" href="#L338">338</a> byte[] rawdata = get(); -<a class="jxr_linenumber" name="L339" href="#L339">339</a> String charset = getCharSet(); -<a class="jxr_linenumber" name="L340" href="#L340">340</a> <strong class="jxr_keyword">if</strong> (charset == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L341" href="#L341">341</a> charset = DEFAULT_CHARSET; -<a class="jxr_linenumber" name="L342" href="#L342">342</a> } -<a class="jxr_linenumber" name="L343" href="#L343">343</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L344" href="#L344">344</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> String(rawdata, charset); -<a class="jxr_linenumber" name="L345" href="#L345">345</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException e) { -<a class="jxr_linenumber" name="L346" href="#L346">346</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> String(rawdata); -<a class="jxr_linenumber" name="L347" href="#L347">347</a> } -<a class="jxr_linenumber" name="L348" href="#L348">348</a> } -<a class="jxr_linenumber" name="L349" href="#L349">349</a> -<a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L351" href="#L351">351</a> <em class="jxr_javadoccomment"> * A convenience method to write an uploaded item to disk. The client code</em> -<a class="jxr_linenumber" name="L352" href="#L352">352</a> <em class="jxr_javadoccomment"> * is not concerned with whether or not the item is stored in memory, or on</em> -<a class="jxr_linenumber" name="L353" href="#L353">353</a> <em class="jxr_javadoccomment"> * disk in a temporary location. They just want to write the uploaded item</em> -<a class="jxr_linenumber" name="L354" href="#L354">354</a> <em class="jxr_javadoccomment"> * to a file.</em> -<a class="jxr_linenumber" name="L355" href="#L355">355</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L356" href="#L356">356</a> <em class="jxr_javadoccomment"> * This implementation first attempts to rename the uploaded item to the</em> -<a class="jxr_linenumber" name="L357" href="#L357">357</a> <em class="jxr_javadoccomment"> * specified destination file, if the item was originally written to disk.</em> -<a class="jxr_linenumber" name="L358" href="#L358">358</a> <em class="jxr_javadoccomment"> * Otherwise, the data will be copied to the specified file.</em> -<a class="jxr_linenumber" name="L359" href="#L359">359</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L360" href="#L360">360</a> <em class="jxr_javadoccomment"> * This method is only guaranteed to work <em>once</em>, the first time it</em> -<a class="jxr_linenumber" name="L361" href="#L361">361</a> <em class="jxr_javadoccomment"> * is invoked for a particular item. This is because, in the event that the</em> -<a class="jxr_linenumber" name="L362" href="#L362">362</a> <em class="jxr_javadoccomment"> * method renames a temporary file, that file will no longer be available</em> -<a class="jxr_linenumber" name="L363" href="#L363">363</a> <em class="jxr_javadoccomment"> * to copy or rename again at a later time.</em> -<a class="jxr_linenumber" name="L364" href="#L364">364</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L365" href="#L365">365</a> <em class="jxr_javadoccomment"> * @param file The <code>File</code> into which the uploaded item should</em> -<a class="jxr_linenumber" name="L366" href="#L366">366</a> <em class="jxr_javadoccomment"> * be stored.</em> -<a class="jxr_linenumber" name="L367" href="#L367">367</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L368" href="#L368">368</a> <em class="jxr_javadoccomment"> * @throws Exception if an error occurs.</em> -<a class="jxr_linenumber" name="L369" href="#L369">369</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L370" href="#L370">370</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> write(File file) <strong class="jxr_keyword">throws</strong> Exception { -<a class="jxr_linenumber" name="L371" href="#L371">371</a> <strong class="jxr_keyword">if</strong> (isInMemory()) { -<a class="jxr_linenumber" name="L372" href="#L372">372</a> FileOutputStream fout = <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L373" href="#L373">373</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L374" href="#L374">374</a> fout = <strong class="jxr_keyword">new</strong> FileOutputStream(file); -<a class="jxr_linenumber" name="L375" href="#L375">375</a> fout.write(get()); -<a class="jxr_linenumber" name="L376" href="#L376">376</a> fout.close(); -<a class="jxr_linenumber" name="L377" href="#L377">377</a> } <strong class="jxr_keyword">finally</strong> { -<a class="jxr_linenumber" name="L378" href="#L378">378</a> IOUtils.closeQuietly(fout); -<a class="jxr_linenumber" name="L379" href="#L379">379</a> } -<a class="jxr_linenumber" name="L380" href="#L380">380</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L381" href="#L381">381</a> File outputFile = getStoreLocation(); -<a class="jxr_linenumber" name="L382" href="#L382">382</a> <strong class="jxr_keyword">if</strong> (outputFile != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L383" href="#L383">383</a> <em class="jxr_comment">// Save the length of the file</em> -<a class="jxr_linenumber" name="L384" href="#L384">384</a> size = outputFile.length(); -<a class="jxr_linenumber" name="L385" href="#L385">385</a> <em class="jxr_comment">/*</em> -<a class="jxr_linenumber" name="L386" href="#L386">386</a> <em class="jxr_comment"> * The uploaded file is being stored on disk</em> -<a class="jxr_linenumber" name="L387" href="#L387">387</a> <em class="jxr_comment"> * in a temporary location so move it to the</em> -<a class="jxr_linenumber" name="L388" href="#L388">388</a> <em class="jxr_comment"> * desired file.</em> -<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_comment"> */</em> -<a class="jxr_linenumber" name="L390" href="#L390">390</a> FileUtils.moveFile(outputFile, file); -<a class="jxr_linenumber" name="L391" href="#L391">391</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L392" href="#L392">392</a> <em class="jxr_comment">/*</em> -<a class="jxr_linenumber" name="L393" href="#L393">393</a> <em class="jxr_comment"> * For whatever reason we cannot write the</em> -<a class="jxr_linenumber" name="L394" href="#L394">394</a> <em class="jxr_comment"> * file to disk.</em> -<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em class="jxr_comment"> */</em> -<a class="jxr_linenumber" name="L396" href="#L396">396</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/commons/fileupload/FileUploadException.html">FileUploadException</a>( -<a class="jxr_linenumber" name="L397" href="#L397">397</a> <span class="jxr_string">"Cannot write uploaded file to disk!"</span>); -<a class="jxr_linenumber" name="L398" href="#L398">398</a> } -<a class="jxr_linenumber" name="L399" href="#L399">399</a> } -<a class="jxr_linenumber" name="L400" href="#L400">400</a> } -<a class="jxr_linenumber" name="L401" href="#L401">401</a> -<a class="jxr_linenumber" name="L402" href="#L402">402</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L403" href="#L403">403</a> <em class="jxr_javadoccomment"> * Deletes the underlying storage for a file item, including deleting any</em> -<a class="jxr_linenumber" name="L404" href="#L404">404</a> <em class="jxr_javadoccomment"> * associated temporary disk file. Although this storage will be deleted</em> -<a class="jxr_linenumber" name="L405" href="#L405">405</a> <em class="jxr_javadoccomment"> * automatically when the <code>FileItem</code> instance is garbage</em> -<a class="jxr_linenumber" name="L406" href="#L406">406</a> <em class="jxr_javadoccomment"> * collected, this method can be used to ensure that this is done at an</em> -<a class="jxr_linenumber" name="L407" href="#L407">407</a> <em class="jxr_javadoccomment"> * earlier time, thus preserving system resources.</em> -<a class="jxr_linenumber" name="L408" href="#L408">408</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L409" href="#L409">409</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> delete() { -<a class="jxr_linenumber" name="L410" href="#L410">410</a> cachedContent = <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L411" href="#L411">411</a> File outputFile = getStoreLocation(); -<a class="jxr_linenumber" name="L412" href="#L412">412</a> <strong class="jxr_keyword">if</strong> (outputFile != <strong class="jxr_keyword">null</strong> && outputFile.exists()) { -<a class="jxr_linenumber" name="L413" href="#L413">413</a> outputFile.delete(); +<a class="jxr_linenumber" name="L311" href="#L311">311</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L312" href="#L312">312</a> fis = <strong class="jxr_keyword">new</strong> FileInputStream(dfos.getFile()); +<a class="jxr_linenumber" name="L313" href="#L313">313</a> IOUtils.readFully(fis, fileData); +<a class="jxr_linenumber" name="L314" href="#L314">314</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { +<a class="jxr_linenumber" name="L315" href="#L315">315</a> fileData = <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L316" href="#L316">316</a> } <strong class="jxr_keyword">finally</strong> { +<a class="jxr_linenumber" name="L317" href="#L317">317</a> IOUtils.closeQuietly(fis); +<a class="jxr_linenumber" name="L318" href="#L318">318</a> } +<a class="jxr_linenumber" name="L319" href="#L319">319</a> +<a class="jxr_linenumber" name="L320" href="#L320">320</a> <strong class="jxr_keyword">return</strong> fileData; +<a class="jxr_linenumber" name="L321" href="#L321">321</a> } +<a class="jxr_linenumber" name="L322" href="#L322">322</a> +<a class="jxr_linenumber" name="L323" href="#L323">323</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_javadoccomment"> * Returns the contents of the file as a String, using the specified</em> +<a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_javadoccomment"> * encoding. This method uses {@link #get()} to retrieve the</em> +<a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment"> * contents of the file.</em> +<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment"> * @param charset The charset to use.</em> +<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> * @return The contents of the file, as a string.</em> +<a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> * @throws UnsupportedEncodingException if the requested character</em> +<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment"> * encoding is not available.</em> +<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L335" href="#L335">335</a> @Override +<a class="jxr_linenumber" name="L336" href="#L336">336</a> <strong class="jxr_keyword">public</strong> String getString(<strong class="jxr_keyword">final</strong> String charset) +<a class="jxr_linenumber" name="L337" href="#L337">337</a> <strong class="jxr_keyword">throws</strong> UnsupportedEncodingException { +<a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> String(get(), charset); +<a class="jxr_linenumber" name="L339" href="#L339">339</a> } +<a class="jxr_linenumber" name="L340" href="#L340">340</a> +<a class="jxr_linenumber" name="L341" href="#L341">341</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L342" href="#L342">342</a> <em class="jxr_javadoccomment"> * Returns the contents of the file as a String, using the default</em> +<a class="jxr_linenumber" name="L343" href="#L343">343</a> <em class="jxr_javadoccomment"> * character encoding. This method uses {@link #get()} to retrieve the</em> +<a class="jxr_linenumber" name="L344" href="#L344">344</a> <em class="jxr_javadoccomment"> * contents of the file.</em> +<a class="jxr_linenumber" name="L345" href="#L345">345</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L346" href="#L346">346</a> <em class="jxr_javadoccomment"> * <b>TODO</b> Consider making this method throw UnsupportedEncodingException.</em> +<a class="jxr_linenumber" name="L347" href="#L347">347</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L348" href="#L348">348</a> <em class="jxr_javadoccomment"> * @return The contents of the file, as a string.</em> +<a class="jxr_linenumber" name="L349" href="#L349">349</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L350" href="#L350">350</a> @Override +<a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong class="jxr_keyword">public</strong> String getString() { +<a class="jxr_linenumber" name="L352" href="#L352">352</a> byte[] rawdata = get(); +<a class="jxr_linenumber" name="L353" href="#L353">353</a> String charset = getCharSet(); +<a class="jxr_linenumber" name="L354" href="#L354">354</a> <strong class="jxr_keyword">if</strong> (charset == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L355" href="#L355">355</a> charset = defaultCharset; +<a class="jxr_linenumber" name="L356" href="#L356">356</a> } +<a class="jxr_linenumber" name="L357" href="#L357">357</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L358" href="#L358">358</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> String(rawdata, charset); +<a class="jxr_linenumber" name="L359" href="#L359">359</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException e) { +<a class="jxr_linenumber" name="L360" href="#L360">360</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> String(rawdata); +<a class="jxr_linenumber" name="L361" href="#L361">361</a> } +<a class="jxr_linenumber" name="L362" href="#L362">362</a> } +<a class="jxr_linenumber" name="L363" href="#L363">363</a> +<a class="jxr_linenumber" name="L364" href="#L364">364</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L365" href="#L365">365</a> <em class="jxr_javadoccomment"> * A convenience method to write an uploaded item to disk. The client code</em> +<a class="jxr_linenumber" name="L366" href="#L366">366</a> <em class="jxr_javadoccomment"> * is not concerned with whether or not the item is stored in memory, or on</em> +<a class="jxr_linenumber" name="L367" href="#L367">367</a> <em class="jxr_javadoccomment"> * disk in a temporary location. They just want to write the uploaded item</em> +<a class="jxr_linenumber" name="L368" href="#L368">368</a> <em class="jxr_javadoccomment"> * to a file.</em> +<a class="jxr_linenumber" name="L369" href="#L369">369</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_javadoccomment"> * This implementation first attempts to rename the uploaded item to the</em> +<a class="jxr_linenumber" name="L371" href="#L371">371</a> <em class="jxr_javadoccomment"> * specified destination file, if the item was originally written to disk.</em> +<a class="jxr_linenumber" name="L372" href="#L372">372</a> <em class="jxr_javadoccomment"> * Otherwise, the data will be copied to the specified file.</em> +<a class="jxr_linenumber" name="L373" href="#L373">373</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L374" href="#L374">374</a> <em class="jxr_javadoccomment"> * This method is only guaranteed to work <em>once</em>, the first time it</em> +<a class="jxr_linenumber" name="L375" href="#L375">375</a> <em class="jxr_javadoccomment"> * is invoked for a particular item. This is because, in the event that the</em> +<a class="jxr_linenumber" name="L376" href="#L376">376</a> <em class="jxr_javadoccomment"> * method renames a temporary file, that file will no longer be available</em> +<a class="jxr_linenumber" name="L377" href="#L377">377</a> <em class="jxr_javadoccomment"> * to copy or rename again at a later time.</em> +<a class="jxr_linenumber" name="L378" href="#L378">378</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L379" href="#L379">379</a> <em class="jxr_javadoccomment"> * @param file The <code>File</code> into which the uploaded item should</em> +<a class="jxr_linenumber" name="L380" href="#L380">380</a> <em class="jxr_javadoccomment"> * be stored.</em> +<a class="jxr_linenumber" name="L381" href="#L381">381</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L382" href="#L382">382</a> <em class="jxr_javadoccomment"> * @throws Exception if an error occurs.</em> +<a class="jxr_linenumber" name="L383" href="#L383">383</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L384" href="#L384">384</a> @Override +<a class="jxr_linenumber" name="L385" href="#L385">385</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> write(File file) <strong class="jxr_keyword">throws</strong> Exception { +<a class="jxr_linenumber" name="L386" href="#L386">386</a> <strong class="jxr_keyword">if</strong> (isInMemory()) { +<a class="jxr_linenumber" name="L387" href="#L387">387</a> FileOutputStream fout = <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L388" href="#L388">388</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L389" href="#L389">389</a> fout = <strong class="jxr_keyword">new</strong> FileOutputStream(file); +<a class="jxr_linenumber" name="L390" href="#L390">390</a> fout.write(get()); +<a class="jxr_linenumber" name="L391" href="#L391">391</a> fout.close(); +<a class="jxr_linenumber" name="L392" href="#L392">392</a> } <strong class="jxr_keyword">finally</strong> { +<a class="jxr_linenumber" name="L393" href="#L393">393</a> IOUtils.closeQuietly(fout); +<a class="jxr_linenumber" name="L394" href="#L394">394</a> } +<a class="jxr_linenumber" name="L395" href="#L395">395</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L396" href="#L396">396</a> File outputFile = getStoreLocation(); +<a class="jxr_linenumber" name="L397" href="#L397">397</a> <strong class="jxr_keyword">if</strong> (outputFile != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L398" href="#L398">398</a> <em class="jxr_comment">// Save the length of the file</em> +<a class="jxr_linenumber" name="L399" href="#L399">399</a> size = outputFile.length(); +<a class="jxr_linenumber" name="L400" href="#L400">400</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L401" href="#L401">401</a> <em class="jxr_comment"> * The uploaded file is being stored on disk</em> +<a class="jxr_linenumber" name="L402" href="#L402">402</a> <em class="jxr_comment"> * in a temporary location so move it to the</em> +<a class="jxr_linenumber" name="L403" href="#L403">403</a> <em class="jxr_comment"> * desired file.</em> +<a class="jxr_linenumber" name="L404" href="#L404">404</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L405" href="#L405">405</a> FileUtils.moveFile(outputFile, file); +<a class="jxr_linenumber" name="L406" href="#L406">406</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L407" href="#L407">407</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L408" href="#L408">408</a> <em class="jxr_comment"> * For whatever reason we cannot write the</em> +<a class="jxr_linenumber" name="L409" href="#L409">409</a> <em class="jxr_comment"> * file to disk.</em> +<a class="jxr_linenumber" name="L410" href="#L410">410</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L411" href="#L411">411</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/commons/fileupload/FileUploadException.html">FileUploadException</a>( +<a class="jxr_linenumber" name="L412" href="#L412">412</a> <span class="jxr_string">"Cannot write uploaded file to disk!"</span>); +<a class="jxr_linenumber" name="L413" href="#L413">413</a> } <a class="jxr_linenumber" name="L414" href="#L414">414</a> } <a class="jxr_linenumber" name="L415" href="#L415">415</a> } <a class="jxr_linenumber" name="L416" href="#L416">416</a> <a class="jxr_linenumber" name="L417" href="#L417">417</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L418" href="#L418">418</a> <em class="jxr_javadoccomment"> * Returns the name of the field in the multipart form corresponding to</em> -<a class="jxr_linenumber" name="L419" href="#L419">419</a> <em class="jxr_javadoccomment"> * this file item.</em> -<a class="jxr_linenumber" name="L420" href="#L420">420</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L421" href="#L421">421</a> <em class="jxr_javadoccomment"> * @return The name of the form field.</em> -<a class="jxr_linenumber" name="L422" href="#L422">422</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L423" href="#L423">423</a> <em class="jxr_javadoccomment"> * @see #setFieldName(java.lang.String)</em> -<a class="jxr_linenumber" name="L424" href="#L424">424</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L425" href="#L425">425</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L426" href="#L426">426</a> <strong class="jxr_keyword">public</strong> String getFieldName() { -<a class="jxr_linenumber" name="L427" href="#L427">427</a> <strong class="jxr_keyword">return</strong> fieldName; -<a class="jxr_linenumber" name="L428" href="#L428">428</a> } -<a class="jxr_linenumber" name="L429" href="#L429">429</a> -<a class="jxr_linenumber" name="L430" href="#L430">430</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L431" href="#L431">431</a> <em class="jxr_javadoccomment"> * Sets the field name used to reference this file item.</em> -<a class="jxr_linenumber" name="L432" href="#L432">432</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L433" href="#L433">433</a> <em class="jxr_javadoccomment"> * @param fieldName The name of the form field.</em> -<a class="jxr_linenumber" name="L434" href="#L434">434</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L435" href="#L435">435</a> <em class="jxr_javadoccomment"> * @see #getFieldName()</em> +<a class="jxr_linenumber" name="L418" href="#L418">418</a> <em class="jxr_javadoccomment"> * Deletes the underlying storage for a file item, including deleting any</em> +<a class="jxr_linenumber" name="L419" href="#L419">419</a> <em class="jxr_javadoccomment"> * associated temporary disk file. Although this storage will be deleted</em> +<a class="jxr_linenumber" name="L420" href="#L420">420</a> <em class="jxr_javadoccomment"> * automatically when the <code>FileItem</code> instance is garbage</em> +<a class="jxr_linenumber" name="L421" href="#L421">421</a> <em class="jxr_javadoccomment"> * collected, this method can be used to ensure that this is done at an</em> +<a class="jxr_linenumber" name="L422" href="#L422">422</a> <em class="jxr_javadoccomment"> * earlier time, thus preserving system resources.</em> +<a class="jxr_linenumber" name="L423" href="#L423">423</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L424" href="#L424">424</a> @Override +<a class="jxr_linenumber" name="L425" href="#L425">425</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> delete() { +<a class="jxr_linenumber" name="L426" href="#L426">426</a> cachedContent = <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L427" href="#L427">427</a> File outputFile = getStoreLocation(); +<a class="jxr_linenumber" name="L428" href="#L428">428</a> <strong class="jxr_keyword">if</strong> (outputFile != <strong class="jxr_keyword">null</strong> && !isInMemory() && outputFile.exists()) { +<a class="jxr_linenumber" name="L429" href="#L429">429</a> outputFile.delete(); +<a class="jxr_linenumber" name="L430" href="#L430">430</a> } +<a class="jxr_linenumber" name="L431" href="#L431">431</a> } +<a class="jxr_linenumber" name="L432" href="#L432">432</a> +<a class="jxr_linenumber" name="L433" href="#L433">433</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L434" href="#L434">434</a> <em class="jxr_javadoccomment"> * Returns the name of the field in the multipart form corresponding to</em> +<a class="jxr_linenumber" name="L435" href="#L435">435</a> <em class="jxr_javadoccomment"> * this file item.</em> <a class="jxr_linenumber" name="L436" href="#L436">436</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L437" href="#L437">437</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L438" href="#L438">438</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setFieldName(String fieldName) { -<a class="jxr_linenumber" name="L439" href="#L439">439</a> <strong class="jxr_keyword">this</strong>.fieldName = fieldName; -<a class="jxr_linenumber" name="L440" href="#L440">440</a> } -<a class="jxr_linenumber" name="L441" href="#L441">441</a> -<a class="jxr_linenumber" name="L442" href="#L442">442</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L443" href="#L443">443</a> <em class="jxr_javadoccomment"> * Determines whether or not a <code>FileItem</code> instance represents</em> -<a class="jxr_linenumber" name="L444" href="#L444">444</a> <em class="jxr_javadoccomment"> * a simple form field.</em> -<a class="jxr_linenumber" name="L445" href="#L445">445</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L446" href="#L446">446</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the instance represents a simple form</em> -<a class="jxr_linenumber" name="L447" href="#L447">447</a> <em class="jxr_javadoccomment"> * field; <code>false</code> if it represents an uploaded file.</em> -<a class="jxr_linenumber" name="L448" href="#L448">448</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L449" href="#L449">449</a> <em class="jxr_javadoccomment"> * @see #setFormField(boolean)</em> -<a class="jxr_linenumber" name="L450" href="#L450">450</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L451" href="#L451">451</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L452" href="#L452">452</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isFormField() { -<a class="jxr_linenumber" name="L453" href="#L453">453</a> <strong class="jxr_keyword">return</strong> isFormField; -<a class="jxr_linenumber" name="L454" href="#L454">454</a> } -<a class="jxr_linenumber" name="L455" href="#L455">455</a> -<a class="jxr_linenumber" name="L456" href="#L456">456</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L457" href="#L457">457</a> <em class="jxr_javadoccomment"> * Specifies whether or not a <code>FileItem</code> instance represents</em> -<a class="jxr_linenumber" name="L458" href="#L458">458</a> <em class="jxr_javadoccomment"> * a simple form field.</em> -<a class="jxr_linenumber" name="L459" href="#L459">459</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L460" href="#L460">460</a> <em class="jxr_javadoccomment"> * @param state <code>true</code> if the instance represents a simple form</em> -<a class="jxr_linenumber" name="L461" href="#L461">461</a> <em class="jxr_javadoccomment"> * field; <code>false</code> if it represents an uploaded file.</em> -<a class="jxr_linenumber" name="L462" href="#L462">462</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L463" href="#L463">463</a> <em class="jxr_javadoccomment"> * @see #isFormField()</em> -<a class="jxr_linenumber" name="L464" href="#L464">464</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L465" href="#L465">465</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L466" href="#L466">466</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setFormField(<strong class="jxr_keyword">boolean</strong> state) { -<a class="jxr_linenumber" name="L467" href="#L467">467</a> isFormField = state; -<a class="jxr_linenumber" name="L468" href="#L468">468</a> } -<a class="jxr_linenumber" name="L469" href="#L469">469</a> -<a class="jxr_linenumber" name="L470" href="#L470">470</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L471" href="#L471">471</a> <em class="jxr_javadoccomment"> * Returns an {@link java.io.OutputStream OutputStream} that can</em> -<a class="jxr_linenumber" name="L472" href="#L472">472</a> <em class="jxr_javadoccomment"> * be used for storing the contents of the file.</em> -<a class="jxr_linenumber" name="L473" href="#L473">473</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L474" href="#L474">474</a> <em class="jxr_javadoccomment"> * @return An {@link java.io.OutputStream OutputStream} that can be used</em> -<a class="jxr_linenumber" name="L475" href="#L475">475</a> <em class="jxr_javadoccomment"> * for storing the contents of the file.</em> -<a class="jxr_linenumber" name="L476" href="#L476">476</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L477" href="#L477">477</a> <em class="jxr_javadoccomment"> * @throws IOException if an error occurs.</em> -<a class="jxr_linenumber" name="L478" href="#L478">478</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L479" href="#L479">479</a> <strong class="jxr_keyword">public</strong> OutputStream getOutputStream() -<a class="jxr_linenumber" name="L480" href="#L480">480</a> <strong class="jxr_keyword">throws</strong> IOException { -<a class="jxr_linenumber" name="L481" href="#L481">481</a> <strong class="jxr_keyword">if</strong> (dfos == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L482" href="#L482">482</a> File outputFile = getTempFile(); -<a class="jxr_linenumber" name="L483" href="#L483">483</a> dfos = <strong class="jxr_keyword">new</strong> DeferredFileOutputStream(sizeThreshold, outputFile); -<a class="jxr_linenumber" name="L484" href="#L484">484</a> } -<a class="jxr_linenumber" name="L485" href="#L485">485</a> <strong class="jxr_keyword">return</strong> dfos; -<a class="jxr_linenumber" name="L486" href="#L486">486</a> } -<a class="jxr_linenumber" name="L487" href="#L487">487</a> -<a class="jxr_linenumber" name="L488" href="#L488">488</a> <em class="jxr_comment">// --------------------------------------------------------- Public methods</em> +<a class="jxr_linenumber" name="L437" href="#L437">437</a> <em class="jxr_javadoccomment"> * @return The name of the form field.</em> +<a class="jxr_linenumber" name="L438" href="#L438">438</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L439" href="#L439">439</a> <em class="jxr_javadoccomment"> * @see #setFieldName(java.lang.String)</em> +<a class="jxr_linenumber" name="L440" href="#L440">440</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L441" href="#L441">441</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L442" href="#L442">442</a> @Override +<a class="jxr_linenumber" name="L443" href="#L443">443</a> <strong class="jxr_keyword">public</strong> String getFieldName() { +<a class="jxr_linenumber" name="L444" href="#L444">444</a> <strong class="jxr_keyword">return</strong> fieldName; +<a class="jxr_linenumber" name="L445" href="#L445">445</a> } +<a class="jxr_linenumber" name="L446" href="#L446">446</a> +<a class="jxr_linenumber" name="L447" href="#L447">447</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L448" href="#L448">448</a> <em class="jxr_javadoccomment"> * Sets the field name used to reference this file item.</em> +<a class="jxr_linenumber" name="L449" href="#L449">449</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L450" href="#L450">450</a> <em class="jxr_javadoccomment"> * @param fieldName The name of the form field.</em> +<a class="jxr_linenumber" name="L451" href="#L451">451</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L452" href="#L452">452</a> <em class="jxr_javadoccomment"> * @see #getFieldName()</em> +<a class="jxr_linenumber" name="L453" href="#L453">453</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L454" href="#L454">454</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L455" href="#L455">455</a> @Override +<a class="jxr_linenumber" name="L456" href="#L456">456</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setFieldName(String fieldName) { +<a class="jxr_linenumber" name="L457" href="#L457">457</a> <strong class="jxr_keyword">this</strong>.fieldName = fieldName; +<a class="jxr_linenumber" name="L458" href="#L458">458</a> } +<a class="jxr_linenumber" name="L459" href="#L459">459</a> +<a class="jxr_linenumber" name="L460" href="#L460">460</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L461" href="#L461">461</a> <em class="jxr_javadoccomment"> * Determines whether or not a <code>FileItem</code> instance represents</em> +<a class="jxr_linenumber" name="L462" href="#L462">462</a> <em class="jxr_javadoccomment"> * a simple form field.</em> +<a class="jxr_linenumber" name="L463" href="#L463">463</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L464" href="#L464">464</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the instance represents a simple form</em> +<a class="jxr_linenumber" name="L465" href="#L465">465</a> <em class="jxr_javadoccomment"> * field; <code>false</code> if it represents an uploaded file.</em> +<a class="jxr_linenumber" name="L466" href="#L466">466</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L467" href="#L467">467</a> <em class="jxr_javadoccomment"> * @see #setFormField(boolean)</em> +<a class="jxr_linenumber" name="L468" href="#L468">468</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L469" href="#L469">469</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L470" href="#L470">470</a> @Override +<a class="jxr_linenumber" name="L471" href="#L471">471</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isFormField() { +<a class="jxr_linenumber" name="L472" href="#L472">472</a> <strong class="jxr_keyword">return</strong> isFormField; +<a class="jxr_linenumber" name="L473" href="#L473">473</a> } +<a class="jxr_linenumber" name="L474" href="#L474">474</a> +<a class="jxr_linenumber" name="L475" href="#L475">475</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L476" href="#L476">476</a> <em class="jxr_javadoccomment"> * Specifies whether or not a <code>FileItem</code> instance represents</em> +<a class="jxr_linenumber" name="L477" href="#L477">477</a> <em class="jxr_javadoccomment"> * a simple form field.</em> +<a class="jxr_linenumber" name="L478" href="#L478">478</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L479" href="#L479">479</a> <em class="jxr_javadoccomment"> * @param state <code>true</code> if the instance represents a simple form</em> +<a class="jxr_linenumber" name="L480" href="#L480">480</a> <em class="jxr_javadoccomment"> * field; <code>false</code> if it represents an uploaded file.</em> +<a class="jxr_linenumber" name="L481" href="#L481">481</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L482" href="#L482">482</a> <em class="jxr_javadoccomment"> * @see #isFormField()</em> +<a class="jxr_linenumber" name="L483" href="#L483">483</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L484" href="#L484">484</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L485" href="#L485">485</a> @Override +<a class="jxr_linenumber" name="L486" href="#L486">486</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setFormField(<strong class="jxr_keyword">boolean</strong> state) { +<a class="jxr_linenumber" name="L487" href="#L487">487</a> isFormField = state; +<a class="jxr_linenumber" name="L488" href="#L488">488</a> } <a class="jxr_linenumber" name="L489" href="#L489">489</a> <a class="jxr_linenumber" name="L490" href="#L490">490</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L491" href="#L491">491</a> <em class="jxr_javadoccomment"> * Returns the {@link java.io.File} object for the <code>FileItem</code>'s</em> -<a class="jxr_linenumber" name="L492" href="#L492">492</a> <em class="jxr_javadoccomment"> * data's temporary location on the disk. Note that for</em> -<a class="jxr_linenumber" name="L493" href="#L493">493</a> <em class="jxr_javadoccomment"> * <code>FileItem</code>s that have their data stored in memory,</em> -<a class="jxr_linenumber" name="L494" href="#L494">494</a> <em class="jxr_javadoccomment"> * this method will return <code>null</code>. When handling large</em> -<a class="jxr_linenumber" name="L495" href="#L495">495</a> <em class="jxr_javadoccomment"> * files, you can use {@link java.io.File#renameTo(java.io.File)} to</em> -<a class="jxr_linenumber" name="L496" href="#L496">496</a> <em class="jxr_javadoccomment"> * move the file to new location without copying the data, if the</em> -<a class="jxr_linenumber" name="L497" href="#L497">497</a> <em class="jxr_javadoccomment"> * source and destination locations reside within the same logical</em> -<a class="jxr_linenumber" name="L498" href="#L498">498</a> <em class="jxr_javadoccomment"> * volume.</em> -<a class="jxr_linenumber" name="L499" href="#L499">499</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L500" href="#L500">500</a> <em class="jxr_javadoccomment"> * @return The data file, or <code>null</code> if the data is stored in</em> -<a class="jxr_linenumber" name="L501" href="#L501">501</a> <em class="jxr_javadoccomment"> * memory.</em> -<a class="jxr_linenumber" name="L502" href="#L502">502</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L503" href="#L503">503</a> <strong class="jxr_keyword">public</strong> File getStoreLocation() { -<a class="jxr_linenumber" name="L504" href="#L504">504</a> <strong class="jxr_keyword">if</strong> (dfos == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L505" href="#L505">505</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L506" href="#L506">506</a> } -<a class="jxr_linenumber" name="L507" href="#L507">507</a> <strong class="jxr_keyword">if</strong> (isInMemory()) { -<a class="jxr_linenumber" name="L508" href="#L508">508</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L509" href="#L509">509</a> } -<a class="jxr_linenumber" name="L510" href="#L510">510</a> <strong class="jxr_keyword">return</strong> dfos.getFile(); -<a class="jxr_linenumber" name="L511" href="#L511">511</a> } -<a class="jxr_linenumber" name="L512" href="#L512">512</a> -<a class="jxr_linenumber" name="L513" href="#L513">513</a> <em class="jxr_comment">// ------------------------------------------------------ Protected methods</em> -<a class="jxr_linenumber" name="L514" href="#L514">514</a> -<a class="jxr_linenumber" name="L515" href="#L515">515</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L516" href="#L516">516</a> <em class="jxr_javadoccomment"> * Removes the file contents from the temporary storage.</em> -<a class="jxr_linenumber" name="L517" href="#L517">517</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L518" href="#L518">518</a> @Override -<a class="jxr_linenumber" name="L519" href="#L519">519</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> finalize() { -<a class="jxr_linenumber" name="L520" href="#L520">520</a> <strong class="jxr_keyword">if</strong> (dfos == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L521" href="#L521">521</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L522" href="#L522">522</a> } -<a class="jxr_linenumber" name="L523" href="#L523">523</a> File outputFile = dfos.getFile(); -<a class="jxr_linenumber" name="L524" href="#L524">524</a> -<a class="jxr_linenumber" name="L525" href="#L525">525</a> <strong class="jxr_keyword">if</strong> (outputFile != <strong class="jxr_keyword">null</strong> && outputFile.exists()) { -<a class="jxr_linenumber" name="L526" href="#L526">526</a> outputFile.delete(); +<a class="jxr_linenumber" name="L491" href="#L491">491</a> <em class="jxr_javadoccomment"> * Returns an {@link java.io.OutputStream OutputStream} that can</em> +<a class="jxr_linenumber" name="L492" href="#L492">492</a> <em class="jxr_javadoccomment"> * be used for storing the contents of the file.</em> +<a class="jxr_linenumber" name="L493" href="#L493">493</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L494" href="#L494">494</a> <em class="jxr_javadoccomment"> * @return An {@link java.io.OutputStream OutputStream} that can be used</em> +<a class="jxr_linenumber" name="L495" href="#L495">495</a> <em class="jxr_javadoccomment"> * for storing the contents of the file.</em>
[... 231 lines stripped ...]