| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <main role="main"> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span><a id="line.1">package org.apache.fulcrum.upload;</a> |
| <span class="sourceLineNo">002</span><a id="line.2"></a> |
| <span class="sourceLineNo">003</span><a id="line.3">/*</a> |
| <span class="sourceLineNo">004</span><a id="line.4"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> *</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">019</span><a id="line.19"> * under the License.</a> |
| <span class="sourceLineNo">020</span><a id="line.20"> */</a> |
| <span class="sourceLineNo">021</span><a id="line.21"></a> |
| <span class="sourceLineNo">022</span><a id="line.22">import java.util.List;</a> |
| <span class="sourceLineNo">023</span><a id="line.23"></a> |
| <span class="sourceLineNo">024</span><a id="line.24">import javax.portlet.ActionRequest;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import javax.servlet.http.HttpServletRequest;</a> |
| <span class="sourceLineNo">026</span><a id="line.26"></a> |
| <span class="sourceLineNo">027</span><a id="line.27">import org.apache.avalon.framework.service.ServiceException;</a> |
| <span class="sourceLineNo">028</span><a id="line.28">import org.apache.commons.fileupload.FileItem;</a> |
| <span class="sourceLineNo">029</span><a id="line.29">import org.apache.commons.fileupload.FileItemIterator;</a> |
| <span class="sourceLineNo">030</span><a id="line.30"></a> |
| <span class="sourceLineNo">031</span><a id="line.31">/**</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * <p></a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * This service handles parsing <code>multipart/form-data</code> POST requests</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * and turning them into form fields and uploaded files. This can be either</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * performed automatically by the <code>org.apache.fulcrum.parser.ParameterParser</code> or manually by a user</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * defined <code>org.apache.turbine.modules.Action</code>.</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> *</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a></a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * @author <a href="mailto:dlr@collab.net">Daniel Rall</a></a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * @version $Id$</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> */</a> |
| <span class="sourceLineNo">042</span><a id="line.42">public interface UploadService</a> |
| <span class="sourceLineNo">043</span><a id="line.43"></a> |
| <span class="sourceLineNo">044</span><a id="line.44">{</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> /** Avalon Identifier **/</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> String ROLE = UploadService.class.getName();</a> |
| <span class="sourceLineNo">047</span><a id="line.47"></a> |
| <span class="sourceLineNo">048</span><a id="line.48"> /**</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * HTTP header.</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> */</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> String CONTENT_TYPE = "Content-type";</a> |
| <span class="sourceLineNo">052</span><a id="line.52"></a> |
| <span class="sourceLineNo">053</span><a id="line.53"> /**</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * HTTP header.</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> */</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> String CONTENT_DISPOSITION = "Content-disposition";</a> |
| <span class="sourceLineNo">057</span><a id="line.57"></a> |
| <span class="sourceLineNo">058</span><a id="line.58"> /**</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> * HTTP header base type.</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> */</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> String MULTIPART = "multipart";</a> |
| <span class="sourceLineNo">062</span><a id="line.62"></a> |
| <span class="sourceLineNo">063</span><a id="line.63"> /**</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> * HTTP header base type modifier.</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> */</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> String FORM_DATA = "form-data";</a> |
| <span class="sourceLineNo">067</span><a id="line.67"></a> |
| <span class="sourceLineNo">068</span><a id="line.68"> /**</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> * HTTP header base type modifier.</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> */</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> String MIXED = "mixed";</a> |
| <span class="sourceLineNo">072</span><a id="line.72"></a> |
| <span class="sourceLineNo">073</span><a id="line.73"> /**</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> * HTTP header.</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> */</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> String MULTIPART_FORM_DATA = MULTIPART + '/' + FORM_DATA;</a> |
| <span class="sourceLineNo">077</span><a id="line.77"></a> |
| <span class="sourceLineNo">078</span><a id="line.78"> /**</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> * HTTP header.</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> */</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> String MULTIPART_MIXED = MULTIPART + '/' + MIXED;</a> |
| <span class="sourceLineNo">082</span><a id="line.82"></a> |
| <span class="sourceLineNo">083</span><a id="line.83"> /**</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> * The request parameter name for overriding 'repository' property (path).</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> */</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> String REPOSITORY_PARAMETER = "path";</a> |
| <span class="sourceLineNo">087</span><a id="line.87"></a> |
| <span class="sourceLineNo">088</span><a id="line.88"> /**</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> * The key in UploadService properties in TurbineResources.properties</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> * 'repository' property.</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> */</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> String REPOSITORY_KEY = "repository";</a> |
| <span class="sourceLineNo">093</span><a id="line.93"></a> |
| <span class="sourceLineNo">094</span><a id="line.94"> /**</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> * <p></a> |
| <span class="sourceLineNo">096</span><a id="line.96"> * The default value of 'repository' property (.). This is the directory where</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> * uploaded files will get stored temporarily. Note that "." is whatever the</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> * servlet container chooses to be it's 'current directory'.</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> */</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> String REPOSITORY_DEFAULT = ".";</a> |
| <span class="sourceLineNo">101</span><a id="line.101"></a> |
| <span class="sourceLineNo">102</span><a id="line.102"> /**</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> * w The key in UploadService properties in service configuration 'sizeMax'</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> * property.</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> */</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> String SIZE_MAX_KEY = "sizeMax";</a> |
| <span class="sourceLineNo">107</span><a id="line.107"></a> |
| <span class="sourceLineNo">108</span><a id="line.108"> /**</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> * <p></a> |
| <span class="sourceLineNo">110</span><a id="line.110"> * The default value of 'sizMax' property (1 megabyte = 1048576 bytes). This is</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> * the maximum size of POST request that will be parsed by the uploader. If you</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> * need to set specific limits for your users, set this property to the largest</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> * limit value, and use an action + no auto upload to enforce limits.</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> *</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> */</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> int SIZE_MAX_DEFAULT = 1048576;</a> |
| <span class="sourceLineNo">117</span><a id="line.117"></a> |
| <span class="sourceLineNo">118</span><a id="line.118"> /**</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> * The key in UploadService properties in TurbineResources.properties</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> * 'sizeThreshold' property.</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> */</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> String SIZE_THRESHOLD_KEY = "sizeThreshold";</a> |
| <span class="sourceLineNo">123</span><a id="line.123"></a> |
| <span class="sourceLineNo">124</span><a id="line.124"> /**</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> * <p></a> |
| <span class="sourceLineNo">126</span><a id="line.126"> * The default value of 'sizeThreshold' property (10 kilobytes = 10240 bytes).</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> * This is the maximum size of a POST request that will have it's components</a> |
| <span class="sourceLineNo">128</span><a id="line.128"> * stored temporarily in memory, instead of disk.</a> |
| <span class="sourceLineNo">129</span><a id="line.129"> */</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> int SIZE_THRESHOLD_DEFAULT = 10240;</a> |
| <span class="sourceLineNo">131</span><a id="line.131"></a> |
| <span class="sourceLineNo">132</span><a id="line.132"> /**</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> * The key in UploadService properties in TurbineResources.properties</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> * 'headerEncoding' property.</a> |
| <span class="sourceLineNo">135</span><a id="line.135"> */</a> |
| <span class="sourceLineNo">136</span><a id="line.136"> String HEADER_ENCODING_KEY = "headerEncoding";</a> |
| <span class="sourceLineNo">137</span><a id="line.137"></a> |
| <span class="sourceLineNo">138</span><a id="line.138"> /**</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> * <p></a> |
| <span class="sourceLineNo">140</span><a id="line.140"> * The default value of 'headerEncoding' property (.). The value has been</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> * decided by copying from DiskFileItem class</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> */</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> String HEADER_ENCODING_DEFAULT = "ISO-8859-1";</a> |
| <span class="sourceLineNo">144</span><a id="line.144"></a> |
| <span class="sourceLineNo">145</span><a id="line.145"> /**</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> * <p></a> |
| <span class="sourceLineNo">147</span><a id="line.147"> * Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant</a> |
| <span class="sourceLineNo">148</span><a id="line.148"> * <code>multipart/form-data</code> stream.</a> |
| <span class="sourceLineNo">149</span><a id="line.149"> * </p></a> |
| <span class="sourceLineNo">150</span><a id="line.150"> *</a> |
| <span class="sourceLineNo">151</span><a id="line.151"> * @param req The servlet request to be parsed.</a> |
| <span class="sourceLineNo">152</span><a id="line.152"> * @return list of file items</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> * @throws ServiceException Problems reading/parsing the request or storing</a> |
| <span class="sourceLineNo">154</span><a id="line.154"> * the uploaded file(s).</a> |
| <span class="sourceLineNo">155</span><a id="line.155"> */</a> |
| <span class="sourceLineNo">156</span><a id="line.156"> List<FileItem> parseRequest(HttpServletRequest req) throws ServiceException;</a> |
| <span class="sourceLineNo">157</span><a id="line.157"></a> |
| <span class="sourceLineNo">158</span><a id="line.158"> /**</a> |
| <span class="sourceLineNo">159</span><a id="line.159"> * <p></a> |
| <span class="sourceLineNo">160</span><a id="line.160"> * Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant</a> |
| <span class="sourceLineNo">161</span><a id="line.161"> * <code>multipart/form-data</code> stream.</a> |
| <span class="sourceLineNo">162</span><a id="line.162"> * </p></a> |
| <span class="sourceLineNo">163</span><a id="line.163"> *</a> |
| <span class="sourceLineNo">164</span><a id="line.164"> * @param req The servlet request to be parsed.</a> |
| <span class="sourceLineNo">165</span><a id="line.165"> * @param path The location where the files should be stored.</a> |
| <span class="sourceLineNo">166</span><a id="line.166"> * @return List of FileItem parts</a> |
| <span class="sourceLineNo">167</span><a id="line.167"> * @throws ServiceException Problems reading/parsing the request or storing</a> |
| <span class="sourceLineNo">168</span><a id="line.168"> * the uploaded file(s).</a> |
| <span class="sourceLineNo">169</span><a id="line.169"> */</a> |
| <span class="sourceLineNo">170</span><a id="line.170"> List<FileItem> parseRequest(HttpServletRequest req, String path) throws ServiceException;</a> |
| <span class="sourceLineNo">171</span><a id="line.171"></a> |
| <span class="sourceLineNo">172</span><a id="line.172"> /**</a> |
| <span class="sourceLineNo">173</span><a id="line.173"> * <p></a> |
| <span class="sourceLineNo">174</span><a id="line.174"> * Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant</a> |
| <span class="sourceLineNo">175</span><a id="line.175"> * <code>multipart/form-data</code> stream.</a> |
| <span class="sourceLineNo">176</span><a id="line.176"> * </p></a> |
| <span class="sourceLineNo">177</span><a id="line.177"> *</a> |
| <span class="sourceLineNo">178</span><a id="line.178"> * @param req The servlet request to be parsed.</a> |
| <span class="sourceLineNo">179</span><a id="line.179"> * @param sizeThreshold the max size in bytes to be stored in memory</a> |
| <span class="sourceLineNo">180</span><a id="line.180"> * @param sizeMax the maximum allowed upload size in bytes</a> |
| <span class="sourceLineNo">181</span><a id="line.181"> * @param path The location where the files should be stored.</a> |
| <span class="sourceLineNo">182</span><a id="line.182"> * @return List of FileItem parts</a> |
| <span class="sourceLineNo">183</span><a id="line.183"> * @throws ServiceException Problems reading/parsing the request or storing</a> |
| <span class="sourceLineNo">184</span><a id="line.184"> * the uploaded file(s).</a> |
| <span class="sourceLineNo">185</span><a id="line.185"> */</a> |
| <span class="sourceLineNo">186</span><a id="line.186"> List<FileItem> parseRequest(HttpServletRequest req, int sizeThreshold, int sizeMax, String path)</a> |
| <span class="sourceLineNo">187</span><a id="line.187"> throws ServiceException;</a> |
| <span class="sourceLineNo">188</span><a id="line.188"></a> |
| <span class="sourceLineNo">189</span><a id="line.189"> /**</a> |
| <span class="sourceLineNo">190</span><a id="line.190"> * Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a></a> |
| <span class="sourceLineNo">191</span><a id="line.191"> * compliant <code>multipart/form-data</code> stream.</a> |
| <span class="sourceLineNo">192</span><a id="line.192"> *</a> |
| <span class="sourceLineNo">193</span><a id="line.193"> * @param req The servlet request to be parsed.</a> |
| <span class="sourceLineNo">194</span><a id="line.194"> *</a> |
| <span class="sourceLineNo">195</span><a id="line.195"> * @return An iterator to instances of <code>FileItemStream</code> parsed from</a> |
| <span class="sourceLineNo">196</span><a id="line.196"> * the request, in the order that they were transmitted.</a> |
| <span class="sourceLineNo">197</span><a id="line.197"> *</a> |
| <span class="sourceLineNo">198</span><a id="line.198"> * @throws ServiceException if there are problems reading/parsing the request or</a> |
| <span class="sourceLineNo">199</span><a id="line.199"> * storing files. This may also be a network error</a> |
| <span class="sourceLineNo">200</span><a id="line.200"> * while communicating with the client or a problem</a> |
| <span class="sourceLineNo">201</span><a id="line.201"> * while storing the uploaded content.</a> |
| <span class="sourceLineNo">202</span><a id="line.202"> */</a> |
| <span class="sourceLineNo">203</span><a id="line.203"> FileItemIterator getItemIterator(HttpServletRequest req) throws ServiceException;</a> |
| <span class="sourceLineNo">204</span><a id="line.204"></a> |
| <span class="sourceLineNo">205</span><a id="line.205"> /**</a> |
| <span class="sourceLineNo">206</span><a id="line.206"> * <p></a> |
| <span class="sourceLineNo">207</span><a id="line.207"> * Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant</a> |
| <span class="sourceLineNo">208</span><a id="line.208"> * <code>multipart/form-data</code> stream.</a> |
| <span class="sourceLineNo">209</span><a id="line.209"> * </p></a> |
| <span class="sourceLineNo">210</span><a id="line.210"> *</a> |
| <span class="sourceLineNo">211</span><a id="line.211"> * @param req The portlet request to be parsed.</a> |
| <span class="sourceLineNo">212</span><a id="line.212"> * @return List of FileItem parts</a> |
| <span class="sourceLineNo">213</span><a id="line.213"> * @throws ServiceException Problems reading/parsing the request or storing</a> |
| <span class="sourceLineNo">214</span><a id="line.214"> * the uploaded file(s).</a> |
| <span class="sourceLineNo">215</span><a id="line.215"> */</a> |
| <span class="sourceLineNo">216</span><a id="line.216"> List<FileItem> parseRequest(ActionRequest req) throws ServiceException;</a> |
| <span class="sourceLineNo">217</span><a id="line.217"></a> |
| <span class="sourceLineNo">218</span><a id="line.218"> /**</a> |
| <span class="sourceLineNo">219</span><a id="line.219"> * <p></a> |
| <span class="sourceLineNo">220</span><a id="line.220"> * Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant</a> |
| <span class="sourceLineNo">221</span><a id="line.221"> * <code>multipart/form-data</code> stream.</a> |
| <span class="sourceLineNo">222</span><a id="line.222"> * </p></a> |
| <span class="sourceLineNo">223</span><a id="line.223"> *</a> |
| <span class="sourceLineNo">224</span><a id="line.224"> * @param req The portlet request to be parsed.</a> |
| <span class="sourceLineNo">225</span><a id="line.225"> * @param path The location where the files should be stored.</a> |
| <span class="sourceLineNo">226</span><a id="line.226"> * @return List of FileItem parts</a> |
| <span class="sourceLineNo">227</span><a id="line.227"> * @throws ServiceException Problems reading/parsing the request or storing</a> |
| <span class="sourceLineNo">228</span><a id="line.228"> * the uploaded file(s).</a> |
| <span class="sourceLineNo">229</span><a id="line.229"> */</a> |
| <span class="sourceLineNo">230</span><a id="line.230"> List<FileItem> parseRequest(ActionRequest req, String path) throws ServiceException;</a> |
| <span class="sourceLineNo">231</span><a id="line.231"></a> |
| <span class="sourceLineNo">232</span><a id="line.232"> /**</a> |
| <span class="sourceLineNo">233</span><a id="line.233"> * <p></a> |
| <span class="sourceLineNo">234</span><a id="line.234"> * Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant</a> |
| <span class="sourceLineNo">235</span><a id="line.235"> * <code>multipart/form-data</code> stream.</a> |
| <span class="sourceLineNo">236</span><a id="line.236"> * </p></a> |
| <span class="sourceLineNo">237</span><a id="line.237"> *</a> |
| <span class="sourceLineNo">238</span><a id="line.238"> * @param req The portlet request to be parsed.</a> |
| <span class="sourceLineNo">239</span><a id="line.239"> * @param sizeThreshold the max size in bytes to be stored in memory</a> |
| <span class="sourceLineNo">240</span><a id="line.240"> * @param sizeMax the maximum allowed upload size in bytes</a> |
| <span class="sourceLineNo">241</span><a id="line.241"> * @param path The location where the files should be stored.</a> |
| <span class="sourceLineNo">242</span><a id="line.242"> * @return The list of FileItem parts uploaded </a> |
| <span class="sourceLineNo">243</span><a id="line.243"> * @throws ServiceException Problems reading/parsing the request or storing</a> |
| <span class="sourceLineNo">244</span><a id="line.244"> * the uploaded file(s).</a> |
| <span class="sourceLineNo">245</span><a id="line.245"> */</a> |
| <span class="sourceLineNo">246</span><a id="line.246"> List<FileItem> parseRequest(ActionRequest req, int sizeThreshold, int sizeMax, String path) throws ServiceException;</a> |
| <span class="sourceLineNo">247</span><a id="line.247"></a> |
| <span class="sourceLineNo">248</span><a id="line.248"> /**</a> |
| <span class="sourceLineNo">249</span><a id="line.249"> * Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a></a> |
| <span class="sourceLineNo">250</span><a id="line.250"> * compliant <code>multipart/form-data</code> stream.</a> |
| <span class="sourceLineNo">251</span><a id="line.251"> *</a> |
| <span class="sourceLineNo">252</span><a id="line.252"> * @param req The portlet request to be parsed.</a> |
| <span class="sourceLineNo">253</span><a id="line.253"> *</a> |
| <span class="sourceLineNo">254</span><a id="line.254"> * @return An iterator to instances of <code>FileItemStream</code> parsed from</a> |
| <span class="sourceLineNo">255</span><a id="line.255"> * the request, in the order that they were transmitted.</a> |
| <span class="sourceLineNo">256</span><a id="line.256"> *</a> |
| <span class="sourceLineNo">257</span><a id="line.257"> * @throws ServiceException if there are problems reading/parsing the request or</a> |
| <span class="sourceLineNo">258</span><a id="line.258"> * storing files. This may also be a network error</a> |
| <span class="sourceLineNo">259</span><a id="line.259"> * while communicating with the client or a problem</a> |
| <span class="sourceLineNo">260</span><a id="line.260"> * while storing the uploaded content.</a> |
| <span class="sourceLineNo">261</span><a id="line.261"> */</a> |
| <span class="sourceLineNo">262</span><a id="line.262"> FileItemIterator getItemIterator(ActionRequest req) throws ServiceException;</a> |
| <span class="sourceLineNo">263</span><a id="line.263"></a> |
| <span class="sourceLineNo">264</span><a id="line.264"> /**</a> |
| <span class="sourceLineNo">265</span><a id="line.265"> * <p></a> |
| <span class="sourceLineNo">266</span><a id="line.266"> * Retrieves the value of <code>size.max</code> property of the</a> |
| <span class="sourceLineNo">267</span><a id="line.267"> * {@link org.apache.fulcrum.upload.UploadService}.</a> |
| <span class="sourceLineNo">268</span><a id="line.268"> *</a> |
| <span class="sourceLineNo">269</span><a id="line.269"> * @return The maximum upload size.</a> |
| <span class="sourceLineNo">270</span><a id="line.270"> */</a> |
| <span class="sourceLineNo">271</span><a id="line.271"> long getSizeMax();</a> |
| <span class="sourceLineNo">272</span><a id="line.272"></a> |
| <span class="sourceLineNo">273</span><a id="line.273"> /**</a> |
| <span class="sourceLineNo">274</span><a id="line.274"> * <p></a> |
| <span class="sourceLineNo">275</span><a id="line.275"> * Retrieves the value of <code>size.threshold</code> property of</a> |
| <span class="sourceLineNo">276</span><a id="line.276"> * {@link org.apache.fulcrum.upload.UploadService}.</a> |
| <span class="sourceLineNo">277</span><a id="line.277"> *</a> |
| <span class="sourceLineNo">278</span><a id="line.278"> * @return The threshold beyond which files are written directly to disk.</a> |
| <span class="sourceLineNo">279</span><a id="line.279"> */</a> |
| <span class="sourceLineNo">280</span><a id="line.280"> long getSizeThreshold();</a> |
| <span class="sourceLineNo">281</span><a id="line.281"></a> |
| <span class="sourceLineNo">282</span><a id="line.282"> /**</a> |
| <span class="sourceLineNo">283</span><a id="line.283"> * <p></a> |
| <span class="sourceLineNo">284</span><a id="line.284"> * Retrieves the value of the <code>repository</code> property of</a> |
| <span class="sourceLineNo">285</span><a id="line.285"> * {@link org.apache.fulcrum.upload.UploadService}.</a> |
| <span class="sourceLineNo">286</span><a id="line.286"> *</a> |
| <span class="sourceLineNo">287</span><a id="line.287"> * @return The repository.</a> |
| <span class="sourceLineNo">288</span><a id="line.288"> */</a> |
| <span class="sourceLineNo">289</span><a id="line.289"> String getRepository();</a> |
| <span class="sourceLineNo">290</span><a id="line.290"></a> |
| <span class="sourceLineNo">291</span><a id="line.291"> /**</a> |
| <span class="sourceLineNo">292</span><a id="line.292"> * <p></a> |
| <span class="sourceLineNo">293</span><a id="line.293"> * Retrieves the value of the <code>headerEncoding</code> property of</a> |
| <span class="sourceLineNo">294</span><a id="line.294"> * {@link org.apache.fulcrum.upload.UploadService}.</a> |
| <span class="sourceLineNo">295</span><a id="line.295"> *</a> |
| <span class="sourceLineNo">296</span><a id="line.296"> * @return Returns the headerEncoding.</a> |
| <span class="sourceLineNo">297</span><a id="line.297"> */</a> |
| <span class="sourceLineNo">298</span><a id="line.298"> String getHeaderEncoding();</a> |
| <span class="sourceLineNo">299</span><a id="line.299"></a> |
| <span class="sourceLineNo">300</span><a id="line.300"> /**</a> |
| <span class="sourceLineNo">301</span><a id="line.301"> * Utility method that determines whether the request contains multipart</a> |
| <span class="sourceLineNo">302</span><a id="line.302"> * content.</a> |
| <span class="sourceLineNo">303</span><a id="line.303"> *</a> |
| <span class="sourceLineNo">304</span><a id="line.304"> * @param req The servlet request to be evaluated. Must be non-null.</a> |
| <span class="sourceLineNo">305</span><a id="line.305"> *</a> |
| <span class="sourceLineNo">306</span><a id="line.306"> * @return <code>true</code> if the request is multipart; <code>false</code></a> |
| <span class="sourceLineNo">307</span><a id="line.307"> * otherwise.</a> |
| <span class="sourceLineNo">308</span><a id="line.308"> */</a> |
| <span class="sourceLineNo">309</span><a id="line.309"> boolean isMultipart(HttpServletRequest req);</a> |
| <span class="sourceLineNo">310</span><a id="line.310"></a> |
| <span class="sourceLineNo">311</span><a id="line.311"> /**</a> |
| <span class="sourceLineNo">312</span><a id="line.312"> * Utility method that determines whether the request contains multipart</a> |
| <span class="sourceLineNo">313</span><a id="line.313"> * content.</a> |
| <span class="sourceLineNo">314</span><a id="line.314"> *</a> |
| <span class="sourceLineNo">315</span><a id="line.315"> * @param req The portlet request to be evaluated. Must be non-null.</a> |
| <span class="sourceLineNo">316</span><a id="line.316"> *</a> |
| <span class="sourceLineNo">317</span><a id="line.317"> * @return <code>true</code> if the request is multipart; <code>false</code></a> |
| <span class="sourceLineNo">318</span><a id="line.318"> * otherwise.</a> |
| <span class="sourceLineNo">319</span><a id="line.319"> */</a> |
| <span class="sourceLineNo">320</span><a id="line.320"> boolean isMultipart(ActionRequest req);</a> |
| <span class="sourceLineNo">321</span><a id="line.321">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
