Added: websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileItem.html ============================================================================== --- websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileItem.html (added) +++ websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileItem.html Tue Jun 13 12:48:38 2017 @@ -0,0 +1,278 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<html lang="en"> +<head> +<title>Source code</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<div class="sourceContainer"> +<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> +<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> +<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> +<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> +<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a> +<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> +<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> +<span class="sourceLineNo">008</span> *<a name="line.8"></a> +<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> +<span class="sourceLineNo">010</span> *<a name="line.10"></a> +<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> +<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> +<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> +<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a> +<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a> +<span class="sourceLineNo">016</span> */<a name="line.16"></a> +<span class="sourceLineNo">017</span>package org.apache.commons.fileupload;<a name="line.17"></a> +<span class="sourceLineNo">018</span><a name="line.18"></a> +<span class="sourceLineNo">019</span>import java.io.File;<a name="line.19"></a> +<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import java.io.InputStream;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import java.io.OutputStream;<a name="line.22"></a> +<span class="sourceLineNo">023</span>import java.io.Serializable;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import java.io.UnsupportedEncodingException;<a name="line.24"></a> +<span class="sourceLineNo">025</span><a name="line.25"></a> +<span class="sourceLineNo">026</span>/**<a name="line.26"></a> +<span class="sourceLineNo">027</span> * <p> This class represents a file or form item that was received within a<a name="line.27"></a> +<span class="sourceLineNo">028</span> * <code>multipart/form-data</code> POST request.<a name="line.28"></a> +<span class="sourceLineNo">029</span> *<a name="line.29"></a> +<span class="sourceLineNo">030</span> * <p> After retrieving an instance of this class from a {@link<a name="line.30"></a> +<span class="sourceLineNo">031</span> * org.apache.commons.fileupload.FileUpload FileUpload} instance (see<a name="line.31"></a> +<span class="sourceLineNo">032</span> * {@link org.apache.commons.fileupload.servlet.ServletFileUpload<a name="line.32"></a> +<span class="sourceLineNo">033</span> * #parseRequest(javax.servlet.http.HttpServletRequest)}), you may<a name="line.33"></a> +<span class="sourceLineNo">034</span> * either request all contents of the file at once using {@link #get()} or<a name="line.34"></a> +<span class="sourceLineNo">035</span> * request an {@link java.io.InputStream InputStream} with<a name="line.35"></a> +<span class="sourceLineNo">036</span> * {@link #getInputStream()} and process the file without attempting to load<a name="line.36"></a> +<span class="sourceLineNo">037</span> * it into memory, which may come handy with large files.<a name="line.37"></a> +<span class="sourceLineNo">038</span> *<a name="line.38"></a> +<span class="sourceLineNo">039</span> * <p> While this interface does not extend<a name="line.39"></a> +<span class="sourceLineNo">040</span> * <code>javax.activation.DataSource</code> per se (to avoid a seldom used<a name="line.40"></a> +<span class="sourceLineNo">041</span> * dependency), several of the defined methods are specifically defined with<a name="line.41"></a> +<span class="sourceLineNo">042</span> * the same signatures as methods in that interface. This allows an<a name="line.42"></a> +<span class="sourceLineNo">043</span> * implementation of this interface to also implement<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <code>javax.activation.DataSource</code> with minimal additional work.<a name="line.44"></a> +<span class="sourceLineNo">045</span> *<a name="line.45"></a> +<span class="sourceLineNo">046</span> * @version $Id$<a name="line.46"></a> +<span class="sourceLineNo">047</span> * @since 1.3 additionally implements FileItemHeadersSupport<a name="line.47"></a> +<span class="sourceLineNo">048</span> */<a name="line.48"></a> +<span class="sourceLineNo">049</span>public interface FileItem extends Serializable, FileItemHeadersSupport {<a name="line.49"></a> +<span class="sourceLineNo">050</span><a name="line.50"></a> +<span class="sourceLineNo">051</span> // ------------------------------- Methods from javax.activation.DataSource<a name="line.51"></a> +<span class="sourceLineNo">052</span><a name="line.52"></a> +<span class="sourceLineNo">053</span> /**<a name="line.53"></a> +<span class="sourceLineNo">054</span> * Returns an {@link java.io.InputStream InputStream} that can be<a name="line.54"></a> +<span class="sourceLineNo">055</span> * used to retrieve the contents of the file.<a name="line.55"></a> +<span class="sourceLineNo">056</span> *<a name="line.56"></a> +<span class="sourceLineNo">057</span> * @return An {@link java.io.InputStream InputStream} that can be<a name="line.57"></a> +<span class="sourceLineNo">058</span> * used to retrieve the contents of the file.<a name="line.58"></a> +<span class="sourceLineNo">059</span> *<a name="line.59"></a> +<span class="sourceLineNo">060</span> * @throws IOException if an error occurs.<a name="line.60"></a> +<span class="sourceLineNo">061</span> */<a name="line.61"></a> +<span class="sourceLineNo">062</span> InputStream getInputStream() throws IOException;<a name="line.62"></a> +<span class="sourceLineNo">063</span><a name="line.63"></a> +<span class="sourceLineNo">064</span> /**<a name="line.64"></a> +<span class="sourceLineNo">065</span> * Returns the content type passed by the browser or <code>null</code> if<a name="line.65"></a> +<span class="sourceLineNo">066</span> * not defined.<a name="line.66"></a> +<span class="sourceLineNo">067</span> *<a name="line.67"></a> +<span class="sourceLineNo">068</span> * @return The content type passed by the browser or <code>null</code> if<a name="line.68"></a> +<span class="sourceLineNo">069</span> * not defined.<a name="line.69"></a> +<span class="sourceLineNo">070</span> */<a name="line.70"></a> +<span class="sourceLineNo">071</span> String getContentType();<a name="line.71"></a> +<span class="sourceLineNo">072</span><a name="line.72"></a> +<span class="sourceLineNo">073</span> /**<a name="line.73"></a> +<span class="sourceLineNo">074</span> * Returns the original filename in the client's filesystem, as provided by<a name="line.74"></a> +<span class="sourceLineNo">075</span> * the browser (or other client software). In most cases, this will be the<a name="line.75"></a> +<span class="sourceLineNo">076</span> * base file name, without path information. However, some clients, such as<a name="line.76"></a> +<span class="sourceLineNo">077</span> * the Opera browser, do include path information.<a name="line.77"></a> +<span class="sourceLineNo">078</span> *<a name="line.78"></a> +<span class="sourceLineNo">079</span> * @return The original filename in the client's filesystem.<a name="line.79"></a> +<span class="sourceLineNo">080</span> * @throws InvalidFileNameException The file name contains a NUL character,<a name="line.80"></a> +<span class="sourceLineNo">081</span> * which might be an indicator of a security attack. If you intend to<a name="line.81"></a> +<span class="sourceLineNo">082</span> * use the file name anyways, catch the exception and use<a name="line.82"></a> +<span class="sourceLineNo">083</span> * InvalidFileNameException#getName().<a name="line.83"></a> +<span class="sourceLineNo">084</span> */<a name="line.84"></a> +<span class="sourceLineNo">085</span> String getName();<a name="line.85"></a> +<span class="sourceLineNo">086</span><a name="line.86"></a> +<span class="sourceLineNo">087</span> // ------------------------------------------------------- FileItem methods<a name="line.87"></a> +<span class="sourceLineNo">088</span><a name="line.88"></a> +<span class="sourceLineNo">089</span> /**<a name="line.89"></a> +<span class="sourceLineNo">090</span> * Provides a hint as to whether or not the file contents will be read<a name="line.90"></a> +<span class="sourceLineNo">091</span> * from memory.<a name="line.91"></a> +<span class="sourceLineNo">092</span> *<a name="line.92"></a> +<span class="sourceLineNo">093</span> * @return <code>true</code> if the file contents will be read from memory;<a name="line.93"></a> +<span class="sourceLineNo">094</span> * <code>false</code> otherwise.<a name="line.94"></a> +<span class="sourceLineNo">095</span> */<a name="line.95"></a> +<span class="sourceLineNo">096</span> boolean isInMemory();<a name="line.96"></a> +<span class="sourceLineNo">097</span><a name="line.97"></a> +<span class="sourceLineNo">098</span> /**<a name="line.98"></a> +<span class="sourceLineNo">099</span> * Returns the size of the file item.<a name="line.99"></a> +<span class="sourceLineNo">100</span> *<a name="line.100"></a> +<span class="sourceLineNo">101</span> * @return The size of the file item, in bytes.<a name="line.101"></a> +<span class="sourceLineNo">102</span> */<a name="line.102"></a> +<span class="sourceLineNo">103</span> long getSize();<a name="line.103"></a> +<span class="sourceLineNo">104</span><a name="line.104"></a> +<span class="sourceLineNo">105</span> /**<a name="line.105"></a> +<span class="sourceLineNo">106</span> * Returns the contents of the file item as an array of bytes.<a name="line.106"></a> +<span class="sourceLineNo">107</span> *<a name="line.107"></a> +<span class="sourceLineNo">108</span> * @return The contents of the file item as an array of bytes.<a name="line.108"></a> +<span class="sourceLineNo">109</span> */<a name="line.109"></a> +<span class="sourceLineNo">110</span> byte[] get();<a name="line.110"></a> +<span class="sourceLineNo">111</span><a name="line.111"></a> +<span class="sourceLineNo">112</span> /**<a name="line.112"></a> +<span class="sourceLineNo">113</span> * Returns the contents of the file item as a String, using the specified<a name="line.113"></a> +<span class="sourceLineNo">114</span> * encoding. This method uses {@link #get()} to retrieve the<a name="line.114"></a> +<span class="sourceLineNo">115</span> * contents of the item.<a name="line.115"></a> +<span class="sourceLineNo">116</span> *<a name="line.116"></a> +<span class="sourceLineNo">117</span> * @param encoding The character encoding to use.<a name="line.117"></a> +<span class="sourceLineNo">118</span> *<a name="line.118"></a> +<span class="sourceLineNo">119</span> * @return The contents of the item, as a string.<a name="line.119"></a> +<span class="sourceLineNo">120</span> *<a name="line.120"></a> +<span class="sourceLineNo">121</span> * @throws UnsupportedEncodingException if the requested character<a name="line.121"></a> +<span class="sourceLineNo">122</span> * encoding is not available.<a name="line.122"></a> +<span class="sourceLineNo">123</span> */<a name="line.123"></a> +<span class="sourceLineNo">124</span> String getString(String encoding) throws UnsupportedEncodingException;<a name="line.124"></a> +<span class="sourceLineNo">125</span><a name="line.125"></a> +<span class="sourceLineNo">126</span> /**<a name="line.126"></a> +<span class="sourceLineNo">127</span> * Returns the contents of the file item as a String, using the default<a name="line.127"></a> +<span class="sourceLineNo">128</span> * character encoding. This method uses {@link #get()} to retrieve the<a name="line.128"></a> +<span class="sourceLineNo">129</span> * contents of the item.<a name="line.129"></a> +<span class="sourceLineNo">130</span> *<a name="line.130"></a> +<span class="sourceLineNo">131</span> * @return The contents of the item, as a string.<a name="line.131"></a> +<span class="sourceLineNo">132</span> */<a name="line.132"></a> +<span class="sourceLineNo">133</span> String getString();<a name="line.133"></a> +<span class="sourceLineNo">134</span><a name="line.134"></a> +<span class="sourceLineNo">135</span> /**<a name="line.135"></a> +<span class="sourceLineNo">136</span> * A convenience method to write an uploaded item to disk. The client code<a name="line.136"></a> +<span class="sourceLineNo">137</span> * is not concerned with whether or not the item is stored in memory, or on<a name="line.137"></a> +<span class="sourceLineNo">138</span> * disk in a temporary location. They just want to write the uploaded item<a name="line.138"></a> +<span class="sourceLineNo">139</span> * to a file.<a name="line.139"></a> +<span class="sourceLineNo">140</span> * <p><a name="line.140"></a> +<span class="sourceLineNo">141</span> * This method is not guaranteed to succeed if called more than once for<a name="line.141"></a> +<span class="sourceLineNo">142</span> * the same item. This allows a particular implementation to use, for<a name="line.142"></a> +<span class="sourceLineNo">143</span> * example, file renaming, where possible, rather than copying all of the<a name="line.143"></a> +<span class="sourceLineNo">144</span> * underlying data, thus gaining a significant performance benefit.<a name="line.144"></a> +<span class="sourceLineNo">145</span> *<a name="line.145"></a> +<span class="sourceLineNo">146</span> * @param file The <code>File</code> into which the uploaded item should<a name="line.146"></a> +<span class="sourceLineNo">147</span> * be stored.<a name="line.147"></a> +<span class="sourceLineNo">148</span> *<a name="line.148"></a> +<span class="sourceLineNo">149</span> * @throws Exception if an error occurs.<a name="line.149"></a> +<span class="sourceLineNo">150</span> */<a name="line.150"></a> +<span class="sourceLineNo">151</span> void write(File file) throws Exception;<a name="line.151"></a> +<span class="sourceLineNo">152</span><a name="line.152"></a> +<span class="sourceLineNo">153</span> /**<a name="line.153"></a> +<span class="sourceLineNo">154</span> * Deletes the underlying storage for a file item, including deleting any<a name="line.154"></a> +<span class="sourceLineNo">155</span> * associated temporary disk file. Although this storage will be deleted<a name="line.155"></a> +<span class="sourceLineNo">156</span> * automatically when the <code>FileItem</code> instance is garbage<a name="line.156"></a> +<span class="sourceLineNo">157</span> * collected, this method can be used to ensure that this is done at an<a name="line.157"></a> +<span class="sourceLineNo">158</span> * earlier time, thus preserving system resources.<a name="line.158"></a> +<span class="sourceLineNo">159</span> */<a name="line.159"></a> +<span class="sourceLineNo">160</span> void delete();<a name="line.160"></a> +<span class="sourceLineNo">161</span><a name="line.161"></a> +<span class="sourceLineNo">162</span> /**<a name="line.162"></a> +<span class="sourceLineNo">163</span> * Returns the name of the field in the multipart form corresponding to<a name="line.163"></a> +<span class="sourceLineNo">164</span> * this file item.<a name="line.164"></a> +<span class="sourceLineNo">165</span> *<a name="line.165"></a> +<span class="sourceLineNo">166</span> * @return The name of the form field.<a name="line.166"></a> +<span class="sourceLineNo">167</span> */<a name="line.167"></a> +<span class="sourceLineNo">168</span> String getFieldName();<a name="line.168"></a> +<span class="sourceLineNo">169</span><a name="line.169"></a> +<span class="sourceLineNo">170</span> /**<a name="line.170"></a> +<span class="sourceLineNo">171</span> * Sets the field name used to reference this file item.<a name="line.171"></a> +<span class="sourceLineNo">172</span> *<a name="line.172"></a> +<span class="sourceLineNo">173</span> * @param name The name of the form field.<a name="line.173"></a> +<span class="sourceLineNo">174</span> */<a name="line.174"></a> +<span class="sourceLineNo">175</span> void setFieldName(String name);<a name="line.175"></a> +<span class="sourceLineNo">176</span><a name="line.176"></a> +<span class="sourceLineNo">177</span> /**<a name="line.177"></a> +<span class="sourceLineNo">178</span> * Determines whether or not a <code>FileItem</code> instance represents<a name="line.178"></a> +<span class="sourceLineNo">179</span> * a simple form field.<a name="line.179"></a> +<span class="sourceLineNo">180</span> *<a name="line.180"></a> +<span class="sourceLineNo">181</span> * @return <code>true</code> if the instance represents a simple form<a name="line.181"></a> +<span class="sourceLineNo">182</span> * field; <code>false</code> if it represents an uploaded file.<a name="line.182"></a> +<span class="sourceLineNo">183</span> */<a name="line.183"></a> +<span class="sourceLineNo">184</span> boolean isFormField();<a name="line.184"></a> +<span class="sourceLineNo">185</span><a name="line.185"></a> +<span class="sourceLineNo">186</span> /**<a name="line.186"></a> +<span class="sourceLineNo">187</span> * Specifies whether or not a <code>FileItem</code> instance represents<a name="line.187"></a> +<span class="sourceLineNo">188</span> * a simple form field.<a name="line.188"></a> +<span class="sourceLineNo">189</span> *<a name="line.189"></a> +<span class="sourceLineNo">190</span> * @param state <code>true</code> if the instance represents a simple form<a name="line.190"></a> +<span class="sourceLineNo">191</span> * field; <code>false</code> if it represents an uploaded file.<a name="line.191"></a> +<span class="sourceLineNo">192</span> */<a name="line.192"></a> +<span class="sourceLineNo">193</span> void setFormField(boolean state);<a name="line.193"></a> +<span class="sourceLineNo">194</span><a name="line.194"></a> +<span class="sourceLineNo">195</span> /**<a name="line.195"></a> +<span class="sourceLineNo">196</span> * Returns an {@link java.io.OutputStream OutputStream} that can<a name="line.196"></a> +<span class="sourceLineNo">197</span> * be used for storing the contents of the file.<a name="line.197"></a> +<span class="sourceLineNo">198</span> *<a name="line.198"></a> +<span class="sourceLineNo">199</span> * @return An {@link java.io.OutputStream OutputStream} that can be used<a name="line.199"></a> +<span class="sourceLineNo">200</span> * for storing the contensts of the file.<a name="line.200"></a> +<span class="sourceLineNo">201</span> *<a name="line.201"></a> +<span class="sourceLineNo">202</span> * @throws IOException if an error occurs.<a name="line.202"></a> +<span class="sourceLineNo">203</span> */<a name="line.203"></a> +<span class="sourceLineNo">204</span> OutputStream getOutputStream() throws IOException;<a name="line.204"></a> +<span class="sourceLineNo">205</span><a name="line.205"></a> +<span class="sourceLineNo">206</span>}<a name="line.206"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html>
Added: websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileItemFactory.html ============================================================================== --- websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileItemFactory.html (added) +++ websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileItemFactory.html Tue Jun 13 12:48:38 2017 @@ -0,0 +1,120 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<html lang="en"> +<head> +<title>Source code</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<div class="sourceContainer"> +<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> +<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> +<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> +<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> +<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a> +<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> +<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> +<span class="sourceLineNo">008</span> *<a name="line.8"></a> +<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> +<span class="sourceLineNo">010</span> *<a name="line.10"></a> +<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> +<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> +<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> +<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a> +<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a> +<span class="sourceLineNo">016</span> */<a name="line.16"></a> +<span class="sourceLineNo">017</span>package org.apache.commons.fileupload;<a name="line.17"></a> +<span class="sourceLineNo">018</span><a name="line.18"></a> +<span class="sourceLineNo">019</span>/**<a name="line.19"></a> +<span class="sourceLineNo">020</span> * <p>A factory interface for creating {@link FileItem} instances. Factories<a name="line.20"></a> +<span class="sourceLineNo">021</span> * can provide their own custom configuration, over and above that provided<a name="line.21"></a> +<span class="sourceLineNo">022</span> * by the default file upload implementation.</p><a name="line.22"></a> +<span class="sourceLineNo">023</span> *<a name="line.23"></a> +<span class="sourceLineNo">024</span> * @version $Id$<a name="line.24"></a> +<span class="sourceLineNo">025</span> */<a name="line.25"></a> +<span class="sourceLineNo">026</span>public interface FileItemFactory {<a name="line.26"></a> +<span class="sourceLineNo">027</span><a name="line.27"></a> +<span class="sourceLineNo">028</span> /**<a name="line.28"></a> +<span class="sourceLineNo">029</span> * Create a new {@link FileItem} instance from the supplied parameters and<a name="line.29"></a> +<span class="sourceLineNo">030</span> * any local factory configuration.<a name="line.30"></a> +<span class="sourceLineNo">031</span> *<a name="line.31"></a> +<span class="sourceLineNo">032</span> * @param fieldName The name of the form field.<a name="line.32"></a> +<span class="sourceLineNo">033</span> * @param contentType The content type of the form field.<a name="line.33"></a> +<span class="sourceLineNo">034</span> * @param isFormField <code>true</code> if this is a plain form field;<a name="line.34"></a> +<span class="sourceLineNo">035</span> * <code>false</code> otherwise.<a name="line.35"></a> +<span class="sourceLineNo">036</span> * @param fileName The name of the uploaded file, if any, as supplied<a name="line.36"></a> +<span class="sourceLineNo">037</span> * by the browser or other client.<a name="line.37"></a> +<span class="sourceLineNo">038</span> *<a name="line.38"></a> +<span class="sourceLineNo">039</span> * @return The newly created file item.<a name="line.39"></a> +<span class="sourceLineNo">040</span> */<a name="line.40"></a> +<span class="sourceLineNo">041</span> FileItem createItem(<a name="line.41"></a> +<span class="sourceLineNo">042</span> String fieldName,<a name="line.42"></a> +<span class="sourceLineNo">043</span> String contentType,<a name="line.43"></a> +<span class="sourceLineNo">044</span> boolean isFormField,<a name="line.44"></a> +<span class="sourceLineNo">045</span> String fileName<a name="line.45"></a> +<span class="sourceLineNo">046</span> );<a name="line.46"></a> +<span class="sourceLineNo">047</span><a name="line.47"></a> +<span class="sourceLineNo">048</span>}<a name="line.48"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> Added: websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileItemHeaders.html ============================================================================== --- websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileItemHeaders.html (added) +++ websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileItemHeaders.html Tue Jun 13 12:48:38 2017 @@ -0,0 +1,148 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<html lang="en"> +<head> +<title>Source code</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<div class="sourceContainer"> +<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> +<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> +<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> +<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> +<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a> +<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> +<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> +<span class="sourceLineNo">008</span> *<a name="line.8"></a> +<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> +<span class="sourceLineNo">010</span> *<a name="line.10"></a> +<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> +<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> +<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> +<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a> +<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a> +<span class="sourceLineNo">016</span> */<a name="line.16"></a> +<span class="sourceLineNo">017</span>package org.apache.commons.fileupload;<a name="line.17"></a> +<span class="sourceLineNo">018</span><a name="line.18"></a> +<span class="sourceLineNo">019</span>import java.util.Iterator;<a name="line.19"></a> +<span class="sourceLineNo">020</span><a name="line.20"></a> +<span class="sourceLineNo">021</span>/**<a name="line.21"></a> +<span class="sourceLineNo">022</span> * <p> This class provides support for accessing the headers for a file or form<a name="line.22"></a> +<span class="sourceLineNo">023</span> * item that was received within a <code>multipart/form-data</code> POST<a name="line.23"></a> +<span class="sourceLineNo">024</span> * request.</p><a name="line.24"></a> +<span class="sourceLineNo">025</span> *<a name="line.25"></a> +<span class="sourceLineNo">026</span> * @since 1.2.1<a name="line.26"></a> +<span class="sourceLineNo">027</span> *<a name="line.27"></a> +<span class="sourceLineNo">028</span> * @version $Id$<a name="line.28"></a> +<span class="sourceLineNo">029</span> */<a name="line.29"></a> +<span class="sourceLineNo">030</span>public interface FileItemHeaders {<a name="line.30"></a> +<span class="sourceLineNo">031</span><a name="line.31"></a> +<span class="sourceLineNo">032</span> /**<a name="line.32"></a> +<span class="sourceLineNo">033</span> * Returns the value of the specified part header as a <code>String</code>.<a name="line.33"></a> +<span class="sourceLineNo">034</span> *<a name="line.34"></a> +<span class="sourceLineNo">035</span> * If the part did not include a header of the specified name, this method<a name="line.35"></a> +<span class="sourceLineNo">036</span> * return <code>null</code>. If there are multiple headers with the same<a name="line.36"></a> +<span class="sourceLineNo">037</span> * name, this method returns the first header in the item. The header<a name="line.37"></a> +<span class="sourceLineNo">038</span> * name is case insensitive.<a name="line.38"></a> +<span class="sourceLineNo">039</span> *<a name="line.39"></a> +<span class="sourceLineNo">040</span> * @param name a <code>String</code> specifying the header name<a name="line.40"></a> +<span class="sourceLineNo">041</span> * @return a <code>String</code> containing the value of the requested<a name="line.41"></a> +<span class="sourceLineNo">042</span> * header, or <code>null</code> if the item does not have a header<a name="line.42"></a> +<span class="sourceLineNo">043</span> * of that name<a name="line.43"></a> +<span class="sourceLineNo">044</span> */<a name="line.44"></a> +<span class="sourceLineNo">045</span> String getHeader(String name);<a name="line.45"></a> +<span class="sourceLineNo">046</span><a name="line.46"></a> +<span class="sourceLineNo">047</span> /**<a name="line.47"></a> +<span class="sourceLineNo">048</span> * <p><a name="line.48"></a> +<span class="sourceLineNo">049</span> * Returns all the values of the specified item header as an<a name="line.49"></a> +<span class="sourceLineNo">050</span> * <code>Iterator</code> of <code>String</code> objects.<a name="line.50"></a> +<span class="sourceLineNo">051</span> * </p><a name="line.51"></a> +<span class="sourceLineNo">052</span> * <p><a name="line.52"></a> +<span class="sourceLineNo">053</span> * If the item did not include any headers of the specified name, this<a name="line.53"></a> +<span class="sourceLineNo">054</span> * method returns an empty <code>Iterator</code>. The header name is<a name="line.54"></a> +<span class="sourceLineNo">055</span> * case insensitive.<a name="line.55"></a> +<span class="sourceLineNo">056</span> * </p><a name="line.56"></a> +<span class="sourceLineNo">057</span> *<a name="line.57"></a> +<span class="sourceLineNo">058</span> * @param name a <code>String</code> specifying the header name<a name="line.58"></a> +<span class="sourceLineNo">059</span> * @return an <code>Iterator</code> containing the values of the<a name="line.59"></a> +<span class="sourceLineNo">060</span> * requested header. If the item does not have any headers of<a name="line.60"></a> +<span class="sourceLineNo">061</span> * that name, return an empty <code>Iterator</code><a name="line.61"></a> +<span class="sourceLineNo">062</span> */<a name="line.62"></a> +<span class="sourceLineNo">063</span> Iterator<String> getHeaders(String name);<a name="line.63"></a> +<span class="sourceLineNo">064</span><a name="line.64"></a> +<span class="sourceLineNo">065</span> /**<a name="line.65"></a> +<span class="sourceLineNo">066</span> * <p><a name="line.66"></a> +<span class="sourceLineNo">067</span> * Returns an <code>Iterator</code> of all the header names.<a name="line.67"></a> +<span class="sourceLineNo">068</span> * </p><a name="line.68"></a> +<span class="sourceLineNo">069</span> *<a name="line.69"></a> +<span class="sourceLineNo">070</span> * @return an <code>Iterator</code> containing all of the names of<a name="line.70"></a> +<span class="sourceLineNo">071</span> * headers provided with this file item. If the item does not have<a name="line.71"></a> +<span class="sourceLineNo">072</span> * any headers return an empty <code>Iterator</code><a name="line.72"></a> +<span class="sourceLineNo">073</span> */<a name="line.73"></a> +<span class="sourceLineNo">074</span> Iterator<String> getHeaderNames();<a name="line.74"></a> +<span class="sourceLineNo">075</span><a name="line.75"></a> +<span class="sourceLineNo">076</span>}<a name="line.76"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> Added: websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileItemHeadersSupport.html ============================================================================== --- websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileItemHeadersSupport.html (added) +++ websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileItemHeadersSupport.html Tue Jun 13 12:48:38 2017 @@ -0,0 +1,122 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<html lang="en"> +<head> +<title>Source code</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<div class="sourceContainer"> +<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> +<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> +<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> +<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> +<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a> +<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> +<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> +<span class="sourceLineNo">008</span> *<a name="line.8"></a> +<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> +<span class="sourceLineNo">010</span> *<a name="line.10"></a> +<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> +<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> +<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> +<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a> +<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a> +<span class="sourceLineNo">016</span> */<a name="line.16"></a> +<span class="sourceLineNo">017</span>package org.apache.commons.fileupload;<a name="line.17"></a> +<span class="sourceLineNo">018</span><a name="line.18"></a> +<span class="sourceLineNo">019</span>/**<a name="line.19"></a> +<span class="sourceLineNo">020</span> * Interface that will indicate that {@link FileItem} or {@link FileItemStream}<a name="line.20"></a> +<span class="sourceLineNo">021</span> * implementations will accept the headers read for the item.<a name="line.21"></a> +<span class="sourceLineNo">022</span> *<a name="line.22"></a> +<span class="sourceLineNo">023</span> * @since 1.2.1<a name="line.23"></a> +<span class="sourceLineNo">024</span> *<a name="line.24"></a> +<span class="sourceLineNo">025</span> * @see FileItem<a name="line.25"></a> +<span class="sourceLineNo">026</span> * @see FileItemStream<a name="line.26"></a> +<span class="sourceLineNo">027</span> *<a name="line.27"></a> +<span class="sourceLineNo">028</span> * @version $Id$<a name="line.28"></a> +<span class="sourceLineNo">029</span> */<a name="line.29"></a> +<span class="sourceLineNo">030</span>public interface FileItemHeadersSupport {<a name="line.30"></a> +<span class="sourceLineNo">031</span><a name="line.31"></a> +<span class="sourceLineNo">032</span> /**<a name="line.32"></a> +<span class="sourceLineNo">033</span> * Returns the collection of headers defined locally within this item.<a name="line.33"></a> +<span class="sourceLineNo">034</span> *<a name="line.34"></a> +<span class="sourceLineNo">035</span> * @return the {@link FileItemHeaders} present for this item.<a name="line.35"></a> +<span class="sourceLineNo">036</span> */<a name="line.36"></a> +<span class="sourceLineNo">037</span> FileItemHeaders getHeaders();<a name="line.37"></a> +<span class="sourceLineNo">038</span><a name="line.38"></a> +<span class="sourceLineNo">039</span> /**<a name="line.39"></a> +<span class="sourceLineNo">040</span> * Sets the headers read from within an item. Implementations of<a name="line.40"></a> +<span class="sourceLineNo">041</span> * {@link FileItem} or {@link FileItemStream} should implement this<a name="line.41"></a> +<span class="sourceLineNo">042</span> * interface to be able to get the raw headers found within the item<a name="line.42"></a> +<span class="sourceLineNo">043</span> * header block.<a name="line.43"></a> +<span class="sourceLineNo">044</span> *<a name="line.44"></a> +<span class="sourceLineNo">045</span> * @param headers the instance that holds onto the headers<a name="line.45"></a> +<span class="sourceLineNo">046</span> * for this instance.<a name="line.46"></a> +<span class="sourceLineNo">047</span> */<a name="line.47"></a> +<span class="sourceLineNo">048</span> void setHeaders(FileItemHeaders headers);<a name="line.48"></a> +<span class="sourceLineNo">049</span><a name="line.49"></a> +<span class="sourceLineNo">050</span>}<a name="line.50"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> Added: websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileItemIterator.html ============================================================================== --- websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileItemIterator.html (added) +++ websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileItemIterator.html Tue Jun 13 12:48:38 2017 @@ -0,0 +1,126 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<html lang="en"> +<head> +<title>Source code</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<div class="sourceContainer"> +<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> +<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> +<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> +<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> +<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a> +<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> +<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> +<span class="sourceLineNo">008</span> *<a name="line.8"></a> +<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> +<span class="sourceLineNo">010</span> *<a name="line.10"></a> +<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> +<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> +<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> +<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a> +<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a> +<span class="sourceLineNo">016</span> */<a name="line.16"></a> +<span class="sourceLineNo">017</span>package org.apache.commons.fileupload;<a name="line.17"></a> +<span class="sourceLineNo">018</span><a name="line.18"></a> +<span class="sourceLineNo">019</span>import java.io.IOException;<a name="line.19"></a> +<span class="sourceLineNo">020</span><a name="line.20"></a> +<span class="sourceLineNo">021</span>/**<a name="line.21"></a> +<span class="sourceLineNo">022</span> * An iterator, as returned by<a name="line.22"></a> +<span class="sourceLineNo">023</span> * {@link FileUploadBase#getItemIterator(RequestContext)}.<a name="line.23"></a> +<span class="sourceLineNo">024</span> *<a name="line.24"></a> +<span class="sourceLineNo">025</span> * @version $Id$<a name="line.25"></a> +<span class="sourceLineNo">026</span> */<a name="line.26"></a> +<span class="sourceLineNo">027</span>public interface FileItemIterator {<a name="line.27"></a> +<span class="sourceLineNo">028</span><a name="line.28"></a> +<span class="sourceLineNo">029</span> /**<a name="line.29"></a> +<span class="sourceLineNo">030</span> * Returns, whether another instance of {@link FileItemStream}<a name="line.30"></a> +<span class="sourceLineNo">031</span> * is available.<a name="line.31"></a> +<span class="sourceLineNo">032</span> *<a name="line.32"></a> +<span class="sourceLineNo">033</span> * @throws FileUploadException Parsing or processing the<a name="line.33"></a> +<span class="sourceLineNo">034</span> * file item failed.<a name="line.34"></a> +<span class="sourceLineNo">035</span> * @throws IOException Reading the file item failed.<a name="line.35"></a> +<span class="sourceLineNo">036</span> * @return True, if one or more additional file items<a name="line.36"></a> +<span class="sourceLineNo">037</span> * are available, otherwise false.<a name="line.37"></a> +<span class="sourceLineNo">038</span> */<a name="line.38"></a> +<span class="sourceLineNo">039</span> boolean hasNext() throws FileUploadException, IOException;<a name="line.39"></a> +<span class="sourceLineNo">040</span><a name="line.40"></a> +<span class="sourceLineNo">041</span> /**<a name="line.41"></a> +<span class="sourceLineNo">042</span> * Returns the next available {@link FileItemStream}.<a name="line.42"></a> +<span class="sourceLineNo">043</span> *<a name="line.43"></a> +<span class="sourceLineNo">044</span> * @throws java.util.NoSuchElementException No more items are available. Use<a name="line.44"></a> +<span class="sourceLineNo">045</span> * {@link #hasNext()} to prevent this exception.<a name="line.45"></a> +<span class="sourceLineNo">046</span> * @throws FileUploadException Parsing or processing the<a name="line.46"></a> +<span class="sourceLineNo">047</span> * file item failed.<a name="line.47"></a> +<span class="sourceLineNo">048</span> * @throws IOException Reading the file item failed.<a name="line.48"></a> +<span class="sourceLineNo">049</span> * @return FileItemStream instance, which provides<a name="line.49"></a> +<span class="sourceLineNo">050</span> * access to the next file item.<a name="line.50"></a> +<span class="sourceLineNo">051</span> */<a name="line.51"></a> +<span class="sourceLineNo">052</span> FileItemStream next() throws FileUploadException, IOException;<a name="line.52"></a> +<span class="sourceLineNo">053</span><a name="line.53"></a> +<span class="sourceLineNo">054</span>}<a name="line.54"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> Added: websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileItemStream.ItemSkippedException.html ============================================================================== --- websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileItemStream.ItemSkippedException.html (added) +++ websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileItemStream.ItemSkippedException.html Tue Jun 13 12:48:38 2017 @@ -0,0 +1,176 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<html lang="en"> +<head> +<title>Source code</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<div class="sourceContainer"> +<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> +<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> +<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> +<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> +<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a> +<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> +<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> +<span class="sourceLineNo">008</span> *<a name="line.8"></a> +<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> +<span class="sourceLineNo">010</span> *<a name="line.10"></a> +<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> +<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> +<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> +<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a> +<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a> +<span class="sourceLineNo">016</span> */<a name="line.16"></a> +<span class="sourceLineNo">017</span>package org.apache.commons.fileupload;<a name="line.17"></a> +<span class="sourceLineNo">018</span><a name="line.18"></a> +<span class="sourceLineNo">019</span>import java.io.IOException;<a name="line.19"></a> +<span class="sourceLineNo">020</span>import java.io.InputStream;<a name="line.20"></a> +<span class="sourceLineNo">021</span><a name="line.21"></a> +<span class="sourceLineNo">022</span>/**<a name="line.22"></a> +<span class="sourceLineNo">023</span> * <p> This interface provides access to a file or form item that was<a name="line.23"></a> +<span class="sourceLineNo">024</span> * received within a <code>multipart/form-data</code> POST request.<a name="line.24"></a> +<span class="sourceLineNo">025</span> * The items contents are retrieved by calling {@link #openStream()}.</p><a name="line.25"></a> +<span class="sourceLineNo">026</span> * <p>Instances of this class are created by accessing the<a name="line.26"></a> +<span class="sourceLineNo">027</span> * iterator, returned by<a name="line.27"></a> +<span class="sourceLineNo">028</span> * {@link FileUploadBase#getItemIterator(RequestContext)}.</p><a name="line.28"></a> +<span class="sourceLineNo">029</span> * <p><em>Note</em>: There is an interaction between the iterator and<a name="line.29"></a> +<span class="sourceLineNo">030</span> * its associated instances of {@link FileItemStream}: By invoking<a name="line.30"></a> +<span class="sourceLineNo">031</span> * {@link java.util.Iterator#hasNext()} on the iterator, you discard all data,<a name="line.31"></a> +<span class="sourceLineNo">032</span> * which hasn't been read so far from the previous data.</p><a name="line.32"></a> +<span class="sourceLineNo">033</span> *<a name="line.33"></a> +<span class="sourceLineNo">034</span> * @version $Id$<a name="line.34"></a> +<span class="sourceLineNo">035</span> */<a name="line.35"></a> +<span class="sourceLineNo">036</span>public interface FileItemStream extends FileItemHeadersSupport {<a name="line.36"></a> +<span class="sourceLineNo">037</span><a name="line.37"></a> +<span class="sourceLineNo">038</span> /**<a name="line.38"></a> +<span class="sourceLineNo">039</span> * This exception is thrown, if an attempt is made to read<a name="line.39"></a> +<span class="sourceLineNo">040</span> * data from the {@link InputStream}, which has been returned<a name="line.40"></a> +<span class="sourceLineNo">041</span> * by {@link FileItemStream#openStream()}, after<a name="line.41"></a> +<span class="sourceLineNo">042</span> * {@link java.util.Iterator#hasNext()} has been invoked on the<a name="line.42"></a> +<span class="sourceLineNo">043</span> * iterator, which created the {@link FileItemStream}.<a name="line.43"></a> +<span class="sourceLineNo">044</span> */<a name="line.44"></a> +<span class="sourceLineNo">045</span> public static class ItemSkippedException extends IOException {<a name="line.45"></a> +<span class="sourceLineNo">046</span><a name="line.46"></a> +<span class="sourceLineNo">047</span> /**<a name="line.47"></a> +<span class="sourceLineNo">048</span> * The exceptions serial version UID, which is being used<a name="line.48"></a> +<span class="sourceLineNo">049</span> * when serializing an exception instance.<a name="line.49"></a> +<span class="sourceLineNo">050</span> */<a name="line.50"></a> +<span class="sourceLineNo">051</span> private static final long serialVersionUID = -7280778431581963740L;<a name="line.51"></a> +<span class="sourceLineNo">052</span><a name="line.52"></a> +<span class="sourceLineNo">053</span> }<a name="line.53"></a> +<span class="sourceLineNo">054</span><a name="line.54"></a> +<span class="sourceLineNo">055</span> /**<a name="line.55"></a> +<span class="sourceLineNo">056</span> * Creates an {@link InputStream}, which allows to read the<a name="line.56"></a> +<span class="sourceLineNo">057</span> * items contents.<a name="line.57"></a> +<span class="sourceLineNo">058</span> *<a name="line.58"></a> +<span class="sourceLineNo">059</span> * @return The input stream, from which the items data may<a name="line.59"></a> +<span class="sourceLineNo">060</span> * be read.<a name="line.60"></a> +<span class="sourceLineNo">061</span> * @throws IllegalStateException The method was already invoked on<a name="line.61"></a> +<span class="sourceLineNo">062</span> * this item. It is not possible to recreate the data stream.<a name="line.62"></a> +<span class="sourceLineNo">063</span> * @throws IOException An I/O error occurred.<a name="line.63"></a> +<span class="sourceLineNo">064</span> * @see ItemSkippedException<a name="line.64"></a> +<span class="sourceLineNo">065</span> */<a name="line.65"></a> +<span class="sourceLineNo">066</span> InputStream openStream() throws IOException;<a name="line.66"></a> +<span class="sourceLineNo">067</span><a name="line.67"></a> +<span class="sourceLineNo">068</span> /**<a name="line.68"></a> +<span class="sourceLineNo">069</span> * Returns the content type passed by the browser or <code>null</code> if<a name="line.69"></a> +<span class="sourceLineNo">070</span> * not defined.<a name="line.70"></a> +<span class="sourceLineNo">071</span> *<a name="line.71"></a> +<span class="sourceLineNo">072</span> * @return The content type passed by the browser or <code>null</code> if<a name="line.72"></a> +<span class="sourceLineNo">073</span> * not defined.<a name="line.73"></a> +<span class="sourceLineNo">074</span> */<a name="line.74"></a> +<span class="sourceLineNo">075</span> String getContentType();<a name="line.75"></a> +<span class="sourceLineNo">076</span><a name="line.76"></a> +<span class="sourceLineNo">077</span> /**<a name="line.77"></a> +<span class="sourceLineNo">078</span> * Returns the original filename in the client's filesystem, as provided by<a name="line.78"></a> +<span class="sourceLineNo">079</span> * the browser (or other client software). In most cases, this will be the<a name="line.79"></a> +<span class="sourceLineNo">080</span> * base file name, without path information. However, some clients, such as<a name="line.80"></a> +<span class="sourceLineNo">081</span> * the Opera browser, do include path information.<a name="line.81"></a> +<span class="sourceLineNo">082</span> *<a name="line.82"></a> +<span class="sourceLineNo">083</span> * @return The original filename in the client's filesystem.<a name="line.83"></a> +<span class="sourceLineNo">084</span> */<a name="line.84"></a> +<span class="sourceLineNo">085</span> String getName();<a name="line.85"></a> +<span class="sourceLineNo">086</span><a name="line.86"></a> +<span class="sourceLineNo">087</span> /**<a name="line.87"></a> +<span class="sourceLineNo">088</span> * Returns the name of the field in the multipart form corresponding to<a name="line.88"></a> +<span class="sourceLineNo">089</span> * this file item.<a name="line.89"></a> +<span class="sourceLineNo">090</span> *<a name="line.90"></a> +<span class="sourceLineNo">091</span> * @return The name of the form field.<a name="line.91"></a> +<span class="sourceLineNo">092</span> */<a name="line.92"></a> +<span class="sourceLineNo">093</span> String getFieldName();<a name="line.93"></a> +<span class="sourceLineNo">094</span><a name="line.94"></a> +<span class="sourceLineNo">095</span> /**<a name="line.95"></a> +<span class="sourceLineNo">096</span> * Determines whether or not a <code>FileItem</code> instance represents<a name="line.96"></a> +<span class="sourceLineNo">097</span> * a simple form field.<a name="line.97"></a> +<span class="sourceLineNo">098</span> *<a name="line.98"></a> +<span class="sourceLineNo">099</span> * @return <code>true</code> if the instance represents a simple form<a name="line.99"></a> +<span class="sourceLineNo">100</span> * field; <code>false</code> if it represents an uploaded file.<a name="line.100"></a> +<span class="sourceLineNo">101</span> */<a name="line.101"></a> +<span class="sourceLineNo">102</span> boolean isFormField();<a name="line.102"></a> +<span class="sourceLineNo">103</span><a name="line.103"></a> +<span class="sourceLineNo">104</span>}<a name="line.104"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> Added: websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileItemStream.html ============================================================================== --- websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileItemStream.html (added) +++ websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileItemStream.html Tue Jun 13 12:48:38 2017 @@ -0,0 +1,176 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<html lang="en"> +<head> +<title>Source code</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<div class="sourceContainer"> +<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> +<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> +<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> +<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> +<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a> +<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> +<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> +<span class="sourceLineNo">008</span> *<a name="line.8"></a> +<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> +<span class="sourceLineNo">010</span> *<a name="line.10"></a> +<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> +<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> +<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> +<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a> +<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a> +<span class="sourceLineNo">016</span> */<a name="line.16"></a> +<span class="sourceLineNo">017</span>package org.apache.commons.fileupload;<a name="line.17"></a> +<span class="sourceLineNo">018</span><a name="line.18"></a> +<span class="sourceLineNo">019</span>import java.io.IOException;<a name="line.19"></a> +<span class="sourceLineNo">020</span>import java.io.InputStream;<a name="line.20"></a> +<span class="sourceLineNo">021</span><a name="line.21"></a> +<span class="sourceLineNo">022</span>/**<a name="line.22"></a> +<span class="sourceLineNo">023</span> * <p> This interface provides access to a file or form item that was<a name="line.23"></a> +<span class="sourceLineNo">024</span> * received within a <code>multipart/form-data</code> POST request.<a name="line.24"></a> +<span class="sourceLineNo">025</span> * The items contents are retrieved by calling {@link #openStream()}.</p><a name="line.25"></a> +<span class="sourceLineNo">026</span> * <p>Instances of this class are created by accessing the<a name="line.26"></a> +<span class="sourceLineNo">027</span> * iterator, returned by<a name="line.27"></a> +<span class="sourceLineNo">028</span> * {@link FileUploadBase#getItemIterator(RequestContext)}.</p><a name="line.28"></a> +<span class="sourceLineNo">029</span> * <p><em>Note</em>: There is an interaction between the iterator and<a name="line.29"></a> +<span class="sourceLineNo">030</span> * its associated instances of {@link FileItemStream}: By invoking<a name="line.30"></a> +<span class="sourceLineNo">031</span> * {@link java.util.Iterator#hasNext()} on the iterator, you discard all data,<a name="line.31"></a> +<span class="sourceLineNo">032</span> * which hasn't been read so far from the previous data.</p><a name="line.32"></a> +<span class="sourceLineNo">033</span> *<a name="line.33"></a> +<span class="sourceLineNo">034</span> * @version $Id$<a name="line.34"></a> +<span class="sourceLineNo">035</span> */<a name="line.35"></a> +<span class="sourceLineNo">036</span>public interface FileItemStream extends FileItemHeadersSupport {<a name="line.36"></a> +<span class="sourceLineNo">037</span><a name="line.37"></a> +<span class="sourceLineNo">038</span> /**<a name="line.38"></a> +<span class="sourceLineNo">039</span> * This exception is thrown, if an attempt is made to read<a name="line.39"></a> +<span class="sourceLineNo">040</span> * data from the {@link InputStream}, which has been returned<a name="line.40"></a> +<span class="sourceLineNo">041</span> * by {@link FileItemStream#openStream()}, after<a name="line.41"></a> +<span class="sourceLineNo">042</span> * {@link java.util.Iterator#hasNext()} has been invoked on the<a name="line.42"></a> +<span class="sourceLineNo">043</span> * iterator, which created the {@link FileItemStream}.<a name="line.43"></a> +<span class="sourceLineNo">044</span> */<a name="line.44"></a> +<span class="sourceLineNo">045</span> public static class ItemSkippedException extends IOException {<a name="line.45"></a> +<span class="sourceLineNo">046</span><a name="line.46"></a> +<span class="sourceLineNo">047</span> /**<a name="line.47"></a> +<span class="sourceLineNo">048</span> * The exceptions serial version UID, which is being used<a name="line.48"></a> +<span class="sourceLineNo">049</span> * when serializing an exception instance.<a name="line.49"></a> +<span class="sourceLineNo">050</span> */<a name="line.50"></a> +<span class="sourceLineNo">051</span> private static final long serialVersionUID = -7280778431581963740L;<a name="line.51"></a> +<span class="sourceLineNo">052</span><a name="line.52"></a> +<span class="sourceLineNo">053</span> }<a name="line.53"></a> +<span class="sourceLineNo">054</span><a name="line.54"></a> +<span class="sourceLineNo">055</span> /**<a name="line.55"></a> +<span class="sourceLineNo">056</span> * Creates an {@link InputStream}, which allows to read the<a name="line.56"></a> +<span class="sourceLineNo">057</span> * items contents.<a name="line.57"></a> +<span class="sourceLineNo">058</span> *<a name="line.58"></a> +<span class="sourceLineNo">059</span> * @return The input stream, from which the items data may<a name="line.59"></a> +<span class="sourceLineNo">060</span> * be read.<a name="line.60"></a> +<span class="sourceLineNo">061</span> * @throws IllegalStateException The method was already invoked on<a name="line.61"></a> +<span class="sourceLineNo">062</span> * this item. It is not possible to recreate the data stream.<a name="line.62"></a> +<span class="sourceLineNo">063</span> * @throws IOException An I/O error occurred.<a name="line.63"></a> +<span class="sourceLineNo">064</span> * @see ItemSkippedException<a name="line.64"></a> +<span class="sourceLineNo">065</span> */<a name="line.65"></a> +<span class="sourceLineNo">066</span> InputStream openStream() throws IOException;<a name="line.66"></a> +<span class="sourceLineNo">067</span><a name="line.67"></a> +<span class="sourceLineNo">068</span> /**<a name="line.68"></a> +<span class="sourceLineNo">069</span> * Returns the content type passed by the browser or <code>null</code> if<a name="line.69"></a> +<span class="sourceLineNo">070</span> * not defined.<a name="line.70"></a> +<span class="sourceLineNo">071</span> *<a name="line.71"></a> +<span class="sourceLineNo">072</span> * @return The content type passed by the browser or <code>null</code> if<a name="line.72"></a> +<span class="sourceLineNo">073</span> * not defined.<a name="line.73"></a> +<span class="sourceLineNo">074</span> */<a name="line.74"></a> +<span class="sourceLineNo">075</span> String getContentType();<a name="line.75"></a> +<span class="sourceLineNo">076</span><a name="line.76"></a> +<span class="sourceLineNo">077</span> /**<a name="line.77"></a> +<span class="sourceLineNo">078</span> * Returns the original filename in the client's filesystem, as provided by<a name="line.78"></a> +<span class="sourceLineNo">079</span> * the browser (or other client software). In most cases, this will be the<a name="line.79"></a> +<span class="sourceLineNo">080</span> * base file name, without path information. However, some clients, such as<a name="line.80"></a> +<span class="sourceLineNo">081</span> * the Opera browser, do include path information.<a name="line.81"></a> +<span class="sourceLineNo">082</span> *<a name="line.82"></a> +<span class="sourceLineNo">083</span> * @return The original filename in the client's filesystem.<a name="line.83"></a> +<span class="sourceLineNo">084</span> */<a name="line.84"></a> +<span class="sourceLineNo">085</span> String getName();<a name="line.85"></a> +<span class="sourceLineNo">086</span><a name="line.86"></a> +<span class="sourceLineNo">087</span> /**<a name="line.87"></a> +<span class="sourceLineNo">088</span> * Returns the name of the field in the multipart form corresponding to<a name="line.88"></a> +<span class="sourceLineNo">089</span> * this file item.<a name="line.89"></a> +<span class="sourceLineNo">090</span> *<a name="line.90"></a> +<span class="sourceLineNo">091</span> * @return The name of the form field.<a name="line.91"></a> +<span class="sourceLineNo">092</span> */<a name="line.92"></a> +<span class="sourceLineNo">093</span> String getFieldName();<a name="line.93"></a> +<span class="sourceLineNo">094</span><a name="line.94"></a> +<span class="sourceLineNo">095</span> /**<a name="line.95"></a> +<span class="sourceLineNo">096</span> * Determines whether or not a <code>FileItem</code> instance represents<a name="line.96"></a> +<span class="sourceLineNo">097</span> * a simple form field.<a name="line.97"></a> +<span class="sourceLineNo">098</span> *<a name="line.98"></a> +<span class="sourceLineNo">099</span> * @return <code>true</code> if the instance represents a simple form<a name="line.99"></a> +<span class="sourceLineNo">100</span> * field; <code>false</code> if it represents an uploaded file.<a name="line.100"></a> +<span class="sourceLineNo">101</span> */<a name="line.101"></a> +<span class="sourceLineNo">102</span> boolean isFormField();<a name="line.102"></a> +<span class="sourceLineNo">103</span><a name="line.103"></a> +<span class="sourceLineNo">104</span>}<a name="line.104"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> Added: websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileUpload.html ============================================================================== --- websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileUpload.html (added) +++ websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/FileUpload.html Tue Jun 13 12:48:38 2017 @@ -0,0 +1,166 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<html lang="en"> +<head> +<title>Source code</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<div class="sourceContainer"> +<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> +<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> +<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> +<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> +<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a> +<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> +<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> +<span class="sourceLineNo">008</span> *<a name="line.8"></a> +<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> +<span class="sourceLineNo">010</span> *<a name="line.10"></a> +<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> +<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> +<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> +<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a> +<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a> +<span class="sourceLineNo">016</span> */<a name="line.16"></a> +<span class="sourceLineNo">017</span>package org.apache.commons.fileupload;<a name="line.17"></a> +<span class="sourceLineNo">018</span><a name="line.18"></a> +<span class="sourceLineNo">019</span>/**<a name="line.19"></a> +<span class="sourceLineNo">020</span> * <p>High level API for processing file uploads.</p><a name="line.20"></a> +<span class="sourceLineNo">021</span> *<a name="line.21"></a> +<span class="sourceLineNo">022</span> * <p>This class handles multiple files per single HTML widget, sent using<a name="line.22"></a> +<span class="sourceLineNo">023</span> * <code>multipart/mixed</code> encoding type, as specified by<a name="line.23"></a> +<span class="sourceLineNo">024</span> * <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a>. Use {@link<a name="line.24"></a> +<span class="sourceLineNo">025</span> * #parseRequest(RequestContext)} to acquire a list<a name="line.25"></a> +<span class="sourceLineNo">026</span> * of {@link org.apache.commons.fileupload.FileItem FileItems} associated<a name="line.26"></a> +<span class="sourceLineNo">027</span> * with a given HTML widget.</p><a name="line.27"></a> +<span class="sourceLineNo">028</span> *<a name="line.28"></a> +<span class="sourceLineNo">029</span> * <p>How the data for individual parts is stored is determined by the factory<a name="line.29"></a> +<span class="sourceLineNo">030</span> * used to create them; a given part may be in memory, on disk, or somewhere<a name="line.30"></a> +<span class="sourceLineNo">031</span> * else.</p><a name="line.31"></a> +<span class="sourceLineNo">032</span> *<a name="line.32"></a> +<span class="sourceLineNo">033</span> * @version $Id$<a name="line.33"></a> +<span class="sourceLineNo">034</span> */<a name="line.34"></a> +<span class="sourceLineNo">035</span>public class FileUpload<a name="line.35"></a> +<span class="sourceLineNo">036</span> extends FileUploadBase {<a name="line.36"></a> +<span class="sourceLineNo">037</span><a name="line.37"></a> +<span class="sourceLineNo">038</span> // ----------------------------------------------------------- Data members<a name="line.38"></a> +<span class="sourceLineNo">039</span><a name="line.39"></a> +<span class="sourceLineNo">040</span> /**<a name="line.40"></a> +<span class="sourceLineNo">041</span> * The factory to use to create new form items.<a name="line.41"></a> +<span class="sourceLineNo">042</span> */<a name="line.42"></a> +<span class="sourceLineNo">043</span> private FileItemFactory fileItemFactory;<a name="line.43"></a> +<span class="sourceLineNo">044</span><a name="line.44"></a> +<span class="sourceLineNo">045</span> // ----------------------------------------------------------- Constructors<a name="line.45"></a> +<span class="sourceLineNo">046</span><a name="line.46"></a> +<span class="sourceLineNo">047</span> /**<a name="line.47"></a> +<span class="sourceLineNo">048</span> * Constructs an uninitialised instance of this class.<a name="line.48"></a> +<span class="sourceLineNo">049</span> *<a name="line.49"></a> +<span class="sourceLineNo">050</span> * A factory must be<a name="line.50"></a> +<span class="sourceLineNo">051</span> * configured, using <code>setFileItemFactory()</code>, before attempting<a name="line.51"></a> +<span class="sourceLineNo">052</span> * to parse requests.<a name="line.52"></a> +<span class="sourceLineNo">053</span> *<a name="line.53"></a> +<span class="sourceLineNo">054</span> * @see #FileUpload(FileItemFactory)<a name="line.54"></a> +<span class="sourceLineNo">055</span> */<a name="line.55"></a> +<span class="sourceLineNo">056</span> public FileUpload() {<a name="line.56"></a> +<span class="sourceLineNo">057</span> super();<a name="line.57"></a> +<span class="sourceLineNo">058</span> }<a name="line.58"></a> +<span class="sourceLineNo">059</span><a name="line.59"></a> +<span class="sourceLineNo">060</span> /**<a name="line.60"></a> +<span class="sourceLineNo">061</span> * Constructs an instance of this class which uses the supplied factory to<a name="line.61"></a> +<span class="sourceLineNo">062</span> * create <code>FileItem</code> instances.<a name="line.62"></a> +<span class="sourceLineNo">063</span> *<a name="line.63"></a> +<span class="sourceLineNo">064</span> * @see #FileUpload()<a name="line.64"></a> +<span class="sourceLineNo">065</span> * @param fileItemFactory The factory to use for creating file items.<a name="line.65"></a> +<span class="sourceLineNo">066</span> */<a name="line.66"></a> +<span class="sourceLineNo">067</span> public FileUpload(FileItemFactory fileItemFactory) {<a name="line.67"></a> +<span class="sourceLineNo">068</span> super();<a name="line.68"></a> +<span class="sourceLineNo">069</span> this.fileItemFactory = fileItemFactory;<a name="line.69"></a> +<span class="sourceLineNo">070</span> }<a name="line.70"></a> +<span class="sourceLineNo">071</span><a name="line.71"></a> +<span class="sourceLineNo">072</span> // ----------------------------------------------------- Property accessors<a name="line.72"></a> +<span class="sourceLineNo">073</span><a name="line.73"></a> +<span class="sourceLineNo">074</span> /**<a name="line.74"></a> +<span class="sourceLineNo">075</span> * Returns the factory class used when creating file items.<a name="line.75"></a> +<span class="sourceLineNo">076</span> *<a name="line.76"></a> +<span class="sourceLineNo">077</span> * @return The factory class for new file items.<a name="line.77"></a> +<span class="sourceLineNo">078</span> */<a name="line.78"></a> +<span class="sourceLineNo">079</span> @Override<a name="line.79"></a> +<span class="sourceLineNo">080</span> public FileItemFactory getFileItemFactory() {<a name="line.80"></a> +<span class="sourceLineNo">081</span> return fileItemFactory;<a name="line.81"></a> +<span class="sourceLineNo">082</span> }<a name="line.82"></a> +<span class="sourceLineNo">083</span><a name="line.83"></a> +<span class="sourceLineNo">084</span> /**<a name="line.84"></a> +<span class="sourceLineNo">085</span> * Sets the factory class to use when creating file items.<a name="line.85"></a> +<span class="sourceLineNo">086</span> *<a name="line.86"></a> +<span class="sourceLineNo">087</span> * @param factory The factory class for new file items.<a name="line.87"></a> +<span class="sourceLineNo">088</span> */<a name="line.88"></a> +<span class="sourceLineNo">089</span> @Override<a name="line.89"></a> +<span class="sourceLineNo">090</span> public void setFileItemFactory(FileItemFactory factory) {<a name="line.90"></a> +<span class="sourceLineNo">091</span> this.fileItemFactory = factory;<a name="line.91"></a> +<span class="sourceLineNo">092</span> }<a name="line.92"></a> +<span class="sourceLineNo">093</span><a name="line.93"></a> +<span class="sourceLineNo">094</span>}<a name="line.94"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html>
