| <!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.io.File;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import java.io.IOException;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import java.util.List;</a> |
| <span class="sourceLineNo">025</span><a id="line.25"></a> |
| <span class="sourceLineNo">026</span><a id="line.26">import javax.portlet.ActionRequest;</a> |
| <span class="sourceLineNo">027</span><a id="line.27">import javax.servlet.http.HttpServletRequest;</a> |
| <span class="sourceLineNo">028</span><a id="line.28"></a> |
| <span class="sourceLineNo">029</span><a id="line.29">import org.apache.avalon.framework.activity.Initializable;</a> |
| <span class="sourceLineNo">030</span><a id="line.30">import org.apache.avalon.framework.configuration.Configurable;</a> |
| <span class="sourceLineNo">031</span><a id="line.31">import org.apache.avalon.framework.configuration.Configuration;</a> |
| <span class="sourceLineNo">032</span><a id="line.32">import org.apache.avalon.framework.context.Context;</a> |
| <span class="sourceLineNo">033</span><a id="line.33">import org.apache.avalon.framework.context.ContextException;</a> |
| <span class="sourceLineNo">034</span><a id="line.34">import org.apache.avalon.framework.context.Contextualizable;</a> |
| <span class="sourceLineNo">035</span><a id="line.35">import org.apache.avalon.framework.logger.AbstractLogEnabled;</a> |
| <span class="sourceLineNo">036</span><a id="line.36">import org.apache.avalon.framework.service.ServiceException;</a> |
| <span class="sourceLineNo">037</span><a id="line.37">import org.apache.commons.fileupload.FileItem;</a> |
| <span class="sourceLineNo">038</span><a id="line.38">import org.apache.commons.fileupload.FileItemIterator;</a> |
| <span class="sourceLineNo">039</span><a id="line.39">import org.apache.commons.fileupload.FileUploadException;</a> |
| <span class="sourceLineNo">040</span><a id="line.40">import org.apache.commons.fileupload.disk.DiskFileItemFactory;</a> |
| <span class="sourceLineNo">041</span><a id="line.41">import org.apache.commons.fileupload.portlet.PortletFileUpload;</a> |
| <span class="sourceLineNo">042</span><a id="line.42">import org.apache.commons.fileupload.servlet.ServletFileUpload;</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"> * <p></a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * This class is an implementation of {@link UploadService}.</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> *</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> * <p></a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * Files will be stored in temporary disk storage on in memory, depending on</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * request size, and will be available from the</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> * <code>org.apache.fulcrum.util.parser.ParameterParser</code> as</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> * <code>org.apache.commons.fileupload.FileItem</code> objects.</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> *</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * <p></a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * This implementation of {@link UploadService} handles multiple files per</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * single html form, sent using multipart/form-data encoding type, as specified</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * by RFC 1867. Use</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * <code>org.apache.fulcrum.parser.ParameterParser#getFileItems(String)</code> to</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> * acquire an array of <code>org.apache.commons.fileupload.FileItem</code> objects</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * associated with given html form.</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> *</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a></a> |
| <span class="sourceLineNo">063</span><a id="line.63"> * @author <a href="mailto:dlr@collab.net">Daniel Rall</a></a> |
| <span class="sourceLineNo">064</span><a id="line.64"> * @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a></a> |
| <span class="sourceLineNo">065</span><a id="line.65"> * @version $Id$</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> */</a> |
| <span class="sourceLineNo">067</span><a id="line.67">public class DefaultUploadService extends AbstractLogEnabled</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> implements UploadService, Initializable, Configurable, Contextualizable {</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> /** A File Item Factory object for the actual uploading */</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> private DiskFileItemFactory itemFactory;</a> |
| <span class="sourceLineNo">071</span><a id="line.71"></a> |
| <span class="sourceLineNo">072</span><a id="line.72"> private int sizeThreshold;</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> private int sizeMax;</a> |
| <span class="sourceLineNo">074</span><a id="line.74"></a> |
| <span class="sourceLineNo">075</span><a id="line.75"> private String repositoryPath;</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> private String headerEncoding;</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"> * The application root</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> */</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> private String applicationRoot;</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 maximum allowed upload size</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> */</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> @Override</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> public long getSizeMax() {</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> return sizeMax;</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> }</a> |
| <span class="sourceLineNo">090</span><a id="line.90"></a> |
| <span class="sourceLineNo">091</span><a id="line.91"> /**</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> * The threshold beyond which files are written directly to disk.</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> */</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> @Override</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> public long getSizeThreshold() {</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> return itemFactory.getSizeThreshold();</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> }</a> |
| <span class="sourceLineNo">098</span><a id="line.98"></a> |
| <span class="sourceLineNo">099</span><a id="line.99"> /**</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> * The location used to temporarily store files that are larger than the size</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> * threshold.</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> */</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> @Override</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> public String getRepository() {</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> return itemFactory.getRepository().getAbsolutePath();</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> }</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"> * @return Returns the headerEncoding.</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> */</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> @Override</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> public String getHeaderEncoding() {</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> return headerEncoding;</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"> /**</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> * <p></a> |
| <span class="sourceLineNo">118</span><a id="line.118"> * Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> * <code>multipart/form-data</code> stream.</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> * </p></a> |
| <span class="sourceLineNo">121</span><a id="line.121"> *</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> * @param req The servlet request to be parsed.</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> * @throws ServiceException Problems reading/parsing the request or storing the</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> * uploaded file(s).</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> */</a> |
| <span class="sourceLineNo">126</span><a id="line.126"> @Override</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> public List<FileItem> parseRequest(HttpServletRequest req) throws ServiceException {</a> |
| <span class="sourceLineNo">128</span><a id="line.128"> return parseRequest(req, this.sizeMax, this.itemFactory);</a> |
| <span class="sourceLineNo">129</span><a id="line.129"> }</a> |
| <span class="sourceLineNo">130</span><a id="line.130"></a> |
| <span class="sourceLineNo">131</span><a id="line.131"> /**</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> * <p></a> |
| <span class="sourceLineNo">133</span><a id="line.133"> * Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> * <code>multipart/form-data</code> stream.</a> |
| <span class="sourceLineNo">135</span><a id="line.135"> * </p></a> |
| <span class="sourceLineNo">136</span><a id="line.136"> *</a> |
| <span class="sourceLineNo">137</span><a id="line.137"> * @param req The servlet request to be parsed.</a> |
| <span class="sourceLineNo">138</span><a id="line.138"> * @param path The location where the files should be stored.</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> * @throws ServiceException Problems reading/parsing the request or storing the</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> * uploaded file(s).</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> */</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> @Override</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> public List<FileItem> parseRequest(HttpServletRequest req, String path) throws ServiceException {</a> |
| <span class="sourceLineNo">144</span><a id="line.144"> return parseRequest(req, this.sizeThreshold, this.sizeMax, path);</a> |
| <span class="sourceLineNo">145</span><a id="line.145"> }</a> |
| <span class="sourceLineNo">146</span><a id="line.146"></a> |
| <span class="sourceLineNo">147</span><a id="line.147"> /**</a> |
| <span class="sourceLineNo">148</span><a id="line.148"> * <p></a> |
| <span class="sourceLineNo">149</span><a id="line.149"> * Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> * <code>multipart/form-data</code> stream.</a> |
| <span class="sourceLineNo">151</span><a id="line.151"> * </p></a> |
| <span class="sourceLineNo">152</span><a id="line.152"> *</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> * @param req The servlet request to be parsed.</a> |
| <span class="sourceLineNo">154</span><a id="line.154"> * @param sizeThreshold the max size in bytes to be stored in memory</a> |
| <span class="sourceLineNo">155</span><a id="line.155"> * @param sizeMax the maximum allowed upload size in bytes</a> |
| <span class="sourceLineNo">156</span><a id="line.156"> * @param path The location where the files should be stored.</a> |
| <span class="sourceLineNo">157</span><a id="line.157"> * @return list of file items</a> |
| <span class="sourceLineNo">158</span><a id="line.158"> * @throws ServiceException Problems reading/parsing the request or storing the</a> |
| <span class="sourceLineNo">159</span><a id="line.159"> * uploaded file(s).</a> |
| <span class="sourceLineNo">160</span><a id="line.160"> */</a> |
| <span class="sourceLineNo">161</span><a id="line.161"> @Override</a> |
| <span class="sourceLineNo">162</span><a id="line.162"> public List<FileItem> parseRequest(HttpServletRequest req, int sizeThreshold, int sizeMax, String path)</a> |
| <span class="sourceLineNo">163</span><a id="line.163"> throws ServiceException {</a> |
| <span class="sourceLineNo">164</span><a id="line.164"> return parseRequest(req, sizeMax, new DiskFileItemFactory(sizeThreshold, new File(path)));</a> |
| <span class="sourceLineNo">165</span><a id="line.165"> }</a> |
| <span class="sourceLineNo">166</span><a id="line.166"></a> |
| <span class="sourceLineNo">167</span><a id="line.167"> /**</a> |
| <span class="sourceLineNo">168</span><a id="line.168"> * <p></a> |
| <span class="sourceLineNo">169</span><a id="line.169"> * Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant</a> |
| <span class="sourceLineNo">170</span><a id="line.170"> * <code>multipart/form-data</code> stream.</a> |
| <span class="sourceLineNo">171</span><a id="line.171"> * </p></a> |
| <span class="sourceLineNo">172</span><a id="line.172"> *</a> |
| <span class="sourceLineNo">173</span><a id="line.173"> * @param req The servlet request to be parsed.</a> |
| <span class="sourceLineNo">174</span><a id="line.174"> * @param sizeMax the maximum allowed upload size in bytes</a> |
| <span class="sourceLineNo">175</span><a id="line.175"> * @param factory the file item factory to use</a> |
| <span class="sourceLineNo">176</span><a id="line.176"> * @return list of file items</a> |
| <span class="sourceLineNo">177</span><a id="line.177"> * @throws ServiceException Problems reading/parsing the request or storing the</a> |
| <span class="sourceLineNo">178</span><a id="line.178"> * uploaded file(s).</a> |
| <span class="sourceLineNo">179</span><a id="line.179"> */</a> |
| <span class="sourceLineNo">180</span><a id="line.180"> protected List<FileItem> parseRequest(HttpServletRequest req, int sizeMax, DiskFileItemFactory factory)</a> |
| <span class="sourceLineNo">181</span><a id="line.181"> throws ServiceException {</a> |
| <span class="sourceLineNo">182</span><a id="line.182"> try {</a> |
| <span class="sourceLineNo">183</span><a id="line.183"> ServletFileUpload fileUpload = new ServletFileUpload(factory);</a> |
| <span class="sourceLineNo">184</span><a id="line.184"> fileUpload.setSizeMax(sizeMax);</a> |
| <span class="sourceLineNo">185</span><a id="line.185"> fileUpload.setHeaderEncoding(headerEncoding);</a> |
| <span class="sourceLineNo">186</span><a id="line.186"> return fileUpload.parseRequest(req);</a> |
| <span class="sourceLineNo">187</span><a id="line.187"> } catch (FileUploadException e) {</a> |
| <span class="sourceLineNo">188</span><a id="line.188"> throw new ServiceException(UploadService.ROLE, e.getMessage(), e);</a> |
| <span class="sourceLineNo">189</span><a id="line.189"> }</a> |
| <span class="sourceLineNo">190</span><a id="line.190"> }</a> |
| <span class="sourceLineNo">191</span><a id="line.191"></a> |
| <span class="sourceLineNo">192</span><a id="line.192"> /**</a> |
| <span class="sourceLineNo">193</span><a id="line.193"> * Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a></a> |
| <span class="sourceLineNo">194</span><a id="line.194"> * compliant <code>multipart/form-data</code> stream.</a> |
| <span class="sourceLineNo">195</span><a id="line.195"> *</a> |
| <span class="sourceLineNo">196</span><a id="line.196"> * @param req The servlet request to be parsed.</a> |
| <span class="sourceLineNo">197</span><a id="line.197"> *</a> |
| <span class="sourceLineNo">198</span><a id="line.198"> * @return An iterator to instances of <code>FileItemStream</code> parsed from</a> |
| <span class="sourceLineNo">199</span><a id="line.199"> * the request, in the order that they were transmitted.</a> |
| <span class="sourceLineNo">200</span><a id="line.200"> *</a> |
| <span class="sourceLineNo">201</span><a id="line.201"> * @throws ServiceException if there are problems reading/parsing the request or</a> |
| <span class="sourceLineNo">202</span><a id="line.202"> * storing files. This may also be a network error</a> |
| <span class="sourceLineNo">203</span><a id="line.203"> * while communicating with the client or a problem</a> |
| <span class="sourceLineNo">204</span><a id="line.204"> * while storing the uploaded content.</a> |
| <span class="sourceLineNo">205</span><a id="line.205"> */</a> |
| <span class="sourceLineNo">206</span><a id="line.206"> @Override</a> |
| <span class="sourceLineNo">207</span><a id="line.207"> public FileItemIterator getItemIterator(HttpServletRequest req) throws ServiceException {</a> |
| <span class="sourceLineNo">208</span><a id="line.208"> ServletFileUpload upload = new ServletFileUpload();</a> |
| <span class="sourceLineNo">209</span><a id="line.209"> try {</a> |
| <span class="sourceLineNo">210</span><a id="line.210"> return upload.getItemIterator(req);</a> |
| <span class="sourceLineNo">211</span><a id="line.211"> } catch (FileUploadException e) {</a> |
| <span class="sourceLineNo">212</span><a id="line.212"> throw new ServiceException(UploadService.ROLE, e.getMessage(), e);</a> |
| <span class="sourceLineNo">213</span><a id="line.213"> } catch (IOException e) {</a> |
| <span class="sourceLineNo">214</span><a id="line.214"> throw new ServiceException(UploadService.ROLE, e.getMessage(), e);</a> |
| <span class="sourceLineNo">215</span><a id="line.215"> }</a> |
| <span class="sourceLineNo">216</span><a id="line.216"> }</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"> * @throws ServiceException Problems reading/parsing the request or storing the</a> |
| <span class="sourceLineNo">226</span><a id="line.226"> * uploaded file(s).</a> |
| <span class="sourceLineNo">227</span><a id="line.227"> */</a> |
| <span class="sourceLineNo">228</span><a id="line.228"> @Override</a> |
| <span class="sourceLineNo">229</span><a id="line.229"> public List<FileItem> parseRequest(ActionRequest req) throws ServiceException {</a> |
| <span class="sourceLineNo">230</span><a id="line.230"> return parseRequest(req, this.sizeMax, this.itemFactory);</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"> /**</a> |
| <span class="sourceLineNo">234</span><a id="line.234"> * <p></a> |
| <span class="sourceLineNo">235</span><a id="line.235"> * Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant</a> |
| <span class="sourceLineNo">236</span><a id="line.236"> * <code>multipart/form-data</code> stream.</a> |
| <span class="sourceLineNo">237</span><a id="line.237"> * </p></a> |
| <span class="sourceLineNo">238</span><a id="line.238"> *</a> |
| <span class="sourceLineNo">239</span><a id="line.239"> * @param req The portlet request to be parsed.</a> |
| <span class="sourceLineNo">240</span><a id="line.240"> * @param path The location where the files should be stored.</a> |
| <span class="sourceLineNo">241</span><a id="line.241"> * @throws ServiceException Problems reading/parsing the request or storing the</a> |
| <span class="sourceLineNo">242</span><a id="line.242"> * uploaded file(s).</a> |
| <span class="sourceLineNo">243</span><a id="line.243"> */</a> |
| <span class="sourceLineNo">244</span><a id="line.244"> @Override</a> |
| <span class="sourceLineNo">245</span><a id="line.245"> public List<FileItem> parseRequest(ActionRequest req, String path) throws ServiceException {</a> |
| <span class="sourceLineNo">246</span><a id="line.246"> return parseRequest(req, this.sizeThreshold, this.sizeMax, path);</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"> /**</a> |
| <span class="sourceLineNo">250</span><a id="line.250"> * <p></a> |
| <span class="sourceLineNo">251</span><a id="line.251"> * Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant</a> |
| <span class="sourceLineNo">252</span><a id="line.252"> * <code>multipart/form-data</code> stream.</a> |
| <span class="sourceLineNo">253</span><a id="line.253"> * </p></a> |
| <span class="sourceLineNo">254</span><a id="line.254"> *</a> |
| <span class="sourceLineNo">255</span><a id="line.255"> * @param req The portlet request to be parsed.</a> |
| <span class="sourceLineNo">256</span><a id="line.256"> * @param sizeThreshold the max size in bytes to be stored in memory</a> |
| <span class="sourceLineNo">257</span><a id="line.257"> * @param sizeMax the maximum allowed upload size in bytes</a> |
| <span class="sourceLineNo">258</span><a id="line.258"> * @param path The location where the files should be stored.</a> |
| <span class="sourceLineNo">259</span><a id="line.259"> * @throws ServiceException Problems reading/parsing the request or storing the</a> |
| <span class="sourceLineNo">260</span><a id="line.260"> * uploaded file(s).</a> |
| <span class="sourceLineNo">261</span><a id="line.261"> */</a> |
| <span class="sourceLineNo">262</span><a id="line.262"> @Override</a> |
| <span class="sourceLineNo">263</span><a id="line.263"> public List<FileItem> parseRequest(ActionRequest req, int sizeThreshold, int sizeMax, String path)</a> |
| <span class="sourceLineNo">264</span><a id="line.264"> throws ServiceException {</a> |
| <span class="sourceLineNo">265</span><a id="line.265"> return parseRequest(req, sizeMax, new DiskFileItemFactory(sizeThreshold, new File(path)));</a> |
| <span class="sourceLineNo">266</span><a id="line.266"> }</a> |
| <span class="sourceLineNo">267</span><a id="line.267"></a> |
| <span class="sourceLineNo">268</span><a id="line.268"> /**</a> |
| <span class="sourceLineNo">269</span><a id="line.269"> * <p></a> |
| <span class="sourceLineNo">270</span><a id="line.270"> * Parses a <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant</a> |
| <span class="sourceLineNo">271</span><a id="line.271"> * <code>multipart/form-data</code> stream.</a> |
| <span class="sourceLineNo">272</span><a id="line.272"> * </p></a> |
| <span class="sourceLineNo">273</span><a id="line.273"> *</a> |
| <span class="sourceLineNo">274</span><a id="line.274"> * @param req The portlet request to be parsed.</a> |
| <span class="sourceLineNo">275</span><a id="line.275"> * @param sizeMax the maximum allowed upload size in bytes</a> |
| <span class="sourceLineNo">276</span><a id="line.276"> * @param factory the file item factory to use</a> |
| <span class="sourceLineNo">277</span><a id="line.277"> * @return The list of FileItem parts uploaded</a> |
| <span class="sourceLineNo">278</span><a id="line.278"> * @throws ServiceException Problems reading/parsing the request or storing the</a> |
| <span class="sourceLineNo">279</span><a id="line.279"> * uploaded file(s).</a> |
| <span class="sourceLineNo">280</span><a id="line.280"> */</a> |
| <span class="sourceLineNo">281</span><a id="line.281"> protected List<FileItem> parseRequest(ActionRequest req, int sizeMax, DiskFileItemFactory factory)</a> |
| <span class="sourceLineNo">282</span><a id="line.282"> throws ServiceException {</a> |
| <span class="sourceLineNo">283</span><a id="line.283"> try {</a> |
| <span class="sourceLineNo">284</span><a id="line.284"> PortletFileUpload fileUpload = new PortletFileUpload(factory);</a> |
| <span class="sourceLineNo">285</span><a id="line.285"> fileUpload.setSizeMax(sizeMax);</a> |
| <span class="sourceLineNo">286</span><a id="line.286"> fileUpload.setHeaderEncoding(headerEncoding);</a> |
| <span class="sourceLineNo">287</span><a id="line.287"> return fileUpload.parseRequest(req);</a> |
| <span class="sourceLineNo">288</span><a id="line.288"> } catch (FileUploadException e) {</a> |
| <span class="sourceLineNo">289</span><a id="line.289"> throw new ServiceException(UploadService.ROLE, e.getMessage(), e);</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"></a> |
| <span class="sourceLineNo">293</span><a id="line.293"> /**</a> |
| <span class="sourceLineNo">294</span><a id="line.294"> * Processes an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a></a> |
| <span class="sourceLineNo">295</span><a id="line.295"> * compliant <code>multipart/form-data</code> stream.</a> |
| <span class="sourceLineNo">296</span><a id="line.296"> *</a> |
| <span class="sourceLineNo">297</span><a id="line.297"> * @param req The portlet request to be parsed.</a> |
| <span class="sourceLineNo">298</span><a id="line.298"> *</a> |
| <span class="sourceLineNo">299</span><a id="line.299"> * @return An iterator to instances of <code>FileItemStream</code> parsed from</a> |
| <span class="sourceLineNo">300</span><a id="line.300"> * the request, in the order that they were transmitted.</a> |
| <span class="sourceLineNo">301</span><a id="line.301"> *</a> |
| <span class="sourceLineNo">302</span><a id="line.302"> * @throws ServiceException if there are problems reading/parsing the request or</a> |
| <span class="sourceLineNo">303</span><a id="line.303"> * storing files. This may also be a network error</a> |
| <span class="sourceLineNo">304</span><a id="line.304"> * while communicating with the client or a problem</a> |
| <span class="sourceLineNo">305</span><a id="line.305"> * while storing the uploaded content.</a> |
| <span class="sourceLineNo">306</span><a id="line.306"> */</a> |
| <span class="sourceLineNo">307</span><a id="line.307"> @Override</a> |
| <span class="sourceLineNo">308</span><a id="line.308"> public FileItemIterator getItemIterator(ActionRequest req) throws ServiceException {</a> |
| <span class="sourceLineNo">309</span><a id="line.309"> PortletFileUpload upload = new PortletFileUpload();</a> |
| <span class="sourceLineNo">310</span><a id="line.310"> try {</a> |
| <span class="sourceLineNo">311</span><a id="line.311"> return upload.getItemIterator(req);</a> |
| <span class="sourceLineNo">312</span><a id="line.312"> } catch (FileUploadException e) {</a> |
| <span class="sourceLineNo">313</span><a id="line.313"> throw new ServiceException(UploadService.ROLE, e.getMessage(), e);</a> |
| <span class="sourceLineNo">314</span><a id="line.314"> } catch (IOException e) {</a> |
| <span class="sourceLineNo">315</span><a id="line.315"> throw new ServiceException(UploadService.ROLE, e.getMessage(), e);</a> |
| <span class="sourceLineNo">316</span><a id="line.316"> }</a> |
| <span class="sourceLineNo">317</span><a id="line.317"> }</a> |
| <span class="sourceLineNo">318</span><a id="line.318"></a> |
| <span class="sourceLineNo">319</span><a id="line.319"> /**</a> |
| <span class="sourceLineNo">320</span><a id="line.320"> * Utility method that determines whether the request contains multipart</a> |
| <span class="sourceLineNo">321</span><a id="line.321"> * content.</a> |
| <span class="sourceLineNo">322</span><a id="line.322"> *</a> |
| <span class="sourceLineNo">323</span><a id="line.323"> * @param req The servlet request to be evaluated. Must be non-null.</a> |
| <span class="sourceLineNo">324</span><a id="line.324"> *</a> |
| <span class="sourceLineNo">325</span><a id="line.325"> * @return <code>true</code> if the request is multipart; <code>false</code></a> |
| <span class="sourceLineNo">326</span><a id="line.326"> * otherwise.</a> |
| <span class="sourceLineNo">327</span><a id="line.327"> */</a> |
| <span class="sourceLineNo">328</span><a id="line.328"> @Override</a> |
| <span class="sourceLineNo">329</span><a id="line.329"> public boolean isMultipart(HttpServletRequest req) {</a> |
| <span class="sourceLineNo">330</span><a id="line.330"> return ServletFileUpload.isMultipartContent(req);</a> |
| <span class="sourceLineNo">331</span><a id="line.331"> }</a> |
| <span class="sourceLineNo">332</span><a id="line.332"></a> |
| <span class="sourceLineNo">333</span><a id="line.333"> /**</a> |
| <span class="sourceLineNo">334</span><a id="line.334"> * Utility method that determines whether the request contains multipart</a> |
| <span class="sourceLineNo">335</span><a id="line.335"> * content.</a> |
| <span class="sourceLineNo">336</span><a id="line.336"> *</a> |
| <span class="sourceLineNo">337</span><a id="line.337"> * @param req The portlet request to be evaluated. Must be non-null.</a> |
| <span class="sourceLineNo">338</span><a id="line.338"> *</a> |
| <span class="sourceLineNo">339</span><a id="line.339"> * @return <code>true</code> if the request is multipart; <code>false</code></a> |
| <span class="sourceLineNo">340</span><a id="line.340"> * otherwise.</a> |
| <span class="sourceLineNo">341</span><a id="line.341"> */</a> |
| <span class="sourceLineNo">342</span><a id="line.342"> @Override</a> |
| <span class="sourceLineNo">343</span><a id="line.343"> public boolean isMultipart(ActionRequest req) {</a> |
| <span class="sourceLineNo">344</span><a id="line.344"> return PortletFileUpload.isMultipartContent(req);</a> |
| <span class="sourceLineNo">345</span><a id="line.345"> }</a> |
| <span class="sourceLineNo">346</span><a id="line.346"></a> |
| <span class="sourceLineNo">347</span><a id="line.347"> /**</a> |
| <span class="sourceLineNo">348</span><a id="line.348"> * @see org.apache.fulcrum.ServiceBroker#getRealPath(String)</a> |
| <span class="sourceLineNo">349</span><a id="line.349"> */</a> |
| <span class="sourceLineNo">350</span><a id="line.350"> private String getRealPath(String path) {</a> |
| <span class="sourceLineNo">351</span><a id="line.351"> String absolutePath = null;</a> |
| <span class="sourceLineNo">352</span><a id="line.352"> if (applicationRoot == null) {</a> |
| <span class="sourceLineNo">353</span><a id="line.353"> absolutePath = new File(path).getAbsolutePath();</a> |
| <span class="sourceLineNo">354</span><a id="line.354"> } else {</a> |
| <span class="sourceLineNo">355</span><a id="line.355"> absolutePath = new File(applicationRoot, path).getAbsolutePath();</a> |
| <span class="sourceLineNo">356</span><a id="line.356"> }</a> |
| <span class="sourceLineNo">357</span><a id="line.357"></a> |
| <span class="sourceLineNo">358</span><a id="line.358"> return absolutePath;</a> |
| <span class="sourceLineNo">359</span><a id="line.359"> }</a> |
| <span class="sourceLineNo">360</span><a id="line.360"></a> |
| <span class="sourceLineNo">361</span><a id="line.361"> // ---------------- Avalon Lifecycle Methods ---------------------</a> |
| <span class="sourceLineNo">362</span><a id="line.362"> /**</a> |
| <span class="sourceLineNo">363</span><a id="line.363"> * Avalon component lifecycle method</a> |
| <span class="sourceLineNo">364</span><a id="line.364"> */</a> |
| <span class="sourceLineNo">365</span><a id="line.365"> @Override</a> |
| <span class="sourceLineNo">366</span><a id="line.366"> public void configure(Configuration conf) {</a> |
| <span class="sourceLineNo">367</span><a id="line.367"> repositoryPath = conf.getAttribute(UploadService.REPOSITORY_KEY, UploadService.REPOSITORY_DEFAULT);</a> |
| <span class="sourceLineNo">368</span><a id="line.368"></a> |
| <span class="sourceLineNo">369</span><a id="line.369"> headerEncoding = conf.getAttribute(UploadService.HEADER_ENCODING_KEY, UploadService.HEADER_ENCODING_DEFAULT);</a> |
| <span class="sourceLineNo">370</span><a id="line.370"></a> |
| <span class="sourceLineNo">371</span><a id="line.371"> sizeMax = conf.getAttributeAsInteger(UploadService.SIZE_MAX_KEY, UploadService.SIZE_MAX_DEFAULT);</a> |
| <span class="sourceLineNo">372</span><a id="line.372"></a> |
| <span class="sourceLineNo">373</span><a id="line.373"> sizeThreshold = conf.getAttributeAsInteger(UploadService.SIZE_THRESHOLD_KEY,</a> |
| <span class="sourceLineNo">374</span><a id="line.374"> UploadService.SIZE_THRESHOLD_DEFAULT);</a> |
| <span class="sourceLineNo">375</span><a id="line.375"> }</a> |
| <span class="sourceLineNo">376</span><a id="line.376"></a> |
| <span class="sourceLineNo">377</span><a id="line.377"> /**</a> |
| <span class="sourceLineNo">378</span><a id="line.378"> * Avalon component lifecycle method</a> |
| <span class="sourceLineNo">379</span><a id="line.379"> *</a> |
| <span class="sourceLineNo">380</span><a id="line.380"> * Initializes the service.</a> |
| <span class="sourceLineNo">381</span><a id="line.381"> *</a> |
| <span class="sourceLineNo">382</span><a id="line.382"> * This method processes the repository path, to make it relative to the web</a> |
| <span class="sourceLineNo">383</span><a id="line.383"> * application root, if necessary</a> |
| <span class="sourceLineNo">384</span><a id="line.384"> */</a> |
| <span class="sourceLineNo">385</span><a id="line.385"> @Override</a> |
| <span class="sourceLineNo">386</span><a id="line.386"> public void initialize() throws Exception {</a> |
| <span class="sourceLineNo">387</span><a id="line.387"> // test for the existence of the path within the webapp directory.</a> |
| <span class="sourceLineNo">388</span><a id="line.388"> // if it does not exist, assume the path was to be used as is.</a> |
| <span class="sourceLineNo">389</span><a id="line.389"> String testPath = getRealPath(repositoryPath);</a> |
| <span class="sourceLineNo">390</span><a id="line.390"> File testDir = new File(testPath);</a> |
| <span class="sourceLineNo">391</span><a id="line.391"> if (testDir.exists()) {</a> |
| <span class="sourceLineNo">392</span><a id="line.392"> repositoryPath = testPath;</a> |
| <span class="sourceLineNo">393</span><a id="line.393"> }</a> |
| <span class="sourceLineNo">394</span><a id="line.394"></a> |
| <span class="sourceLineNo">395</span><a id="line.395"> getLogger().debug("Upload Service: REPOSITORY_KEY => " + repositoryPath);</a> |
| <span class="sourceLineNo">396</span><a id="line.396"></a> |
| <span class="sourceLineNo">397</span><a id="line.397"> itemFactory = new DiskFileItemFactory(sizeThreshold, new File(repositoryPath));</a> |
| <span class="sourceLineNo">398</span><a id="line.398"> }</a> |
| <span class="sourceLineNo">399</span><a id="line.399"></a> |
| <span class="sourceLineNo">400</span><a id="line.400"> /**</a> |
| <span class="sourceLineNo">401</span><a id="line.401"> * Avalon component lifecycle method</a> |
| <span class="sourceLineNo">402</span><a id="line.402"> */</a> |
| <span class="sourceLineNo">403</span><a id="line.403"> @Override</a> |
| <span class="sourceLineNo">404</span><a id="line.404"> public void contextualize(Context context) throws ContextException {</a> |
| <span class="sourceLineNo">405</span><a id="line.405"> this.applicationRoot = context.get("urn:avalon:home").toString();</a> |
| <span class="sourceLineNo">406</span><a id="line.406"> }</a> |
| <span class="sourceLineNo">407</span><a id="line.407">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
