Added: websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/ParameterParser.html ============================================================================== --- websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/ParameterParser.html (added) +++ websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/ParameterParser.html Tue Jun 13 12:48:38 2017 @@ -0,0 +1,413 @@ +<!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.UnsupportedEncodingException;<a name="line.19"></a> +<span class="sourceLineNo">020</span>import java.util.HashMap;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import java.util.Locale;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import java.util.Map;<a name="line.22"></a> +<span class="sourceLineNo">023</span><a name="line.23"></a> +<span class="sourceLineNo">024</span>import org.apache.commons.fileupload.util.mime.MimeUtility;<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> * A simple parser intended to parse sequences of name/value pairs.<a name="line.27"></a> +<span class="sourceLineNo">028</span> *<a name="line.28"></a> +<span class="sourceLineNo">029</span> * Parameter values are expected to be enclosed in quotes if they<a name="line.29"></a> +<span class="sourceLineNo">030</span> * contain unsafe characters, such as '=' characters or separators.<a name="line.30"></a> +<span class="sourceLineNo">031</span> * Parameter values are optional and can be omitted.<a name="line.31"></a> +<span class="sourceLineNo">032</span> *<a name="line.32"></a> +<span class="sourceLineNo">033</span> * <p><a name="line.33"></a> +<span class="sourceLineNo">034</span> * <code>param1 = value; param2 = "anything goes; really"; param3</code><a name="line.34"></a> +<span class="sourceLineNo">035</span> * </p><a name="line.35"></a> +<span class="sourceLineNo">036</span> *<a name="line.36"></a> +<span class="sourceLineNo">037</span> * @version $Id$<a name="line.37"></a> +<span class="sourceLineNo">038</span> */<a name="line.38"></a> +<span class="sourceLineNo">039</span>public class ParameterParser {<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> * String to be parsed.<a name="line.42"></a> +<span class="sourceLineNo">043</span> */<a name="line.43"></a> +<span class="sourceLineNo">044</span> private char[] chars = null;<a name="line.44"></a> +<span class="sourceLineNo">045</span><a name="line.45"></a> +<span class="sourceLineNo">046</span> /**<a name="line.46"></a> +<span class="sourceLineNo">047</span> * Current position in the string.<a name="line.47"></a> +<span class="sourceLineNo">048</span> */<a name="line.48"></a> +<span class="sourceLineNo">049</span> private int pos = 0;<a name="line.49"></a> +<span class="sourceLineNo">050</span><a name="line.50"></a> +<span class="sourceLineNo">051</span> /**<a name="line.51"></a> +<span class="sourceLineNo">052</span> * Maximum position in the string.<a name="line.52"></a> +<span class="sourceLineNo">053</span> */<a name="line.53"></a> +<span class="sourceLineNo">054</span> private int len = 0;<a name="line.54"></a> +<span class="sourceLineNo">055</span><a name="line.55"></a> +<span class="sourceLineNo">056</span> /**<a name="line.56"></a> +<span class="sourceLineNo">057</span> * Start of a token.<a name="line.57"></a> +<span class="sourceLineNo">058</span> */<a name="line.58"></a> +<span class="sourceLineNo">059</span> private int i1 = 0;<a name="line.59"></a> +<span class="sourceLineNo">060</span><a name="line.60"></a> +<span class="sourceLineNo">061</span> /**<a name="line.61"></a> +<span class="sourceLineNo">062</span> * End of a token.<a name="line.62"></a> +<span class="sourceLineNo">063</span> */<a name="line.63"></a> +<span class="sourceLineNo">064</span> private int i2 = 0;<a name="line.64"></a> +<span class="sourceLineNo">065</span><a name="line.65"></a> +<span class="sourceLineNo">066</span> /**<a name="line.66"></a> +<span class="sourceLineNo">067</span> * Whether names stored in the map should be converted to lower case.<a name="line.67"></a> +<span class="sourceLineNo">068</span> */<a name="line.68"></a> +<span class="sourceLineNo">069</span> private boolean lowerCaseNames = false;<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> * Default ParameterParser constructor.<a name="line.72"></a> +<span class="sourceLineNo">073</span> */<a name="line.73"></a> +<span class="sourceLineNo">074</span> public ParameterParser() {<a name="line.74"></a> +<span class="sourceLineNo">075</span> super();<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> /**<a name="line.78"></a> +<span class="sourceLineNo">079</span> * Are there any characters left to parse?<a name="line.79"></a> +<span class="sourceLineNo">080</span> *<a name="line.80"></a> +<span class="sourceLineNo">081</span> * @return <tt>true</tt> if there are unparsed characters,<a name="line.81"></a> +<span class="sourceLineNo">082</span> * <tt>false</tt> otherwise.<a name="line.82"></a> +<span class="sourceLineNo">083</span> */<a name="line.83"></a> +<span class="sourceLineNo">084</span> private boolean hasChar() {<a name="line.84"></a> +<span class="sourceLineNo">085</span> return this.pos < this.len;<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> /**<a name="line.88"></a> +<span class="sourceLineNo">089</span> * A helper method to process the parsed token. This method removes<a name="line.89"></a> +<span class="sourceLineNo">090</span> * leading and trailing blanks as well as enclosing quotation marks,<a name="line.90"></a> +<span class="sourceLineNo">091</span> * when necessary.<a name="line.91"></a> +<span class="sourceLineNo">092</span> *<a name="line.92"></a> +<span class="sourceLineNo">093</span> * @param quoted <tt>true</tt> if quotation marks are expected,<a name="line.93"></a> +<span class="sourceLineNo">094</span> * <tt>false</tt> otherwise.<a name="line.94"></a> +<span class="sourceLineNo">095</span> * @return the token<a name="line.95"></a> +<span class="sourceLineNo">096</span> */<a name="line.96"></a> +<span class="sourceLineNo">097</span> private String getToken(boolean quoted) {<a name="line.97"></a> +<span class="sourceLineNo">098</span> // Trim leading white spaces<a name="line.98"></a> +<span class="sourceLineNo">099</span> while ((i1 < i2) && (Character.isWhitespace(chars[i1]))) {<a name="line.99"></a> +<span class="sourceLineNo">100</span> i1++;<a name="line.100"></a> +<span class="sourceLineNo">101</span> }<a name="line.101"></a> +<span class="sourceLineNo">102</span> // Trim trailing white spaces<a name="line.102"></a> +<span class="sourceLineNo">103</span> while ((i2 > i1) && (Character.isWhitespace(chars[i2 - 1]))) {<a name="line.103"></a> +<span class="sourceLineNo">104</span> i2--;<a name="line.104"></a> +<span class="sourceLineNo">105</span> }<a name="line.105"></a> +<span class="sourceLineNo">106</span> // Strip away quotation marks if necessary<a name="line.106"></a> +<span class="sourceLineNo">107</span> if (quoted<a name="line.107"></a> +<span class="sourceLineNo">108</span> && ((i2 - i1) >= 2)<a name="line.108"></a> +<span class="sourceLineNo">109</span> && (chars[i1] == '"')<a name="line.109"></a> +<span class="sourceLineNo">110</span> && (chars[i2 - 1] == '"')) {<a name="line.110"></a> +<span class="sourceLineNo">111</span> i1++;<a name="line.111"></a> +<span class="sourceLineNo">112</span> i2--;<a name="line.112"></a> +<span class="sourceLineNo">113</span> }<a name="line.113"></a> +<span class="sourceLineNo">114</span> String result = null;<a name="line.114"></a> +<span class="sourceLineNo">115</span> if (i2 > i1) {<a name="line.115"></a> +<span class="sourceLineNo">116</span> result = new String(chars, i1, i2 - i1);<a name="line.116"></a> +<span class="sourceLineNo">117</span> }<a name="line.117"></a> +<span class="sourceLineNo">118</span> return result;<a name="line.118"></a> +<span class="sourceLineNo">119</span> }<a name="line.119"></a> +<span class="sourceLineNo">120</span><a name="line.120"></a> +<span class="sourceLineNo">121</span> /**<a name="line.121"></a> +<span class="sourceLineNo">122</span> * Tests if the given character is present in the array of characters.<a name="line.122"></a> +<span class="sourceLineNo">123</span> *<a name="line.123"></a> +<span class="sourceLineNo">124</span> * @param ch the character to test for presense in the array of characters<a name="line.124"></a> +<span class="sourceLineNo">125</span> * @param charray the array of characters to test against<a name="line.125"></a> +<span class="sourceLineNo">126</span> *<a name="line.126"></a> +<span class="sourceLineNo">127</span> * @return <tt>true</tt> if the character is present in the array of<a name="line.127"></a> +<span class="sourceLineNo">128</span> * characters, <tt>false</tt> otherwise.<a name="line.128"></a> +<span class="sourceLineNo">129</span> */<a name="line.129"></a> +<span class="sourceLineNo">130</span> private boolean isOneOf(char ch, final char[] charray) {<a name="line.130"></a> +<span class="sourceLineNo">131</span> boolean result = false;<a name="line.131"></a> +<span class="sourceLineNo">132</span> for (char element : charray) {<a name="line.132"></a> +<span class="sourceLineNo">133</span> if (ch == element) {<a name="line.133"></a> +<span class="sourceLineNo">134</span> result = true;<a name="line.134"></a> +<span class="sourceLineNo">135</span> break;<a name="line.135"></a> +<span class="sourceLineNo">136</span> }<a name="line.136"></a> +<span class="sourceLineNo">137</span> }<a name="line.137"></a> +<span class="sourceLineNo">138</span> return result;<a name="line.138"></a> +<span class="sourceLineNo">139</span> }<a name="line.139"></a> +<span class="sourceLineNo">140</span><a name="line.140"></a> +<span class="sourceLineNo">141</span> /**<a name="line.141"></a> +<span class="sourceLineNo">142</span> * Parses out a token until any of the given terminators<a name="line.142"></a> +<span class="sourceLineNo">143</span> * is encountered.<a name="line.143"></a> +<span class="sourceLineNo">144</span> *<a name="line.144"></a> +<span class="sourceLineNo">145</span> * @param terminators the array of terminating characters. Any of these<a name="line.145"></a> +<span class="sourceLineNo">146</span> * characters when encountered signify the end of the token<a name="line.146"></a> +<span class="sourceLineNo">147</span> *<a name="line.147"></a> +<span class="sourceLineNo">148</span> * @return the token<a name="line.148"></a> +<span class="sourceLineNo">149</span> */<a name="line.149"></a> +<span class="sourceLineNo">150</span> private String parseToken(final char[] terminators) {<a name="line.150"></a> +<span class="sourceLineNo">151</span> char ch;<a name="line.151"></a> +<span class="sourceLineNo">152</span> i1 = pos;<a name="line.152"></a> +<span class="sourceLineNo">153</span> i2 = pos;<a name="line.153"></a> +<span class="sourceLineNo">154</span> while (hasChar()) {<a name="line.154"></a> +<span class="sourceLineNo">155</span> ch = chars[pos];<a name="line.155"></a> +<span class="sourceLineNo">156</span> if (isOneOf(ch, terminators)) {<a name="line.156"></a> +<span class="sourceLineNo">157</span> break;<a name="line.157"></a> +<span class="sourceLineNo">158</span> }<a name="line.158"></a> +<span class="sourceLineNo">159</span> i2++;<a name="line.159"></a> +<span class="sourceLineNo">160</span> pos++;<a name="line.160"></a> +<span class="sourceLineNo">161</span> }<a name="line.161"></a> +<span class="sourceLineNo">162</span> return getToken(false);<a name="line.162"></a> +<span class="sourceLineNo">163</span> }<a name="line.163"></a> +<span class="sourceLineNo">164</span><a name="line.164"></a> +<span class="sourceLineNo">165</span> /**<a name="line.165"></a> +<span class="sourceLineNo">166</span> * Parses out a token until any of the given terminators<a name="line.166"></a> +<span class="sourceLineNo">167</span> * is encountered outside the quotation marks.<a name="line.167"></a> +<span class="sourceLineNo">168</span> *<a name="line.168"></a> +<span class="sourceLineNo">169</span> * @param terminators the array of terminating characters. Any of these<a name="line.169"></a> +<span class="sourceLineNo">170</span> * characters when encountered outside the quotation marks signify the end<a name="line.170"></a> +<span class="sourceLineNo">171</span> * of the token<a name="line.171"></a> +<span class="sourceLineNo">172</span> *<a name="line.172"></a> +<span class="sourceLineNo">173</span> * @return the token<a name="line.173"></a> +<span class="sourceLineNo">174</span> */<a name="line.174"></a> +<span class="sourceLineNo">175</span> private String parseQuotedToken(final char[] terminators) {<a name="line.175"></a> +<span class="sourceLineNo">176</span> char ch;<a name="line.176"></a> +<span class="sourceLineNo">177</span> i1 = pos;<a name="line.177"></a> +<span class="sourceLineNo">178</span> i2 = pos;<a name="line.178"></a> +<span class="sourceLineNo">179</span> boolean quoted = false;<a name="line.179"></a> +<span class="sourceLineNo">180</span> boolean charEscaped = false;<a name="line.180"></a> +<span class="sourceLineNo">181</span> while (hasChar()) {<a name="line.181"></a> +<span class="sourceLineNo">182</span> ch = chars[pos];<a name="line.182"></a> +<span class="sourceLineNo">183</span> if (!quoted && isOneOf(ch, terminators)) {<a name="line.183"></a> +<span class="sourceLineNo">184</span> break;<a name="line.184"></a> +<span class="sourceLineNo">185</span> }<a name="line.185"></a> +<span class="sourceLineNo">186</span> if (!charEscaped && ch == '"') {<a name="line.186"></a> +<span class="sourceLineNo">187</span> quoted = !quoted;<a name="line.187"></a> +<span class="sourceLineNo">188</span> }<a name="line.188"></a> +<span class="sourceLineNo">189</span> charEscaped = (!charEscaped && ch == '\\');<a name="line.189"></a> +<span class="sourceLineNo">190</span> i2++;<a name="line.190"></a> +<span class="sourceLineNo">191</span> pos++;<a name="line.191"></a> +<span class="sourceLineNo">192</span><a name="line.192"></a> +<span class="sourceLineNo">193</span> }<a name="line.193"></a> +<span class="sourceLineNo">194</span> return getToken(true);<a name="line.194"></a> +<span class="sourceLineNo">195</span> }<a name="line.195"></a> +<span class="sourceLineNo">196</span><a name="line.196"></a> +<span class="sourceLineNo">197</span> /**<a name="line.197"></a> +<span class="sourceLineNo">198</span> * Returns <tt>true</tt> if parameter names are to be converted to lower<a name="line.198"></a> +<span class="sourceLineNo">199</span> * case when name/value pairs are parsed.<a name="line.199"></a> +<span class="sourceLineNo">200</span> *<a name="line.200"></a> +<span class="sourceLineNo">201</span> * @return <tt>true</tt> if parameter names are to be<a name="line.201"></a> +<span class="sourceLineNo">202</span> * converted to lower case when name/value pairs are parsed.<a name="line.202"></a> +<span class="sourceLineNo">203</span> * Otherwise returns <tt>false</tt><a name="line.203"></a> +<span class="sourceLineNo">204</span> */<a name="line.204"></a> +<span class="sourceLineNo">205</span> public boolean isLowerCaseNames() {<a name="line.205"></a> +<span class="sourceLineNo">206</span> return this.lowerCaseNames;<a name="line.206"></a> +<span class="sourceLineNo">207</span> }<a name="line.207"></a> +<span class="sourceLineNo">208</span><a name="line.208"></a> +<span class="sourceLineNo">209</span> /**<a name="line.209"></a> +<span class="sourceLineNo">210</span> * Sets the flag if parameter names are to be converted to lower case when<a name="line.210"></a> +<span class="sourceLineNo">211</span> * name/value pairs are parsed.<a name="line.211"></a> +<span class="sourceLineNo">212</span> *<a name="line.212"></a> +<span class="sourceLineNo">213</span> * @param b <tt>true</tt> if parameter names are to be<a name="line.213"></a> +<span class="sourceLineNo">214</span> * converted to lower case when name/value pairs are parsed.<a name="line.214"></a> +<span class="sourceLineNo">215</span> * <tt>false</tt> otherwise.<a name="line.215"></a> +<span class="sourceLineNo">216</span> */<a name="line.216"></a> +<span class="sourceLineNo">217</span> public void setLowerCaseNames(boolean b) {<a name="line.217"></a> +<span class="sourceLineNo">218</span> this.lowerCaseNames = b;<a name="line.218"></a> +<span class="sourceLineNo">219</span> }<a name="line.219"></a> +<span class="sourceLineNo">220</span><a name="line.220"></a> +<span class="sourceLineNo">221</span> /**<a name="line.221"></a> +<span class="sourceLineNo">222</span> * Extracts a map of name/value pairs from the given string. Names are<a name="line.222"></a> +<span class="sourceLineNo">223</span> * expected to be unique. Multiple separators may be specified and<a name="line.223"></a> +<span class="sourceLineNo">224</span> * the earliest found in the input string is used.<a name="line.224"></a> +<span class="sourceLineNo">225</span> *<a name="line.225"></a> +<span class="sourceLineNo">226</span> * @param str the string that contains a sequence of name/value pairs<a name="line.226"></a> +<span class="sourceLineNo">227</span> * @param separators the name/value pairs separators<a name="line.227"></a> +<span class="sourceLineNo">228</span> *<a name="line.228"></a> +<span class="sourceLineNo">229</span> * @return a map of name/value pairs<a name="line.229"></a> +<span class="sourceLineNo">230</span> */<a name="line.230"></a> +<span class="sourceLineNo">231</span> public Map<String, String> parse(final String str, char[] separators) {<a name="line.231"></a> +<span class="sourceLineNo">232</span> if (separators == null || separators.length == 0) {<a name="line.232"></a> +<span class="sourceLineNo">233</span> return new HashMap<String, String>();<a name="line.233"></a> +<span class="sourceLineNo">234</span> }<a name="line.234"></a> +<span class="sourceLineNo">235</span> char separator = separators[0];<a name="line.235"></a> +<span class="sourceLineNo">236</span> if (str != null) {<a name="line.236"></a> +<span class="sourceLineNo">237</span> int idx = str.length();<a name="line.237"></a> +<span class="sourceLineNo">238</span> for (char separator2 : separators) {<a name="line.238"></a> +<span class="sourceLineNo">239</span> int tmp = str.indexOf(separator2);<a name="line.239"></a> +<span class="sourceLineNo">240</span> if (tmp != -1 && tmp < idx) {<a name="line.240"></a> +<span class="sourceLineNo">241</span> idx = tmp;<a name="line.241"></a> +<span class="sourceLineNo">242</span> separator = separator2;<a name="line.242"></a> +<span class="sourceLineNo">243</span> }<a name="line.243"></a> +<span class="sourceLineNo">244</span> }<a name="line.244"></a> +<span class="sourceLineNo">245</span> }<a name="line.245"></a> +<span class="sourceLineNo">246</span> return parse(str, separator);<a name="line.246"></a> +<span class="sourceLineNo">247</span> }<a name="line.247"></a> +<span class="sourceLineNo">248</span><a name="line.248"></a> +<span class="sourceLineNo">249</span> /**<a name="line.249"></a> +<span class="sourceLineNo">250</span> * Extracts a map of name/value pairs from the given string. Names are<a name="line.250"></a> +<span class="sourceLineNo">251</span> * expected to be unique.<a name="line.251"></a> +<span class="sourceLineNo">252</span> *<a name="line.252"></a> +<span class="sourceLineNo">253</span> * @param str the string that contains a sequence of name/value pairs<a name="line.253"></a> +<span class="sourceLineNo">254</span> * @param separator the name/value pairs separator<a name="line.254"></a> +<span class="sourceLineNo">255</span> *<a name="line.255"></a> +<span class="sourceLineNo">256</span> * @return a map of name/value pairs<a name="line.256"></a> +<span class="sourceLineNo">257</span> */<a name="line.257"></a> +<span class="sourceLineNo">258</span> public Map<String, String> parse(final String str, char separator) {<a name="line.258"></a> +<span class="sourceLineNo">259</span> if (str == null) {<a name="line.259"></a> +<span class="sourceLineNo">260</span> return new HashMap<String, String>();<a name="line.260"></a> +<span class="sourceLineNo">261</span> }<a name="line.261"></a> +<span class="sourceLineNo">262</span> return parse(str.toCharArray(), separator);<a name="line.262"></a> +<span class="sourceLineNo">263</span> }<a name="line.263"></a> +<span class="sourceLineNo">264</span><a name="line.264"></a> +<span class="sourceLineNo">265</span> /**<a name="line.265"></a> +<span class="sourceLineNo">266</span> * Extracts a map of name/value pairs from the given array of<a name="line.266"></a> +<span class="sourceLineNo">267</span> * characters. Names are expected to be unique.<a name="line.267"></a> +<span class="sourceLineNo">268</span> *<a name="line.268"></a> +<span class="sourceLineNo">269</span> * @param charArray the array of characters that contains a sequence of<a name="line.269"></a> +<span class="sourceLineNo">270</span> * name/value pairs<a name="line.270"></a> +<span class="sourceLineNo">271</span> * @param separator the name/value pairs separator<a name="line.271"></a> +<span class="sourceLineNo">272</span> *<a name="line.272"></a> +<span class="sourceLineNo">273</span> * @return a map of name/value pairs<a name="line.273"></a> +<span class="sourceLineNo">274</span> */<a name="line.274"></a> +<span class="sourceLineNo">275</span> public Map<String, String> parse(final char[] charArray, char separator) {<a name="line.275"></a> +<span class="sourceLineNo">276</span> if (charArray == null) {<a name="line.276"></a> +<span class="sourceLineNo">277</span> return new HashMap<String, String>();<a name="line.277"></a> +<span class="sourceLineNo">278</span> }<a name="line.278"></a> +<span class="sourceLineNo">279</span> return parse(charArray, 0, charArray.length, separator);<a name="line.279"></a> +<span class="sourceLineNo">280</span> }<a name="line.280"></a> +<span class="sourceLineNo">281</span><a name="line.281"></a> +<span class="sourceLineNo">282</span> /**<a name="line.282"></a> +<span class="sourceLineNo">283</span> * Extracts a map of name/value pairs from the given array of<a name="line.283"></a> +<span class="sourceLineNo">284</span> * characters. Names are expected to be unique.<a name="line.284"></a> +<span class="sourceLineNo">285</span> *<a name="line.285"></a> +<span class="sourceLineNo">286</span> * @param charArray the array of characters that contains a sequence of<a name="line.286"></a> +<span class="sourceLineNo">287</span> * name/value pairs<a name="line.287"></a> +<span class="sourceLineNo">288</span> * @param offset - the initial offset.<a name="line.288"></a> +<span class="sourceLineNo">289</span> * @param length - the length.<a name="line.289"></a> +<span class="sourceLineNo">290</span> * @param separator the name/value pairs separator<a name="line.290"></a> +<span class="sourceLineNo">291</span> *<a name="line.291"></a> +<span class="sourceLineNo">292</span> * @return a map of name/value pairs<a name="line.292"></a> +<span class="sourceLineNo">293</span> */<a name="line.293"></a> +<span class="sourceLineNo">294</span> public Map<String, String> parse(<a name="line.294"></a> +<span class="sourceLineNo">295</span> final char[] charArray,<a name="line.295"></a> +<span class="sourceLineNo">296</span> int offset,<a name="line.296"></a> +<span class="sourceLineNo">297</span> int length,<a name="line.297"></a> +<span class="sourceLineNo">298</span> char separator) {<a name="line.298"></a> +<span class="sourceLineNo">299</span><a name="line.299"></a> +<span class="sourceLineNo">300</span> if (charArray == null) {<a name="line.300"></a> +<span class="sourceLineNo">301</span> return new HashMap<String, String>();<a name="line.301"></a> +<span class="sourceLineNo">302</span> }<a name="line.302"></a> +<span class="sourceLineNo">303</span> HashMap<String, String> params = new HashMap<String, String>();<a name="line.303"></a> +<span class="sourceLineNo">304</span> this.chars = charArray;<a name="line.304"></a> +<span class="sourceLineNo">305</span> this.pos = offset;<a name="line.305"></a> +<span class="sourceLineNo">306</span> this.len = length;<a name="line.306"></a> +<span class="sourceLineNo">307</span><a name="line.307"></a> +<span class="sourceLineNo">308</span> String paramName = null;<a name="line.308"></a> +<span class="sourceLineNo">309</span> String paramValue = null;<a name="line.309"></a> +<span class="sourceLineNo">310</span> while (hasChar()) {<a name="line.310"></a> +<span class="sourceLineNo">311</span> paramName = parseToken(new char[] {<a name="line.311"></a> +<span class="sourceLineNo">312</span> '=', separator });<a name="line.312"></a> +<span class="sourceLineNo">313</span> paramValue = null;<a name="line.313"></a> +<span class="sourceLineNo">314</span> if (hasChar() && (charArray[pos] == '=')) {<a name="line.314"></a> +<span class="sourceLineNo">315</span> pos++; // skip '='<a name="line.315"></a> +<span class="sourceLineNo">316</span> paramValue = parseQuotedToken(new char[] {<a name="line.316"></a> +<span class="sourceLineNo">317</span> separator });<a name="line.317"></a> +<span class="sourceLineNo">318</span><a name="line.318"></a> +<span class="sourceLineNo">319</span> if (paramValue != null) {<a name="line.319"></a> +<span class="sourceLineNo">320</span> try {<a name="line.320"></a> +<span class="sourceLineNo">321</span> paramValue = MimeUtility.decodeText(paramValue);<a name="line.321"></a> +<span class="sourceLineNo">322</span> } catch (UnsupportedEncodingException e) {<a name="line.322"></a> +<span class="sourceLineNo">323</span> // let's keep the original value in this case<a name="line.323"></a> +<span class="sourceLineNo">324</span> }<a name="line.324"></a> +<span class="sourceLineNo">325</span> }<a name="line.325"></a> +<span class="sourceLineNo">326</span> }<a name="line.326"></a> +<span class="sourceLineNo">327</span> if (hasChar() && (charArray[pos] == separator)) {<a name="line.327"></a> +<span class="sourceLineNo">328</span> pos++; // skip separator<a name="line.328"></a> +<span class="sourceLineNo">329</span> }<a name="line.329"></a> +<span class="sourceLineNo">330</span> if ((paramName != null) && (paramName.length() > 0)) {<a name="line.330"></a> +<span class="sourceLineNo">331</span> if (this.lowerCaseNames) {<a name="line.331"></a> +<span class="sourceLineNo">332</span> paramName = paramName.toLowerCase(Locale.ENGLISH);<a name="line.332"></a> +<span class="sourceLineNo">333</span> }<a name="line.333"></a> +<span class="sourceLineNo">334</span><a name="line.334"></a> +<span class="sourceLineNo">335</span> params.put(paramName, paramValue);<a name="line.335"></a> +<span class="sourceLineNo">336</span> }<a name="line.336"></a> +<span class="sourceLineNo">337</span> }<a name="line.337"></a> +<span class="sourceLineNo">338</span> return params;<a name="line.338"></a> +<span class="sourceLineNo">339</span> }<a name="line.339"></a> +<span class="sourceLineNo">340</span><a name="line.340"></a> +<span class="sourceLineNo">341</span>}<a name="line.341"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html>
Added: websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/ProgressListener.html ============================================================================== --- websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/ProgressListener.html (added) +++ websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/ProgressListener.html Tue Jun 13 12:48:38 2017 @@ -0,0 +1,111 @@ +<!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> * The {@link ProgressListener} may be used to display a progress bar<a name="line.20"></a> +<span class="sourceLineNo">021</span> * or do stuff like that.<a name="line.21"></a> +<span class="sourceLineNo">022</span> *<a name="line.22"></a> +<span class="sourceLineNo">023</span> * @version $Id$<a name="line.23"></a> +<span class="sourceLineNo">024</span> */<a name="line.24"></a> +<span class="sourceLineNo">025</span>public interface ProgressListener {<a name="line.25"></a> +<span class="sourceLineNo">026</span><a name="line.26"></a> +<span class="sourceLineNo">027</span> /**<a name="line.27"></a> +<span class="sourceLineNo">028</span> * Updates the listeners status information.<a name="line.28"></a> +<span class="sourceLineNo">029</span> *<a name="line.29"></a> +<span class="sourceLineNo">030</span> * @param pBytesRead The total number of bytes, which have been read<a name="line.30"></a> +<span class="sourceLineNo">031</span> * so far.<a name="line.31"></a> +<span class="sourceLineNo">032</span> * @param pContentLength The total number of bytes, which are being<a name="line.32"></a> +<span class="sourceLineNo">033</span> * read. May be -1, if this number is unknown.<a name="line.33"></a> +<span class="sourceLineNo">034</span> * @param pItems The number of the field, which is currently being<a name="line.34"></a> +<span class="sourceLineNo">035</span> * read. (0 = no item so far, 1 = first item is being read, ...)<a name="line.35"></a> +<span class="sourceLineNo">036</span> */<a name="line.36"></a> +<span class="sourceLineNo">037</span> void update(long pBytesRead, long pContentLength, int pItems);<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> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> Added: websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/RequestContext.html ============================================================================== --- websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/RequestContext.html (added) +++ websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/RequestContext.html Tue Jun 13 12:48:38 2017 @@ -0,0 +1,137 @@ +<!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.InputStream;<a name="line.19"></a> +<span class="sourceLineNo">020</span>import java.io.IOException;<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>Abstracts access to the request information needed for file uploads. This<a name="line.23"></a> +<span class="sourceLineNo">024</span> * interface should be implemented for each type of request that may be<a name="line.24"></a> +<span class="sourceLineNo">025</span> * handled by FileUpload, such as servlets and portlets.</p><a name="line.25"></a> +<span class="sourceLineNo">026</span> *<a name="line.26"></a> +<span class="sourceLineNo">027</span> * @since FileUpload 1.1<a name="line.27"></a> +<span class="sourceLineNo">028</span> *<a name="line.28"></a> +<span class="sourceLineNo">029</span> * @version $Id$<a name="line.29"></a> +<span class="sourceLineNo">030</span> */<a name="line.30"></a> +<span class="sourceLineNo">031</span>public interface RequestContext {<a name="line.31"></a> +<span class="sourceLineNo">032</span><a name="line.32"></a> +<span class="sourceLineNo">033</span> /**<a name="line.33"></a> +<span class="sourceLineNo">034</span> * Retrieve the character encoding for the request.<a name="line.34"></a> +<span class="sourceLineNo">035</span> *<a name="line.35"></a> +<span class="sourceLineNo">036</span> * @return The character encoding for the request.<a name="line.36"></a> +<span class="sourceLineNo">037</span> */<a name="line.37"></a> +<span class="sourceLineNo">038</span> String getCharacterEncoding();<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> * Retrieve the content type of the request.<a name="line.41"></a> +<span class="sourceLineNo">042</span> *<a name="line.42"></a> +<span class="sourceLineNo">043</span> * @return The content type of the request.<a name="line.43"></a> +<span class="sourceLineNo">044</span> */<a name="line.44"></a> +<span class="sourceLineNo">045</span> String getContentType();<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> * Retrieve the content length of the request.<a name="line.48"></a> +<span class="sourceLineNo">049</span> *<a name="line.49"></a> +<span class="sourceLineNo">050</span> * @return The content length of the request.<a name="line.50"></a> +<span class="sourceLineNo">051</span> * @deprecated 1.3 Use {@link UploadContext#contentLength()} instead<a name="line.51"></a> +<span class="sourceLineNo">052</span> */<a name="line.52"></a> +<span class="sourceLineNo">053</span> @Deprecated<a name="line.53"></a> +<span class="sourceLineNo">054</span> int getContentLength();<a name="line.54"></a> +<span class="sourceLineNo">055</span><a name="line.55"></a> +<span class="sourceLineNo">056</span> /**<a name="line.56"></a> +<span class="sourceLineNo">057</span> * Retrieve the input stream for the request.<a name="line.57"></a> +<span class="sourceLineNo">058</span> *<a name="line.58"></a> +<span class="sourceLineNo">059</span> * @return The input stream for the request.<a name="line.59"></a> +<span class="sourceLineNo">060</span> *<a name="line.60"></a> +<span class="sourceLineNo">061</span> * @throws IOException if a problem occurs.<a name="line.61"></a> +<span class="sourceLineNo">062</span> */<a name="line.62"></a> +<span class="sourceLineNo">063</span> InputStream getInputStream() throws IOException;<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> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> Added: websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/UploadContext.html ============================================================================== --- websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/UploadContext.html (added) +++ websites/production/commons/content/proper/commons-fileupload/javadocs/api-release/src-html/org/apache/commons/fileupload/UploadContext.html Tue Jun 13 12:48:38 2017 @@ -0,0 +1,111 @@ +<!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> * Enhanced access to the request information needed for file uploads,<a name="line.20"></a> +<span class="sourceLineNo">021</span> * which fixes the Content Length data access in {@link RequestContext}.<a name="line.21"></a> +<span class="sourceLineNo">022</span> *<a name="line.22"></a> +<span class="sourceLineNo">023</span> * The reason of introducing this new interface is just for backward compatibility<a name="line.23"></a> +<span class="sourceLineNo">024</span> * and it might vanish for a refactored 2.x version moving the new method into<a name="line.24"></a> +<span class="sourceLineNo">025</span> * RequestContext again.<a name="line.25"></a> +<span class="sourceLineNo">026</span> *<a name="line.26"></a> +<span class="sourceLineNo">027</span> * @since 1.3<a name="line.27"></a> +<span class="sourceLineNo">028</span> */<a name="line.28"></a> +<span class="sourceLineNo">029</span>public interface UploadContext extends RequestContext {<a name="line.29"></a> +<span class="sourceLineNo">030</span><a name="line.30"></a> +<span class="sourceLineNo">031</span> /**<a name="line.31"></a> +<span class="sourceLineNo">032</span> * Retrieve the content length of the request.<a name="line.32"></a> +<span class="sourceLineNo">033</span> *<a name="line.33"></a> +<span class="sourceLineNo">034</span> * @return The content length of the request.<a name="line.34"></a> +<span class="sourceLineNo">035</span> * @since 1.3<a name="line.35"></a> +<span class="sourceLineNo">036</span> */<a name="line.36"></a> +<span class="sourceLineNo">037</span> long contentLength();<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> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html>