http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/80ff9b74/content/site/apidocs/src-html/org/apache/juneau/rest/RestUtils.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/RestUtils.html b/content/site/apidocs/src-html/org/apache/juneau/rest/RestUtils.html index 1ea40ae..0452a5e 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/RestUtils.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/RestUtils.html @@ -20,249 +20,158 @@ <span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> <span class="sourceLineNo">013</span>package org.apache.juneau.rest;<a name="line.13"></a> <span class="sourceLineNo">014</span><a name="line.14"></a> -<span class="sourceLineNo">015</span>import java.io.*;<a name="line.15"></a> -<span class="sourceLineNo">016</span>import java.net.*;<a name="line.16"></a> -<span class="sourceLineNo">017</span>import java.util.*;<a name="line.17"></a> +<span class="sourceLineNo">015</span>import java.util.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span><a name="line.16"></a> +<span class="sourceLineNo">017</span>import javax.servlet.http.*;<a name="line.17"></a> <span class="sourceLineNo">018</span><a name="line.18"></a> -<span class="sourceLineNo">019</span>import javax.servlet.http.*;<a name="line.19"></a> +<span class="sourceLineNo">019</span>import org.apache.juneau.utils.*;<a name="line.19"></a> <span class="sourceLineNo">020</span><a name="line.20"></a> -<span class="sourceLineNo">021</span>import org.apache.juneau.internal.*;<a name="line.21"></a> -<span class="sourceLineNo">022</span>import org.apache.juneau.utils.*;<a name="line.22"></a> -<span class="sourceLineNo">023</span><a name="line.23"></a> -<span class="sourceLineNo">024</span>/**<a name="line.24"></a> -<span class="sourceLineNo">025</span> * Various reusable utility methods.<a name="line.25"></a> -<span class="sourceLineNo">026</span> */<a name="line.26"></a> -<span class="sourceLineNo">027</span>public final class RestUtils {<a name="line.27"></a> -<span class="sourceLineNo">028</span><a name="line.28"></a> -<span class="sourceLineNo">029</span> /**<a name="line.29"></a> -<span class="sourceLineNo">030</span> * Returns readable text for an HTTP response code.<a name="line.30"></a> -<span class="sourceLineNo">031</span> *<a name="line.31"></a> -<span class="sourceLineNo">032</span> * @param rc The HTTP response code.<a name="line.32"></a> -<span class="sourceLineNo">033</span> * @return Readable text for an HTTP response code, or <jk>null</jk> if it's an invalid code.<a name="line.33"></a> -<span class="sourceLineNo">034</span> */<a name="line.34"></a> -<span class="sourceLineNo">035</span> public static String getHttpResponseText(int rc) {<a name="line.35"></a> -<span class="sourceLineNo">036</span> return httpMsgs.get(rc);<a name="line.36"></a> -<span class="sourceLineNo">037</span> }<a name="line.37"></a> -<span class="sourceLineNo">038</span><a name="line.38"></a> -<span class="sourceLineNo">039</span> private static Map<Integer,String> httpMsgs = new AMap<Integer,String>()<a name="line.39"></a> -<span class="sourceLineNo">040</span> .append(200, "OK")<a name="line.40"></a> -<span class="sourceLineNo">041</span> .append(201, "Created")<a name="line.41"></a> -<span class="sourceLineNo">042</span> .append(202, "Accepted")<a name="line.42"></a> -<span class="sourceLineNo">043</span> .append(203, "Non-Authoritative Information")<a name="line.43"></a> -<span class="sourceLineNo">044</span> .append(204, "No Content")<a name="line.44"></a> -<span class="sourceLineNo">045</span> .append(205, "Reset Content")<a name="line.45"></a> -<span class="sourceLineNo">046</span> .append(206, "Partial Content")<a name="line.46"></a> -<span class="sourceLineNo">047</span> .append(300, "Multiple Choices")<a name="line.47"></a> -<span class="sourceLineNo">048</span> .append(301, "Moved Permanently")<a name="line.48"></a> -<span class="sourceLineNo">049</span> .append(302, "Temporary Redirect")<a name="line.49"></a> -<span class="sourceLineNo">050</span> .append(303, "See Other")<a name="line.50"></a> -<span class="sourceLineNo">051</span> .append(304, "Not Modified")<a name="line.51"></a> -<span class="sourceLineNo">052</span> .append(305, "Use Proxy")<a name="line.52"></a> -<span class="sourceLineNo">053</span> .append(307, "Temporary Redirect")<a name="line.53"></a> -<span class="sourceLineNo">054</span> .append(400, "Bad Request")<a name="line.54"></a> -<span class="sourceLineNo">055</span> .append(401, "Unauthorized")<a name="line.55"></a> -<span class="sourceLineNo">056</span> .append(402, "Payment Required")<a name="line.56"></a> -<span class="sourceLineNo">057</span> .append(403, "Forbidden")<a name="line.57"></a> -<span class="sourceLineNo">058</span> .append(404, "Not Found")<a name="line.58"></a> -<span class="sourceLineNo">059</span> .append(405, "Method Not Allowed")<a name="line.59"></a> -<span class="sourceLineNo">060</span> .append(406, "Not Acceptable")<a name="line.60"></a> -<span class="sourceLineNo">061</span> .append(407, "Proxy Authentication Required")<a name="line.61"></a> -<span class="sourceLineNo">062</span> .append(408, "Request Time-Out")<a name="line.62"></a> -<span class="sourceLineNo">063</span> .append(409, "Conflict")<a name="line.63"></a> -<span class="sourceLineNo">064</span> .append(410, "Gone")<a name="line.64"></a> -<span class="sourceLineNo">065</span> .append(411, "Length Required")<a name="line.65"></a> -<span class="sourceLineNo">066</span> .append(412, "Precondition Failed")<a name="line.66"></a> -<span class="sourceLineNo">067</span> .append(413, "Request Entity Too Large")<a name="line.67"></a> -<span class="sourceLineNo">068</span> .append(414, "Request-URI Too Large")<a name="line.68"></a> -<span class="sourceLineNo">069</span> .append(415, "Unsupported Media Type")<a name="line.69"></a> -<span class="sourceLineNo">070</span> .append(500, "Internal Server Error")<a name="line.70"></a> -<span class="sourceLineNo">071</span> .append(501, "Not Implemented")<a name="line.71"></a> -<span class="sourceLineNo">072</span> .append(502, "Bad Gateway")<a name="line.72"></a> -<span class="sourceLineNo">073</span> .append(503, "Service Unavailable")<a name="line.73"></a> -<span class="sourceLineNo">074</span> .append(504, "Gateway Timeout")<a name="line.74"></a> -<span class="sourceLineNo">075</span> .append(505, "HTTP Version Not Supported")<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> * Trims <js>'/'</js> characters from both the start and end of the specified string.<a name="line.79"></a> -<span class="sourceLineNo">080</span> *<a name="line.80"></a> -<span class="sourceLineNo">081</span> * @param s The string to trim.<a name="line.81"></a> -<span class="sourceLineNo">082</span> * @return A new trimmed string, or the same string if no trimming was necessary.<a name="line.82"></a> -<span class="sourceLineNo">083</span> */<a name="line.83"></a> -<span class="sourceLineNo">084</span> public static String trimSlashes(String s) {<a name="line.84"></a> -<span class="sourceLineNo">085</span> if (s == null)<a name="line.85"></a> -<span class="sourceLineNo">086</span> return null;<a name="line.86"></a> -<span class="sourceLineNo">087</span> while (StringUtils.endsWith(s, '/'))<a name="line.87"></a> -<span class="sourceLineNo">088</span> s = s.substring(0, s.length()-1);<a name="line.88"></a> -<span class="sourceLineNo">089</span> while (s.length() > 0 && s.charAt(0) == '/')<a name="line.89"></a> -<span class="sourceLineNo">090</span> s = s.substring(1);<a name="line.90"></a> -<span class="sourceLineNo">091</span> return s;<a name="line.91"></a> -<span class="sourceLineNo">092</span> }<a name="line.92"></a> -<span class="sourceLineNo">093</span><a name="line.93"></a> -<span class="sourceLineNo">094</span> /**<a name="line.94"></a> -<span class="sourceLineNo">095</span> * Trims <js>'/'</js> characters from the end of the specified string.<a name="line.95"></a> -<span class="sourceLineNo">096</span> *<a name="line.96"></a> -<span class="sourceLineNo">097</span> * @param s The string to trim.<a name="line.97"></a> -<span class="sourceLineNo">098</span> * @return A new trimmed string, or the same string if no trimming was necessary.<a name="line.98"></a> -<span class="sourceLineNo">099</span> */<a name="line.99"></a> -<span class="sourceLineNo">100</span> public static String trimTrailingSlashes(String s) {<a name="line.100"></a> -<span class="sourceLineNo">101</span> if (s == null)<a name="line.101"></a> -<span class="sourceLineNo">102</span> return null;<a name="line.102"></a> -<span class="sourceLineNo">103</span> while (StringUtils.endsWith(s, '/'))<a name="line.103"></a> -<span class="sourceLineNo">104</span> s = s.substring(0, s.length()-1);<a name="line.104"></a> -<span class="sourceLineNo">105</span> return s;<a name="line.105"></a> -<span class="sourceLineNo">106</span> }<a name="line.106"></a> -<span class="sourceLineNo">107</span><a name="line.107"></a> -<span class="sourceLineNo">108</span> /**<a name="line.108"></a> -<span class="sourceLineNo">109</span> * Trims <js>'/'</js> characters from the end of the specified string.<a name="line.109"></a> -<span class="sourceLineNo">110</span> *<a name="line.110"></a> -<span class="sourceLineNo">111</span> * @param s The string to trim.<a name="line.111"></a> -<span class="sourceLineNo">112</span> * @return The same string buffer.<a name="line.112"></a> -<span class="sourceLineNo">113</span> */<a name="line.113"></a> -<span class="sourceLineNo">114</span> public static StringBuffer trimTrailingSlashes(StringBuffer s) {<a name="line.114"></a> -<span class="sourceLineNo">115</span> if (s == null)<a name="line.115"></a> -<span class="sourceLineNo">116</span> return null;<a name="line.116"></a> -<span class="sourceLineNo">117</span> while (s.length() > 0 && s.charAt(s.length()-1) == '/')<a name="line.117"></a> -<span class="sourceLineNo">118</span> s.setLength(s.length()-1);<a name="line.118"></a> -<span class="sourceLineNo">119</span> return s;<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> /**<a name="line.122"></a> -<span class="sourceLineNo">123</span> * Decodes a <code>application/x-www-form-urlencoded</code> string using <code>UTF-8</code> encoding scheme.<a name="line.123"></a> -<span class="sourceLineNo">124</span> *<a name="line.124"></a> -<span class="sourceLineNo">125</span> * @param s The string to decode.<a name="line.125"></a> -<span class="sourceLineNo">126</span> * @return The decoded string, or <jk>null</jk> if input is <jk>null</jk>.<a name="line.126"></a> -<span class="sourceLineNo">127</span> */<a name="line.127"></a> -<span class="sourceLineNo">128</span> public static String decode(String s) {<a name="line.128"></a> -<span class="sourceLineNo">129</span> if (s == null)<a name="line.129"></a> -<span class="sourceLineNo">130</span> return s;<a name="line.130"></a> -<span class="sourceLineNo">131</span> boolean needsDecode = false;<a name="line.131"></a> -<span class="sourceLineNo">132</span> for (int i = 0; i < s.length() && ! needsDecode; i++) {<a name="line.132"></a> -<span class="sourceLineNo">133</span> char c = s.charAt(i);<a name="line.133"></a> -<span class="sourceLineNo">134</span> if (c == '+' || c == '%')<a name="line.134"></a> -<span class="sourceLineNo">135</span> needsDecode = true;<a name="line.135"></a> -<span class="sourceLineNo">136</span> }<a name="line.136"></a> -<span class="sourceLineNo">137</span> if (needsDecode)<a name="line.137"></a> -<span class="sourceLineNo">138</span> try {<a name="line.138"></a> -<span class="sourceLineNo">139</span> return URLDecoder.decode(s, "UTF-8");<a name="line.139"></a> -<span class="sourceLineNo">140</span> } catch (UnsupportedEncodingException e) {/* Won't happen */}<a name="line.140"></a> -<span class="sourceLineNo">141</span> return s;<a name="line.141"></a> -<span class="sourceLineNo">142</span> }<a name="line.142"></a> -<span class="sourceLineNo">143</span><a name="line.143"></a> -<span class="sourceLineNo">144</span> // Characters that do not need to be URL-encoded<a name="line.144"></a> -<span class="sourceLineNo">145</span> private static final AsciiSet unencodedChars = new AsciiSet("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_.!~*'()\\");<a name="line.145"></a> -<span class="sourceLineNo">146</span><a name="line.146"></a> -<span class="sourceLineNo">147</span> /**<a name="line.147"></a> -<span class="sourceLineNo">148</span> * Encodes a <code>application/x-www-form-urlencoded</code> string using <code>UTF-8</code> encoding scheme.<a name="line.148"></a> -<span class="sourceLineNo">149</span> *<a name="line.149"></a> -<span class="sourceLineNo">150</span> * @param s The string to encode.<a name="line.150"></a> -<span class="sourceLineNo">151</span> * @return The encoded string, or <jk>null</jk> if input is <jk>null</jk>.<a name="line.151"></a> -<span class="sourceLineNo">152</span> */<a name="line.152"></a> -<span class="sourceLineNo">153</span> public static String encode(String s) {<a name="line.153"></a> -<span class="sourceLineNo">154</span> if (s == null)<a name="line.154"></a> -<span class="sourceLineNo">155</span> return null;<a name="line.155"></a> -<span class="sourceLineNo">156</span> boolean needsEncode = false;<a name="line.156"></a> -<span class="sourceLineNo">157</span> for (int i = 0; i < s.length() && ! needsEncode; i++)<a name="line.157"></a> -<span class="sourceLineNo">158</span> needsEncode |= (! unencodedChars.contains(s.charAt(i)));<a name="line.158"></a> -<span class="sourceLineNo">159</span> if (needsEncode)<a name="line.159"></a> -<span class="sourceLineNo">160</span> try {<a name="line.160"></a> -<span class="sourceLineNo">161</span> return URLEncoder.encode(s, "UTF-8");<a name="line.161"></a> -<span class="sourceLineNo">162</span> } catch (UnsupportedEncodingException e) {/* Won't happen */}<a name="line.162"></a> -<span class="sourceLineNo">163</span> return s;<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> /**<a name="line.166"></a> -<span class="sourceLineNo">167</span> * Identical to {@link HttpServletRequest#getPathInfo()} but doesn't decode encoded characters.<a name="line.167"></a> -<span class="sourceLineNo">168</span> *<a name="line.168"></a> -<span class="sourceLineNo">169</span> * @param req The HTTP request<a name="line.169"></a> -<span class="sourceLineNo">170</span> * @return The undecoded path info.<a name="line.170"></a> -<span class="sourceLineNo">171</span> */<a name="line.171"></a> -<span class="sourceLineNo">172</span> public static String getPathInfoUndecoded(HttpServletRequest req) {<a name="line.172"></a> -<span class="sourceLineNo">173</span> String requestURI = req.getRequestURI();<a name="line.173"></a> -<span class="sourceLineNo">174</span> String contextPath = req.getContextPath();<a name="line.174"></a> -<span class="sourceLineNo">175</span> String servletPath = req.getServletPath();<a name="line.175"></a> -<span class="sourceLineNo">176</span> int l = contextPath.length() + servletPath.length();<a name="line.176"></a> -<span class="sourceLineNo">177</span> if (requestURI.length() == l)<a name="line.177"></a> -<span class="sourceLineNo">178</span> return null;<a name="line.178"></a> -<span class="sourceLineNo">179</span> return requestURI.substring(l);<a name="line.179"></a> -<span class="sourceLineNo">180</span> }<a name="line.180"></a> -<span class="sourceLineNo">181</span><a name="line.181"></a> -<span class="sourceLineNo">182</span> /**<a name="line.182"></a> -<span class="sourceLineNo">183</span> * Efficiently trims the path info part from a request URI.<a name="line.183"></a> -<span class="sourceLineNo">184</span> * <p><a name="line.184"></a> -<span class="sourceLineNo">185</span> * The result is the URI of the servlet itself.<a name="line.185"></a> -<span class="sourceLineNo">186</span> *<a name="line.186"></a> -<span class="sourceLineNo">187</span> * @param requestURI The value returned by {@link HttpServletRequest#getRequestURL()}<a name="line.187"></a> -<span class="sourceLineNo">188</span> * @param contextPath The value returned by {@link HttpServletRequest#getContextPath()}<a name="line.188"></a> -<span class="sourceLineNo">189</span> * @param servletPath The value returned by {@link HttpServletRequest#getServletPath()}<a name="line.189"></a> -<span class="sourceLineNo">190</span> * @return The same StringBuilder with remainder trimmed.<a name="line.190"></a> -<span class="sourceLineNo">191</span> */<a name="line.191"></a> -<span class="sourceLineNo">192</span> public static StringBuffer trimPathInfo(StringBuffer requestURI, String contextPath, String servletPath) {<a name="line.192"></a> -<span class="sourceLineNo">193</span> if (servletPath.equals("/"))<a name="line.193"></a> -<span class="sourceLineNo">194</span> servletPath = "";<a name="line.194"></a> -<span class="sourceLineNo">195</span> if (contextPath.equals("/"))<a name="line.195"></a> -<span class="sourceLineNo">196</span> contextPath = "";<a name="line.196"></a> -<span class="sourceLineNo">197</span><a name="line.197"></a> -<span class="sourceLineNo">198</span> try {<a name="line.198"></a> -<span class="sourceLineNo">199</span> // Given URL: http://hostname:port/servletPath/extra<a name="line.199"></a> -<span class="sourceLineNo">200</span> // We want: http://hostname:port/servletPath<a name="line.200"></a> -<span class="sourceLineNo">201</span> int sc = 0;<a name="line.201"></a> -<span class="sourceLineNo">202</span> for (int i = 0; i < requestURI.length(); i++) {<a name="line.202"></a> -<span class="sourceLineNo">203</span> char c = requestURI.charAt(i);<a name="line.203"></a> -<span class="sourceLineNo">204</span> if (c == '/') {<a name="line.204"></a> -<span class="sourceLineNo">205</span> sc++;<a name="line.205"></a> -<span class="sourceLineNo">206</span> if (sc == 3) {<a name="line.206"></a> -<span class="sourceLineNo">207</span> if (servletPath.isEmpty()) {<a name="line.207"></a> -<span class="sourceLineNo">208</span> requestURI.setLength(i);<a name="line.208"></a> -<span class="sourceLineNo">209</span> return requestURI;<a name="line.209"></a> -<span class="sourceLineNo">210</span> }<a name="line.210"></a> -<span class="sourceLineNo">211</span><a name="line.211"></a> -<span class="sourceLineNo">212</span> // Make sure context path follows the authority.<a name="line.212"></a> -<span class="sourceLineNo">213</span> for (int j = 0; j < contextPath.length(); i++, j++)<a name="line.213"></a> -<span class="sourceLineNo">214</span> if (requestURI.charAt(i) != contextPath.charAt(j))<a name="line.214"></a> -<span class="sourceLineNo">215</span> throw new Exception("case=1");<a name="line.215"></a> -<span class="sourceLineNo">216</span><a name="line.216"></a> -<span class="sourceLineNo">217</span> // Make sure servlet path follows the authority.<a name="line.217"></a> -<span class="sourceLineNo">218</span> for (int j = 0; j < servletPath.length(); i++, j++)<a name="line.218"></a> -<span class="sourceLineNo">219</span> if (requestURI.charAt(i) != servletPath.charAt(j))<a name="line.219"></a> -<span class="sourceLineNo">220</span> throw new Exception("case=2");<a name="line.220"></a> -<span class="sourceLineNo">221</span><a name="line.221"></a> -<span class="sourceLineNo">222</span> // Make sure servlet path isn't a false match (e.g. /foo2 should not match /foo)<a name="line.222"></a> -<span class="sourceLineNo">223</span> c = (requestURI.length() == i ? '/' : requestURI.charAt(i));<a name="line.223"></a> -<span class="sourceLineNo">224</span> if (c == '/' || c == '?') {<a name="line.224"></a> -<span class="sourceLineNo">225</span> requestURI.setLength(i);<a name="line.225"></a> -<span class="sourceLineNo">226</span> return requestURI;<a name="line.226"></a> -<span class="sourceLineNo">227</span> }<a name="line.227"></a> -<span class="sourceLineNo">228</span><a name="line.228"></a> -<span class="sourceLineNo">229</span> throw new Exception("case=3");<a name="line.229"></a> -<span class="sourceLineNo">230</span> }<a name="line.230"></a> -<span class="sourceLineNo">231</span> } else if (c == '?') {<a name="line.231"></a> -<span class="sourceLineNo">232</span> if (sc != 2)<a name="line.232"></a> -<span class="sourceLineNo">233</span> throw new Exception("case=4");<a name="line.233"></a> -<span class="sourceLineNo">234</span> if (servletPath.isEmpty()) {<a name="line.234"></a> -<span class="sourceLineNo">235</span> requestURI.setLength(i);<a name="line.235"></a> -<span class="sourceLineNo">236</span> return requestURI;<a name="line.236"></a> -<span class="sourceLineNo">237</span> }<a name="line.237"></a> -<span class="sourceLineNo">238</span> throw new Exception("case=5");<a name="line.238"></a> -<span class="sourceLineNo">239</span> }<a name="line.239"></a> -<span class="sourceLineNo">240</span> }<a name="line.240"></a> -<span class="sourceLineNo">241</span> if (servletPath.isEmpty())<a name="line.241"></a> -<span class="sourceLineNo">242</span> return requestURI;<a name="line.242"></a> -<span class="sourceLineNo">243</span> throw new Exception("case=6");<a name="line.243"></a> -<span class="sourceLineNo">244</span> } catch (Exception e) {<a name="line.244"></a> -<span class="sourceLineNo">245</span> throw new RuntimeException("Could not find servlet path in request URI. URI=["+requestURI+"], servletPath=["+servletPath+"]", e);<a name="line.245"></a> -<span class="sourceLineNo">246</span> }<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> static String[] parseHeader(String s) {<a name="line.249"></a> -<span class="sourceLineNo">250</span> int i = s.indexOf(':');<a name="line.250"></a> -<span class="sourceLineNo">251</span> if (i == -1)<a name="line.251"></a> -<span class="sourceLineNo">252</span> return null;<a name="line.252"></a> -<span class="sourceLineNo">253</span> String name = s.substring(0, i).trim().toLowerCase(Locale.ENGLISH);<a name="line.253"></a> -<span class="sourceLineNo">254</span> String val = s.substring(i+1).trim();<a name="line.254"></a> -<span class="sourceLineNo">255</span> return new String[]{name,val};<a name="line.255"></a> -<span class="sourceLineNo">256</span> }<a name="line.256"></a> -<span class="sourceLineNo">257</span>}<a name="line.257"></a> +<span class="sourceLineNo">021</span>/**<a name="line.21"></a> +<span class="sourceLineNo">022</span> * Various reusable utility methods.<a name="line.22"></a> +<span class="sourceLineNo">023</span> */<a name="line.23"></a> +<span class="sourceLineNo">024</span>public final class RestUtils {<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> * Returns readable text for an HTTP response code.<a name="line.27"></a> +<span class="sourceLineNo">028</span> *<a name="line.28"></a> +<span class="sourceLineNo">029</span> * @param rc The HTTP response code.<a name="line.29"></a> +<span class="sourceLineNo">030</span> * @return Readable text for an HTTP response code, or <jk>null</jk> if it's an invalid code.<a name="line.30"></a> +<span class="sourceLineNo">031</span> */<a name="line.31"></a> +<span class="sourceLineNo">032</span> public static String getHttpResponseText(int rc) {<a name="line.32"></a> +<span class="sourceLineNo">033</span> return httpMsgs.get(rc);<a name="line.33"></a> +<span class="sourceLineNo">034</span> }<a name="line.34"></a> +<span class="sourceLineNo">035</span><a name="line.35"></a> +<span class="sourceLineNo">036</span> private static Map<Integer,String> httpMsgs = new AMap<Integer,String>()<a name="line.36"></a> +<span class="sourceLineNo">037</span> .append(200, "OK")<a name="line.37"></a> +<span class="sourceLineNo">038</span> .append(201, "Created")<a name="line.38"></a> +<span class="sourceLineNo">039</span> .append(202, "Accepted")<a name="line.39"></a> +<span class="sourceLineNo">040</span> .append(203, "Non-Authoritative Information")<a name="line.40"></a> +<span class="sourceLineNo">041</span> .append(204, "No Content")<a name="line.41"></a> +<span class="sourceLineNo">042</span> .append(205, "Reset Content")<a name="line.42"></a> +<span class="sourceLineNo">043</span> .append(206, "Partial Content")<a name="line.43"></a> +<span class="sourceLineNo">044</span> .append(300, "Multiple Choices")<a name="line.44"></a> +<span class="sourceLineNo">045</span> .append(301, "Moved Permanently")<a name="line.45"></a> +<span class="sourceLineNo">046</span> .append(302, "Temporary Redirect")<a name="line.46"></a> +<span class="sourceLineNo">047</span> .append(303, "See Other")<a name="line.47"></a> +<span class="sourceLineNo">048</span> .append(304, "Not Modified")<a name="line.48"></a> +<span class="sourceLineNo">049</span> .append(305, "Use Proxy")<a name="line.49"></a> +<span class="sourceLineNo">050</span> .append(307, "Temporary Redirect")<a name="line.50"></a> +<span class="sourceLineNo">051</span> .append(400, "Bad Request")<a name="line.51"></a> +<span class="sourceLineNo">052</span> .append(401, "Unauthorized")<a name="line.52"></a> +<span class="sourceLineNo">053</span> .append(402, "Payment Required")<a name="line.53"></a> +<span class="sourceLineNo">054</span> .append(403, "Forbidden")<a name="line.54"></a> +<span class="sourceLineNo">055</span> .append(404, "Not Found")<a name="line.55"></a> +<span class="sourceLineNo">056</span> .append(405, "Method Not Allowed")<a name="line.56"></a> +<span class="sourceLineNo">057</span> .append(406, "Not Acceptable")<a name="line.57"></a> +<span class="sourceLineNo">058</span> .append(407, "Proxy Authentication Required")<a name="line.58"></a> +<span class="sourceLineNo">059</span> .append(408, "Request Time-Out")<a name="line.59"></a> +<span class="sourceLineNo">060</span> .append(409, "Conflict")<a name="line.60"></a> +<span class="sourceLineNo">061</span> .append(410, "Gone")<a name="line.61"></a> +<span class="sourceLineNo">062</span> .append(411, "Length Required")<a name="line.62"></a> +<span class="sourceLineNo">063</span> .append(412, "Precondition Failed")<a name="line.63"></a> +<span class="sourceLineNo">064</span> .append(413, "Request Entity Too Large")<a name="line.64"></a> +<span class="sourceLineNo">065</span> .append(414, "Request-URI Too Large")<a name="line.65"></a> +<span class="sourceLineNo">066</span> .append(415, "Unsupported Media Type")<a name="line.66"></a> +<span class="sourceLineNo">067</span> .append(500, "Internal Server Error")<a name="line.67"></a> +<span class="sourceLineNo">068</span> .append(501, "Not Implemented")<a name="line.68"></a> +<span class="sourceLineNo">069</span> .append(502, "Bad Gateway")<a name="line.69"></a> +<span class="sourceLineNo">070</span> .append(503, "Service Unavailable")<a name="line.70"></a> +<span class="sourceLineNo">071</span> .append(504, "Gateway Timeout")<a name="line.71"></a> +<span class="sourceLineNo">072</span> .append(505, "HTTP Version Not Supported")<a name="line.72"></a> +<span class="sourceLineNo">073</span> ;<a name="line.73"></a> +<span class="sourceLineNo">074</span><a name="line.74"></a> +<span class="sourceLineNo">075</span> /**<a name="line.75"></a> +<span class="sourceLineNo">076</span> * Identical to {@link HttpServletRequest#getPathInfo()} but doesn't decode encoded characters.<a name="line.76"></a> +<span class="sourceLineNo">077</span> *<a name="line.77"></a> +<span class="sourceLineNo">078</span> * @param req The HTTP request<a name="line.78"></a> +<span class="sourceLineNo">079</span> * @return The undecoded path info.<a name="line.79"></a> +<span class="sourceLineNo">080</span> */<a name="line.80"></a> +<span class="sourceLineNo">081</span> public static String getPathInfoUndecoded(HttpServletRequest req) {<a name="line.81"></a> +<span class="sourceLineNo">082</span> String requestURI = req.getRequestURI();<a name="line.82"></a> +<span class="sourceLineNo">083</span> String contextPath = req.getContextPath();<a name="line.83"></a> +<span class="sourceLineNo">084</span> String servletPath = req.getServletPath();<a name="line.84"></a> +<span class="sourceLineNo">085</span> int l = contextPath.length() + servletPath.length();<a name="line.85"></a> +<span class="sourceLineNo">086</span> if (requestURI.length() == l)<a name="line.86"></a> +<span class="sourceLineNo">087</span> return null;<a name="line.87"></a> +<span class="sourceLineNo">088</span> return requestURI.substring(l);<a name="line.88"></a> +<span class="sourceLineNo">089</span> }<a name="line.89"></a> +<span class="sourceLineNo">090</span><a name="line.90"></a> +<span class="sourceLineNo">091</span> /**<a name="line.91"></a> +<span class="sourceLineNo">092</span> * Efficiently trims the path info part from a request URI.<a name="line.92"></a> +<span class="sourceLineNo">093</span> * <p><a name="line.93"></a> +<span class="sourceLineNo">094</span> * The result is the URI of the servlet itself.<a name="line.94"></a> +<span class="sourceLineNo">095</span> *<a name="line.95"></a> +<span class="sourceLineNo">096</span> * @param requestURI The value returned by {@link HttpServletRequest#getRequestURL()}<a name="line.96"></a> +<span class="sourceLineNo">097</span> * @param contextPath The value returned by {@link HttpServletRequest#getContextPath()}<a name="line.97"></a> +<span class="sourceLineNo">098</span> * @param servletPath The value returned by {@link HttpServletRequest#getServletPath()}<a name="line.98"></a> +<span class="sourceLineNo">099</span> * @return The same StringBuilder with remainder trimmed.<a name="line.99"></a> +<span class="sourceLineNo">100</span> */<a name="line.100"></a> +<span class="sourceLineNo">101</span> public static StringBuffer trimPathInfo(StringBuffer requestURI, String contextPath, String servletPath) {<a name="line.101"></a> +<span class="sourceLineNo">102</span> if (servletPath.equals("/"))<a name="line.102"></a> +<span class="sourceLineNo">103</span> servletPath = "";<a name="line.103"></a> +<span class="sourceLineNo">104</span> if (contextPath.equals("/"))<a name="line.104"></a> +<span class="sourceLineNo">105</span> contextPath = "";<a name="line.105"></a> +<span class="sourceLineNo">106</span><a name="line.106"></a> +<span class="sourceLineNo">107</span> try {<a name="line.107"></a> +<span class="sourceLineNo">108</span> // Given URL: http://hostname:port/servletPath/extra<a name="line.108"></a> +<span class="sourceLineNo">109</span> // We want: http://hostname:port/servletPath<a name="line.109"></a> +<span class="sourceLineNo">110</span> int sc = 0;<a name="line.110"></a> +<span class="sourceLineNo">111</span> for (int i = 0; i < requestURI.length(); i++) {<a name="line.111"></a> +<span class="sourceLineNo">112</span> char c = requestURI.charAt(i);<a name="line.112"></a> +<span class="sourceLineNo">113</span> if (c == '/') {<a name="line.113"></a> +<span class="sourceLineNo">114</span> sc++;<a name="line.114"></a> +<span class="sourceLineNo">115</span> if (sc == 3) {<a name="line.115"></a> +<span class="sourceLineNo">116</span> if (servletPath.isEmpty()) {<a name="line.116"></a> +<span class="sourceLineNo">117</span> requestURI.setLength(i);<a name="line.117"></a> +<span class="sourceLineNo">118</span> return requestURI;<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> // Make sure context path follows the authority.<a name="line.121"></a> +<span class="sourceLineNo">122</span> for (int j = 0; j < contextPath.length(); i++, j++)<a name="line.122"></a> +<span class="sourceLineNo">123</span> if (requestURI.charAt(i) != contextPath.charAt(j))<a name="line.123"></a> +<span class="sourceLineNo">124</span> throw new Exception("case=1");<a name="line.124"></a> +<span class="sourceLineNo">125</span><a name="line.125"></a> +<span class="sourceLineNo">126</span> // Make sure servlet path follows the authority.<a name="line.126"></a> +<span class="sourceLineNo">127</span> for (int j = 0; j < servletPath.length(); i++, j++)<a name="line.127"></a> +<span class="sourceLineNo">128</span> if (requestURI.charAt(i) != servletPath.charAt(j))<a name="line.128"></a> +<span class="sourceLineNo">129</span> throw new Exception("case=2");<a name="line.129"></a> +<span class="sourceLineNo">130</span><a name="line.130"></a> +<span class="sourceLineNo">131</span> // Make sure servlet path isn't a false match (e.g. /foo2 should not match /foo)<a name="line.131"></a> +<span class="sourceLineNo">132</span> c = (requestURI.length() == i ? '/' : requestURI.charAt(i));<a name="line.132"></a> +<span class="sourceLineNo">133</span> if (c == '/' || c == '?') {<a name="line.133"></a> +<span class="sourceLineNo">134</span> requestURI.setLength(i);<a name="line.134"></a> +<span class="sourceLineNo">135</span> return requestURI;<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> throw new Exception("case=3");<a name="line.138"></a> +<span class="sourceLineNo">139</span> }<a name="line.139"></a> +<span class="sourceLineNo">140</span> } else if (c == '?') {<a name="line.140"></a> +<span class="sourceLineNo">141</span> if (sc != 2)<a name="line.141"></a> +<span class="sourceLineNo">142</span> throw new Exception("case=4");<a name="line.142"></a> +<span class="sourceLineNo">143</span> if (servletPath.isEmpty()) {<a name="line.143"></a> +<span class="sourceLineNo">144</span> requestURI.setLength(i);<a name="line.144"></a> +<span class="sourceLineNo">145</span> return requestURI;<a name="line.145"></a> +<span class="sourceLineNo">146</span> }<a name="line.146"></a> +<span class="sourceLineNo">147</span> throw new Exception("case=5");<a name="line.147"></a> +<span class="sourceLineNo">148</span> }<a name="line.148"></a> +<span class="sourceLineNo">149</span> }<a name="line.149"></a> +<span class="sourceLineNo">150</span> if (servletPath.isEmpty())<a name="line.150"></a> +<span class="sourceLineNo">151</span> return requestURI;<a name="line.151"></a> +<span class="sourceLineNo">152</span> throw new Exception("case=6");<a name="line.152"></a> +<span class="sourceLineNo">153</span> } catch (Exception e) {<a name="line.153"></a> +<span class="sourceLineNo">154</span> throw new RuntimeException("Could not find servlet path in request URI. URI=["+requestURI+"], servletPath=["+servletPath+"]", e);<a name="line.154"></a> +<span class="sourceLineNo">155</span> }<a name="line.155"></a> +<span class="sourceLineNo">156</span> }<a name="line.156"></a> +<span class="sourceLineNo">157</span><a name="line.157"></a> +<span class="sourceLineNo">158</span> static String[] parseHeader(String s) {<a name="line.158"></a> +<span class="sourceLineNo">159</span> int i = s.indexOf(':');<a name="line.159"></a> +<span class="sourceLineNo">160</span> if (i == -1)<a name="line.160"></a> +<span class="sourceLineNo">161</span> return null;<a name="line.161"></a> +<span class="sourceLineNo">162</span> String name = s.substring(0, i).trim().toLowerCase(Locale.ENGLISH);<a name="line.162"></a> +<span class="sourceLineNo">163</span> String val = s.substring(i+1).trim();<a name="line.163"></a> +<span class="sourceLineNo">164</span> return new String[]{name,val};<a name="line.164"></a> +<span class="sourceLineNo">165</span> }<a name="line.165"></a> +<span class="sourceLineNo">166</span>}<a name="line.166"></a>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/80ff9b74/content/site/apidocs/src-html/org/apache/juneau/rest/UrlPathPattern.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/UrlPathPattern.html b/content/site/apidocs/src-html/org/apache/juneau/rest/UrlPathPattern.html index 6d5735c..77b8205 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/UrlPathPattern.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/UrlPathPattern.html @@ -20,181 +20,180 @@ <span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> <span class="sourceLineNo">013</span>package org.apache.juneau.rest;<a name="line.13"></a> <span class="sourceLineNo">014</span><a name="line.14"></a> -<span class="sourceLineNo">015</span>import static org.apache.juneau.rest.RestUtils.*;<a name="line.15"></a> +<span class="sourceLineNo">015</span>import static org.apache.juneau.internal.StringUtils.*;<a name="line.15"></a> <span class="sourceLineNo">016</span><a name="line.16"></a> <span class="sourceLineNo">017</span>import java.util.*;<a name="line.17"></a> <span class="sourceLineNo">018</span>import java.util.regex.*;<a name="line.18"></a> <span class="sourceLineNo">019</span><a name="line.19"></a> -<span class="sourceLineNo">020</span>import org.apache.juneau.internal.*;<a name="line.20"></a> -<span class="sourceLineNo">021</span>import org.apache.juneau.rest.annotation.*;<a name="line.21"></a> -<span class="sourceLineNo">022</span><a name="line.22"></a> -<span class="sourceLineNo">023</span>/**<a name="line.23"></a> -<span class="sourceLineNo">024</span> * A parsed path pattern constructed from a {@link RestMethod#path()} value.<a name="line.24"></a> -<span class="sourceLineNo">025</span> * <p><a name="line.25"></a> -<span class="sourceLineNo">026</span> * Handles aspects of matching and precedence ordering.<a name="line.26"></a> -<span class="sourceLineNo">027</span> */<a name="line.27"></a> -<span class="sourceLineNo">028</span>public final class UrlPathPattern implements Comparable<UrlPathPattern> {<a name="line.28"></a> -<span class="sourceLineNo">029</span><a name="line.29"></a> -<span class="sourceLineNo">030</span> private final Pattern pattern;<a name="line.30"></a> -<span class="sourceLineNo">031</span> private final String patternString;<a name="line.31"></a> -<span class="sourceLineNo">032</span> private final boolean isOnlyDotAll, isDotAll;<a name="line.32"></a> -<span class="sourceLineNo">033</span> private final String[] vars;<a name="line.33"></a> -<span class="sourceLineNo">034</span><a name="line.34"></a> -<span class="sourceLineNo">035</span> /**<a name="line.35"></a> -<span class="sourceLineNo">036</span> * Constructor.<a name="line.36"></a> -<span class="sourceLineNo">037</span> *<a name="line.37"></a> -<span class="sourceLineNo">038</span> * @param patternString The raw pattern string from the {@link RestMethod#path()} annotation.<a name="line.38"></a> -<span class="sourceLineNo">039</span> */<a name="line.39"></a> -<span class="sourceLineNo">040</span> public UrlPathPattern(String patternString) {<a name="line.40"></a> -<span class="sourceLineNo">041</span> this.patternString = patternString;<a name="line.41"></a> -<span class="sourceLineNo">042</span> Builder b = new Builder(patternString);<a name="line.42"></a> -<span class="sourceLineNo">043</span> pattern = b.pattern;<a name="line.43"></a> -<span class="sourceLineNo">044</span> isDotAll = b.isDotAll;<a name="line.44"></a> -<span class="sourceLineNo">045</span> isOnlyDotAll = b.isOnlyDotAll;<a name="line.45"></a> -<span class="sourceLineNo">046</span> vars = b.vars.toArray(new String[b.vars.size()]);<a name="line.46"></a> -<span class="sourceLineNo">047</span> }<a name="line.47"></a> -<span class="sourceLineNo">048</span><a name="line.48"></a> -<span class="sourceLineNo">049</span> @SuppressWarnings("hiding")<a name="line.49"></a> -<span class="sourceLineNo">050</span> class Builder {<a name="line.50"></a> -<span class="sourceLineNo">051</span> boolean isDotAll, isOnlyDotAll;<a name="line.51"></a> -<span class="sourceLineNo">052</span> Pattern pattern;<a name="line.52"></a> -<span class="sourceLineNo">053</span> List<String> vars = new LinkedList<String>();<a name="line.53"></a> -<span class="sourceLineNo">054</span><a name="line.54"></a> -<span class="sourceLineNo">055</span> private Builder(String patternString) {<a name="line.55"></a> -<span class="sourceLineNo">056</span> if (! StringUtils.startsWith(patternString, '/'))<a name="line.56"></a> -<span class="sourceLineNo">057</span> patternString = '/' + patternString;<a name="line.57"></a> -<span class="sourceLineNo">058</span> if (patternString.equals("/*")) {<a name="line.58"></a> -<span class="sourceLineNo">059</span> isOnlyDotAll = true;<a name="line.59"></a> -<span class="sourceLineNo">060</span> return;<a name="line.60"></a> -<span class="sourceLineNo">061</span> }<a name="line.61"></a> -<span class="sourceLineNo">062</span> if (patternString.endsWith("/*"))<a name="line.62"></a> -<span class="sourceLineNo">063</span> isDotAll = true;<a name="line.63"></a> -<span class="sourceLineNo">064</span><a name="line.64"></a> -<span class="sourceLineNo">065</span> // Find all {xxx} variables.<a name="line.65"></a> -<span class="sourceLineNo">066</span> Pattern p = Pattern.compile("\\{([^\\}]+)\\}");<a name="line.66"></a> -<span class="sourceLineNo">067</span> Matcher m = p.matcher(patternString);<a name="line.67"></a> -<span class="sourceLineNo">068</span> while (m.find())<a name="line.68"></a> -<span class="sourceLineNo">069</span> vars.add(m.group(1));<a name="line.69"></a> -<span class="sourceLineNo">070</span><a name="line.70"></a> -<span class="sourceLineNo">071</span> patternString = patternString.replaceAll("\\{[^\\}]+\\}", "([^\\/]+)");<a name="line.71"></a> -<span class="sourceLineNo">072</span> patternString = patternString.replaceAll("\\/\\*$", "((?:)|(?:\\/.*))");<a name="line.72"></a> -<span class="sourceLineNo">073</span> pattern = Pattern.compile(patternString);<a name="line.73"></a> -<span class="sourceLineNo">074</span> }<a name="line.74"></a> -<span class="sourceLineNo">075</span> }<a name="line.75"></a> -<span class="sourceLineNo">076</span><a name="line.76"></a> -<span class="sourceLineNo">077</span> /**<a name="line.77"></a> -<span class="sourceLineNo">078</span> * Returns a non-<jk>null</jk> value if the specified path matches this pattern.<a name="line.78"></a> -<span class="sourceLineNo">079</span> *<a name="line.79"></a> -<span class="sourceLineNo">080</span> * @param path The path to match against.<a name="line.80"></a> -<span class="sourceLineNo">081</span> * @return An array of values matched against <js>"{var}"</js> variable in the pattern,<a name="line.81"></a> -<span class="sourceLineNo">082</span> * or an empty array if the pattern matched but no vars were present, or <jk>null</jk><a name="line.82"></a> -<span class="sourceLineNo">083</span> * if the specified path didn't match the pattern.<a name="line.83"></a> -<span class="sourceLineNo">084</span> */<a name="line.84"></a> -<span class="sourceLineNo">085</span> protected String[] match(String path) {<a name="line.85"></a> -<span class="sourceLineNo">086</span><a name="line.86"></a> -<span class="sourceLineNo">087</span> if (isOnlyDotAll) {<a name="line.87"></a> -<span class="sourceLineNo">088</span> // Remainder always gets leading slash trimmed.<a name="line.88"></a> -<span class="sourceLineNo">089</span> if (path != null)<a name="line.89"></a> -<span class="sourceLineNo">090</span> path = path.substring(1);<a name="line.90"></a> -<span class="sourceLineNo">091</span> return new String[]{path};<a name="line.91"></a> -<span class="sourceLineNo">092</span> }<a name="line.92"></a> -<span class="sourceLineNo">093</span><a name="line.93"></a> -<span class="sourceLineNo">094</span> if (path == null)<a name="line.94"></a> -<span class="sourceLineNo">095</span> return (patternString.equals("/") ? new String[]{} : null);<a name="line.95"></a> -<span class="sourceLineNo">096</span><a name="line.96"></a> -<span class="sourceLineNo">097</span> Matcher m = pattern.matcher(path);<a name="line.97"></a> -<span class="sourceLineNo">098</span> if (! m.matches())<a name="line.98"></a> -<span class="sourceLineNo">099</span> return null;<a name="line.99"></a> -<span class="sourceLineNo">100</span><a name="line.100"></a> -<span class="sourceLineNo">101</span> int len = m.groupCount();<a name="line.101"></a> -<span class="sourceLineNo">102</span> String[] v = new String[len];<a name="line.102"></a> -<span class="sourceLineNo">103</span><a name="line.103"></a> -<span class="sourceLineNo">104</span> for (int i = 0; i < len; i++) {<a name="line.104"></a> -<span class="sourceLineNo">105</span> if (isDotAll && i == len-1)<a name="line.105"></a> -<span class="sourceLineNo">106</span> v[i] = m.group(i+1).isEmpty() ? null : m.group(i+1).substring(1);<a name="line.106"></a> -<span class="sourceLineNo">107</span> else<a name="line.107"></a> -<span class="sourceLineNo">108</span> v[i] = decode(m.group(i+1));<a name="line.108"></a> -<span class="sourceLineNo">109</span> }<a name="line.109"></a> -<span class="sourceLineNo">110</span><a name="line.110"></a> -<span class="sourceLineNo">111</span> return v;<a name="line.111"></a> -<span class="sourceLineNo">112</span> }<a name="line.112"></a> -<span class="sourceLineNo">113</span><a name="line.113"></a> -<span class="sourceLineNo">114</span> /**<a name="line.114"></a> -<span class="sourceLineNo">115</span> * Comparator for this object.<a name="line.115"></a> -<span class="sourceLineNo">116</span> * The comparator is designed to order URL pattern from most-specific to least-specific.<a name="line.116"></a> -<span class="sourceLineNo">117</span> * For example, the following patterns would be ordered as follows:<a name="line.117"></a> -<span class="sourceLineNo">118</span> * <ol><a name="line.118"></a> -<span class="sourceLineNo">119</span> * <li><code>/foo/bar</code><a name="line.119"></a> -<span class="sourceLineNo">120</span> * <li><code>/foo/bar/*</code><a name="line.120"></a> -<span class="sourceLineNo">121</span> * <li><code>/foo/{id}/bar</code><a name="line.121"></a> -<span class="sourceLineNo">122</span> * <li><code>/foo/{id}/bar/*</code><a name="line.122"></a> -<span class="sourceLineNo">123</span> * <li><code>/foo/{id}</code><a name="line.123"></a> -<span class="sourceLineNo">124</span> * <li><code>/foo/{id}/*</code><a name="line.124"></a> -<span class="sourceLineNo">125</span> * <li><code>/foo</code><a name="line.125"></a> -<span class="sourceLineNo">126</span> * <li><code>/foo/*</code><a name="line.126"></a> -<span class="sourceLineNo">127</span> * </ol><a name="line.127"></a> -<span class="sourceLineNo">128</span> */<a name="line.128"></a> -<span class="sourceLineNo">129</span> @Override /* Comparable */<a name="line.129"></a> -<span class="sourceLineNo">130</span> public int compareTo(UrlPathPattern o) {<a name="line.130"></a> -<span class="sourceLineNo">131</span> String s1 = patternString.replaceAll("\\{[^\\}]+\\}", ".").replaceAll("\\w+", "X").replaceAll("\\.", "W");<a name="line.131"></a> -<span class="sourceLineNo">132</span> String s2 = o.patternString.replaceAll("\\{[^\\}]+\\}", ".").replaceAll("\\w+", "X").replaceAll("\\.", "W");<a name="line.132"></a> -<span class="sourceLineNo">133</span> if (s1.isEmpty())<a name="line.133"></a> -<span class="sourceLineNo">134</span> s1 = "+";<a name="line.134"></a> -<span class="sourceLineNo">135</span> if (s2.isEmpty())<a name="line.135"></a> -<span class="sourceLineNo">136</span> s2 = "+";<a name="line.136"></a> -<span class="sourceLineNo">137</span> if (! s1.endsWith("/*"))<a name="line.137"></a> -<span class="sourceLineNo">138</span> s1 = s1 + "/W";<a name="line.138"></a> -<span class="sourceLineNo">139</span> if (! s2.endsWith("/*"))<a name="line.139"></a> -<span class="sourceLineNo">140</span> s2 = s2 + "/W";<a name="line.140"></a> -<span class="sourceLineNo">141</span> int c = s2.compareTo(s1);<a name="line.141"></a> -<span class="sourceLineNo">142</span> if (c == 0)<a name="line.142"></a> -<span class="sourceLineNo">143</span> return o.toRegEx().compareTo(toRegEx());<a name="line.143"></a> -<span class="sourceLineNo">144</span> return c;<a name="line.144"></a> -<span class="sourceLineNo">145</span> }<a name="line.145"></a> -<span class="sourceLineNo">146</span><a name="line.146"></a> -<span class="sourceLineNo">147</span> @Override /* Object */<a name="line.147"></a> -<span class="sourceLineNo">148</span> public boolean equals(Object o) {<a name="line.148"></a> -<span class="sourceLineNo">149</span> if (! (o instanceof UrlPathPattern))<a name="line.149"></a> -<span class="sourceLineNo">150</span> return false;<a name="line.150"></a> -<span class="sourceLineNo">151</span> return (compareTo((UrlPathPattern)o) == 0);<a name="line.151"></a> -<span class="sourceLineNo">152</span> }<a name="line.152"></a> -<span class="sourceLineNo">153</span><a name="line.153"></a> -<span class="sourceLineNo">154</span> @Override /* Object */<a name="line.154"></a> -<span class="sourceLineNo">155</span> public int hashCode() {<a name="line.155"></a> -<span class="sourceLineNo">156</span> return super.hashCode();<a name="line.156"></a> -<span class="sourceLineNo">157</span> }<a name="line.157"></a> -<span class="sourceLineNo">158</span><a name="line.158"></a> -<span class="sourceLineNo">159</span> @Override /* Object */<a name="line.159"></a> -<span class="sourceLineNo">160</span> public String toString() {<a name="line.160"></a> -<span class="sourceLineNo">161</span> return patternString;<a name="line.161"></a> -<span class="sourceLineNo">162</span> }<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> * Returns this path pattern as the compiled regular expression.<a name="line.165"></a> -<span class="sourceLineNo">166</span> * Useful for debugging.<a name="line.166"></a> -<span class="sourceLineNo">167</span> *<a name="line.167"></a> -<span class="sourceLineNo">168</span> * @return The path pattern.<a name="line.168"></a> -<span class="sourceLineNo">169</span> */<a name="line.169"></a> -<span class="sourceLineNo">170</span> public String toRegEx() {<a name="line.170"></a> -<span class="sourceLineNo">171</span> return isOnlyDotAll ? "*" : pattern.pattern();<a name="line.171"></a> -<span class="sourceLineNo">172</span> }<a name="line.172"></a> -<span class="sourceLineNo">173</span><a name="line.173"></a> -<span class="sourceLineNo">174</span> /**<a name="line.174"></a> -<span class="sourceLineNo">175</span> * Bean property getter: <property>vars</property>.<a name="line.175"></a> -<span class="sourceLineNo">176</span> * @return The value of the <property>vars</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.176"></a> -<span class="sourceLineNo">177</span> */<a name="line.177"></a> -<span class="sourceLineNo">178</span> public String[] getVars() {<a name="line.178"></a> -<span class="sourceLineNo">179</span> return vars;<a name="line.179"></a> -<span class="sourceLineNo">180</span> }<a name="line.180"></a> -<span class="sourceLineNo">181</span><a name="line.181"></a> -<span class="sourceLineNo">182</span> /**<a name="line.182"></a> -<span class="sourceLineNo">183</span> * Bean property getter: <property>patternString</property>.<a name="line.183"></a> -<span class="sourceLineNo">184</span> * @return The value of the <property>patternString</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.184"></a> -<span class="sourceLineNo">185</span> */<a name="line.185"></a> -<span class="sourceLineNo">186</span> public String getPatternString() {<a name="line.186"></a> -<span class="sourceLineNo">187</span> return patternString;<a name="line.187"></a> -<span class="sourceLineNo">188</span> }<a name="line.188"></a> -<span class="sourceLineNo">189</span>}<a name="line.189"></a> +<span class="sourceLineNo">020</span>import org.apache.juneau.rest.annotation.*;<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> * A parsed path pattern constructed from a {@link RestMethod#path()} value.<a name="line.23"></a> +<span class="sourceLineNo">024</span> * <p><a name="line.24"></a> +<span class="sourceLineNo">025</span> * Handles aspects of matching and precedence ordering.<a name="line.25"></a> +<span class="sourceLineNo">026</span> */<a name="line.26"></a> +<span class="sourceLineNo">027</span>public final class UrlPathPattern implements Comparable<UrlPathPattern> {<a name="line.27"></a> +<span class="sourceLineNo">028</span><a name="line.28"></a> +<span class="sourceLineNo">029</span> private final Pattern pattern;<a name="line.29"></a> +<span class="sourceLineNo">030</span> private final String patternString;<a name="line.30"></a> +<span class="sourceLineNo">031</span> private final boolean isOnlyDotAll, isDotAll;<a name="line.31"></a> +<span class="sourceLineNo">032</span> private final String[] vars;<a name="line.32"></a> +<span class="sourceLineNo">033</span><a name="line.33"></a> +<span class="sourceLineNo">034</span> /**<a name="line.34"></a> +<span class="sourceLineNo">035</span> * Constructor.<a name="line.35"></a> +<span class="sourceLineNo">036</span> *<a name="line.36"></a> +<span class="sourceLineNo">037</span> * @param patternString The raw pattern string from the {@link RestMethod#path()} annotation.<a name="line.37"></a> +<span class="sourceLineNo">038</span> */<a name="line.38"></a> +<span class="sourceLineNo">039</span> public UrlPathPattern(String patternString) {<a name="line.39"></a> +<span class="sourceLineNo">040</span> this.patternString = patternString;<a name="line.40"></a> +<span class="sourceLineNo">041</span> Builder b = new Builder(patternString);<a name="line.41"></a> +<span class="sourceLineNo">042</span> pattern = b.pattern;<a name="line.42"></a> +<span class="sourceLineNo">043</span> isDotAll = b.isDotAll;<a name="line.43"></a> +<span class="sourceLineNo">044</span> isOnlyDotAll = b.isOnlyDotAll;<a name="line.44"></a> +<span class="sourceLineNo">045</span> vars = b.vars.toArray(new String[b.vars.size()]);<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> @SuppressWarnings("hiding")<a name="line.48"></a> +<span class="sourceLineNo">049</span> class Builder {<a name="line.49"></a> +<span class="sourceLineNo">050</span> boolean isDotAll, isOnlyDotAll;<a name="line.50"></a> +<span class="sourceLineNo">051</span> Pattern pattern;<a name="line.51"></a> +<span class="sourceLineNo">052</span> List<String> vars = new LinkedList<String>();<a name="line.52"></a> +<span class="sourceLineNo">053</span><a name="line.53"></a> +<span class="sourceLineNo">054</span> private Builder(String patternString) {<a name="line.54"></a> +<span class="sourceLineNo">055</span> if (! startsWith(patternString, '/'))<a name="line.55"></a> +<span class="sourceLineNo">056</span> patternString = '/' + patternString;<a name="line.56"></a> +<span class="sourceLineNo">057</span> if (patternString.equals("/*")) {<a name="line.57"></a> +<span class="sourceLineNo">058</span> isOnlyDotAll = true;<a name="line.58"></a> +<span class="sourceLineNo">059</span> return;<a name="line.59"></a> +<span class="sourceLineNo">060</span> }<a name="line.60"></a> +<span class="sourceLineNo">061</span> if (patternString.endsWith("/*"))<a name="line.61"></a> +<span class="sourceLineNo">062</span> isDotAll = true;<a name="line.62"></a> +<span class="sourceLineNo">063</span><a name="line.63"></a> +<span class="sourceLineNo">064</span> // Find all {xxx} variables.<a name="line.64"></a> +<span class="sourceLineNo">065</span> Pattern p = Pattern.compile("\\{([^\\}]+)\\}");<a name="line.65"></a> +<span class="sourceLineNo">066</span> Matcher m = p.matcher(patternString);<a name="line.66"></a> +<span class="sourceLineNo">067</span> while (m.find())<a name="line.67"></a> +<span class="sourceLineNo">068</span> vars.add(m.group(1));<a name="line.68"></a> +<span class="sourceLineNo">069</span><a name="line.69"></a> +<span class="sourceLineNo">070</span> patternString = patternString.replaceAll("\\{[^\\}]+\\}", "([^\\/]+)");<a name="line.70"></a> +<span class="sourceLineNo">071</span> patternString = patternString.replaceAll("\\/\\*$", "((?:)|(?:\\/.*))");<a name="line.71"></a> +<span class="sourceLineNo">072</span> pattern = Pattern.compile(patternString);<a name="line.72"></a> +<span class="sourceLineNo">073</span> }<a name="line.73"></a> +<span class="sourceLineNo">074</span> }<a name="line.74"></a> +<span class="sourceLineNo">075</span><a name="line.75"></a> +<span class="sourceLineNo">076</span> /**<a name="line.76"></a> +<span class="sourceLineNo">077</span> * Returns a non-<jk>null</jk> value if the specified path matches this pattern.<a name="line.77"></a> +<span class="sourceLineNo">078</span> *<a name="line.78"></a> +<span class="sourceLineNo">079</span> * @param path The path to match against.<a name="line.79"></a> +<span class="sourceLineNo">080</span> * @return An array of values matched against <js>"{var}"</js> variable in the pattern,<a name="line.80"></a> +<span class="sourceLineNo">081</span> * or an empty array if the pattern matched but no vars were present, or <jk>null</jk><a name="line.81"></a> +<span class="sourceLineNo">082</span> * if the specified path didn't match the pattern.<a name="line.82"></a> +<span class="sourceLineNo">083</span> */<a name="line.83"></a> +<span class="sourceLineNo">084</span> protected String[] match(String path) {<a name="line.84"></a> +<span class="sourceLineNo">085</span><a name="line.85"></a> +<span class="sourceLineNo">086</span> if (isOnlyDotAll) {<a name="line.86"></a> +<span class="sourceLineNo">087</span> // Remainder always gets leading slash trimmed.<a name="line.87"></a> +<span class="sourceLineNo">088</span> if (path != null)<a name="line.88"></a> +<span class="sourceLineNo">089</span> path = path.substring(1);<a name="line.89"></a> +<span class="sourceLineNo">090</span> return new String[]{path};<a name="line.90"></a> +<span class="sourceLineNo">091</span> }<a name="line.91"></a> +<span class="sourceLineNo">092</span><a name="line.92"></a> +<span class="sourceLineNo">093</span> if (path == null)<a name="line.93"></a> +<span class="sourceLineNo">094</span> return (patternString.equals("/") ? new String[]{} : null);<a name="line.94"></a> +<span class="sourceLineNo">095</span><a name="line.95"></a> +<span class="sourceLineNo">096</span> Matcher m = pattern.matcher(path);<a name="line.96"></a> +<span class="sourceLineNo">097</span> if (! m.matches())<a name="line.97"></a> +<span class="sourceLineNo">098</span> return null;<a name="line.98"></a> +<span class="sourceLineNo">099</span><a name="line.99"></a> +<span class="sourceLineNo">100</span> int len = m.groupCount();<a name="line.100"></a> +<span class="sourceLineNo">101</span> String[] v = new String[len];<a name="line.101"></a> +<span class="sourceLineNo">102</span><a name="line.102"></a> +<span class="sourceLineNo">103</span> for (int i = 0; i < len; i++) {<a name="line.103"></a> +<span class="sourceLineNo">104</span> if (isDotAll && i == len-1)<a name="line.104"></a> +<span class="sourceLineNo">105</span> v[i] = m.group(i+1).isEmpty() ? null : m.group(i+1).substring(1);<a name="line.105"></a> +<span class="sourceLineNo">106</span> else<a name="line.106"></a> +<span class="sourceLineNo">107</span> v[i] = urlDecode(m.group(i+1));<a name="line.107"></a> +<span class="sourceLineNo">108</span> }<a name="line.108"></a> +<span class="sourceLineNo">109</span><a name="line.109"></a> +<span class="sourceLineNo">110</span> return v;<a name="line.110"></a> +<span class="sourceLineNo">111</span> }<a name="line.111"></a> +<span class="sourceLineNo">112</span><a name="line.112"></a> +<span class="sourceLineNo">113</span> /**<a name="line.113"></a> +<span class="sourceLineNo">114</span> * Comparator for this object.<a name="line.114"></a> +<span class="sourceLineNo">115</span> * The comparator is designed to order URL pattern from most-specific to least-specific.<a name="line.115"></a> +<span class="sourceLineNo">116</span> * For example, the following patterns would be ordered as follows:<a name="line.116"></a> +<span class="sourceLineNo">117</span> * <ol><a name="line.117"></a> +<span class="sourceLineNo">118</span> * <li><code>/foo/bar</code><a name="line.118"></a> +<span class="sourceLineNo">119</span> * <li><code>/foo/bar/*</code><a name="line.119"></a> +<span class="sourceLineNo">120</span> * <li><code>/foo/{id}/bar</code><a name="line.120"></a> +<span class="sourceLineNo">121</span> * <li><code>/foo/{id}/bar/*</code><a name="line.121"></a> +<span class="sourceLineNo">122</span> * <li><code>/foo/{id}</code><a name="line.122"></a> +<span class="sourceLineNo">123</span> * <li><code>/foo/{id}/*</code><a name="line.123"></a> +<span class="sourceLineNo">124</span> * <li><code>/foo</code><a name="line.124"></a> +<span class="sourceLineNo">125</span> * <li><code>/foo/*</code><a name="line.125"></a> +<span class="sourceLineNo">126</span> * </ol><a name="line.126"></a> +<span class="sourceLineNo">127</span> */<a name="line.127"></a> +<span class="sourceLineNo">128</span> @Override /* Comparable */<a name="line.128"></a> +<span class="sourceLineNo">129</span> public int compareTo(UrlPathPattern o) {<a name="line.129"></a> +<span class="sourceLineNo">130</span> String s1 = patternString.replaceAll("\\{[^\\}]+\\}", ".").replaceAll("\\w+", "X").replaceAll("\\.", "W");<a name="line.130"></a> +<span class="sourceLineNo">131</span> String s2 = o.patternString.replaceAll("\\{[^\\}]+\\}", ".").replaceAll("\\w+", "X").replaceAll("\\.", "W");<a name="line.131"></a> +<span class="sourceLineNo">132</span> if (s1.isEmpty())<a name="line.132"></a> +<span class="sourceLineNo">133</span> s1 = "+";<a name="line.133"></a> +<span class="sourceLineNo">134</span> if (s2.isEmpty())<a name="line.134"></a> +<span class="sourceLineNo">135</span> s2 = "+";<a name="line.135"></a> +<span class="sourceLineNo">136</span> if (! s1.endsWith("/*"))<a name="line.136"></a> +<span class="sourceLineNo">137</span> s1 = s1 + "/W";<a name="line.137"></a> +<span class="sourceLineNo">138</span> if (! s2.endsWith("/*"))<a name="line.138"></a> +<span class="sourceLineNo">139</span> s2 = s2 + "/W";<a name="line.139"></a> +<span class="sourceLineNo">140</span> int c = s2.compareTo(s1);<a name="line.140"></a> +<span class="sourceLineNo">141</span> if (c == 0)<a name="line.141"></a> +<span class="sourceLineNo">142</span> return o.toRegEx().compareTo(toRegEx());<a name="line.142"></a> +<span class="sourceLineNo">143</span> return c;<a name="line.143"></a> +<span class="sourceLineNo">144</span> }<a name="line.144"></a> +<span class="sourceLineNo">145</span><a name="line.145"></a> +<span class="sourceLineNo">146</span> @Override /* Object */<a name="line.146"></a> +<span class="sourceLineNo">147</span> public boolean equals(Object o) {<a name="line.147"></a> +<span class="sourceLineNo">148</span> if (! (o instanceof UrlPathPattern))<a name="line.148"></a> +<span class="sourceLineNo">149</span> return false;<a name="line.149"></a> +<span class="sourceLineNo">150</span> return (compareTo((UrlPathPattern)o) == 0);<a name="line.150"></a> +<span class="sourceLineNo">151</span> }<a name="line.151"></a> +<span class="sourceLineNo">152</span><a name="line.152"></a> +<span class="sourceLineNo">153</span> @Override /* Object */<a name="line.153"></a> +<span class="sourceLineNo">154</span> public int hashCode() {<a name="line.154"></a> +<span class="sourceLineNo">155</span> return super.hashCode();<a name="line.155"></a> +<span class="sourceLineNo">156</span> }<a name="line.156"></a> +<span class="sourceLineNo">157</span><a name="line.157"></a> +<span class="sourceLineNo">158</span> @Override /* Object */<a name="line.158"></a> +<span class="sourceLineNo">159</span> public String toString() {<a name="line.159"></a> +<span class="sourceLineNo">160</span> return patternString;<a name="line.160"></a> +<span class="sourceLineNo">161</span> }<a name="line.161"></a> +<span class="sourceLineNo">162</span><a name="line.162"></a> +<span class="sourceLineNo">163</span> /**<a name="line.163"></a> +<span class="sourceLineNo">164</span> * Returns this path pattern as the compiled regular expression.<a name="line.164"></a> +<span class="sourceLineNo">165</span> * Useful for debugging.<a name="line.165"></a> +<span class="sourceLineNo">166</span> *<a name="line.166"></a> +<span class="sourceLineNo">167</span> * @return The path pattern.<a name="line.167"></a> +<span class="sourceLineNo">168</span> */<a name="line.168"></a> +<span class="sourceLineNo">169</span> public String toRegEx() {<a name="line.169"></a> +<span class="sourceLineNo">170</span> return isOnlyDotAll ? "*" : pattern.pattern();<a name="line.170"></a> +<span class="sourceLineNo">171</span> }<a name="line.171"></a> +<span class="sourceLineNo">172</span><a name="line.172"></a> +<span class="sourceLineNo">173</span> /**<a name="line.173"></a> +<span class="sourceLineNo">174</span> * Bean property getter: <property>vars</property>.<a name="line.174"></a> +<span class="sourceLineNo">175</span> * @return The value of the <property>vars</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.175"></a> +<span class="sourceLineNo">176</span> */<a name="line.176"></a> +<span class="sourceLineNo">177</span> public String[] getVars() {<a name="line.177"></a> +<span class="sourceLineNo">178</span> return vars;<a name="line.178"></a> +<span class="sourceLineNo">179</span> }<a name="line.179"></a> +<span class="sourceLineNo">180</span><a name="line.180"></a> +<span class="sourceLineNo">181</span> /**<a name="line.181"></a> +<span class="sourceLineNo">182</span> * Bean property getter: <property>patternString</property>.<a name="line.182"></a> +<span class="sourceLineNo">183</span> * @return The value of the <property>patternString</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.183"></a> +<span class="sourceLineNo">184</span> */<a name="line.184"></a> +<span class="sourceLineNo">185</span> public String getPatternString() {<a name="line.185"></a> +<span class="sourceLineNo">186</span> return patternString;<a name="line.186"></a> +<span class="sourceLineNo">187</span> }<a name="line.187"></a> +<span class="sourceLineNo">188</span>}<a name="line.188"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/80ff9b74/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestMethod.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestMethod.html b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestMethod.html index f3b0a35..843ff09 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestMethod.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestMethod.html @@ -25,9 +25,9 @@ <span class="sourceLineNo">017</span><a name="line.17"></a> <span class="sourceLineNo">018</span>import java.lang.annotation.*;<a name="line.18"></a> <span class="sourceLineNo">019</span><a name="line.19"></a> -<span class="sourceLineNo">020</span>import org.apache.juneau.annotation.*;<a name="line.20"></a> -<span class="sourceLineNo">021</span>import org.apache.juneau.encoders.*;<a name="line.21"></a> -<span class="sourceLineNo">022</span>import org.apache.juneau.parser.*;<a name="line.22"></a> +<span class="sourceLineNo">020</span>import org.apache.juneau.encoders.*;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import org.apache.juneau.parser.*;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import org.apache.juneau.remoteable.*;<a name="line.22"></a> <span class="sourceLineNo">023</span>import org.apache.juneau.rest.*;<a name="line.23"></a> <span class="sourceLineNo">024</span>import org.apache.juneau.serializer.*;<a name="line.24"></a> <span class="sourceLineNo">025</span><a name="line.25"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/80ff9b74/content/site/apidocs/src-html/org/apache/juneau/rest/client/NameValuePairs.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/client/NameValuePairs.html b/content/site/apidocs/src-html/org/apache/juneau/rest/client/NameValuePairs.html index 586f184..a5db356 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/client/NameValuePairs.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/client/NameValuePairs.html @@ -24,34 +24,70 @@ <span class="sourceLineNo">016</span><a name="line.16"></a> <span class="sourceLineNo">017</span>import org.apache.http.*;<a name="line.17"></a> <span class="sourceLineNo">018</span>import org.apache.http.client.entity.*;<a name="line.18"></a> -<span class="sourceLineNo">019</span><a name="line.19"></a> -<span class="sourceLineNo">020</span>/**<a name="line.20"></a> -<span class="sourceLineNo">021</span> * Convenience class for constructing instances of <code>List&lt;NameValuePair&gt;</code><a name="line.21"></a> -<span class="sourceLineNo">022</span> * for the {@link UrlEncodedFormEntity} class.<a name="line.22"></a> -<span class="sourceLineNo">023</span> *<a name="line.23"></a> -<span class="sourceLineNo">024</span> * <h5 class='section'>Example:</h5><a name="line.24"></a> -<span class="sourceLineNo">025</span> * <p class='bcode'><a name="line.25"></a> -<span class="sourceLineNo">026</span> * NameValuePairs params = <jk>new</jk> NameValuePairs()<a name="line.26"></a> -<span class="sourceLineNo">027</span> * .append(<jk>new</jk> BasicNameValuePair(<js>"j_username"</js>, user))<a name="line.27"></a> -<span class="sourceLineNo">028</span> * .append(<jk>new</jk> BasicNameValuePair(<js>"j_password"</js>, pw));<a name="line.28"></a> -<span class="sourceLineNo">029</span> * request.setEntity(<jk>new</jk> UrlEncodedFormEntity(params));<a name="line.29"></a> -<span class="sourceLineNo">030</span> * </p><a name="line.30"></a> -<span class="sourceLineNo">031</span> */<a name="line.31"></a> -<span class="sourceLineNo">032</span>public final class NameValuePairs extends LinkedList<NameValuePair> {<a name="line.32"></a> -<span class="sourceLineNo">033</span><a name="line.33"></a> -<span class="sourceLineNo">034</span> private static final long serialVersionUID = 1L;<a name="line.34"></a> -<span class="sourceLineNo">035</span><a name="line.35"></a> -<span class="sourceLineNo">036</span> /**<a name="line.36"></a> -<span class="sourceLineNo">037</span> * Appends the specified pair to the end of this list.<a name="line.37"></a> -<span class="sourceLineNo">038</span> *<a name="line.38"></a> -<span class="sourceLineNo">039</span> * @param pair The pair to append to this list.<a name="line.39"></a> -<span class="sourceLineNo">040</span> * @return This object (for method chaining).<a name="line.40"></a> -<span class="sourceLineNo">041</span> */<a name="line.41"></a> -<span class="sourceLineNo">042</span> public NameValuePairs append(NameValuePair pair) {<a name="line.42"></a> -<span class="sourceLineNo">043</span> super.add(pair);<a name="line.43"></a> -<span class="sourceLineNo">044</span> return this;<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">019</span>import org.apache.http.message.*;<a name="line.19"></a> +<span class="sourceLineNo">020</span>import org.apache.juneau.internal.*;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import org.apache.juneau.urlencoding.*;<a name="line.21"></a> +<span class="sourceLineNo">022</span><a name="line.22"></a> +<span class="sourceLineNo">023</span>/**<a name="line.23"></a> +<span class="sourceLineNo">024</span> * Convenience class for constructing instances of <code>List&lt;NameValuePair&gt;</code><a name="line.24"></a> +<span class="sourceLineNo">025</span> * for the {@link UrlEncodedFormEntity} class.<a name="line.25"></a> +<span class="sourceLineNo">026</span> * <p><a name="line.26"></a> +<span class="sourceLineNo">027</span> * Instances of this method can be passed directly to the {@link RestClient#doPost(Object, Object)} method or<a name="line.27"></a> +<span class="sourceLineNo">028</span> * {@link RestCall#input(Object)} methods to perform URL-encoded form posts.<a name="line.28"></a> +<span class="sourceLineNo">029</span> *<a name="line.29"></a> +<span class="sourceLineNo">030</span> * <h5 class='section'>Example:</h5><a name="line.30"></a> +<span class="sourceLineNo">031</span> * <p class='bcode'><a name="line.31"></a> +<span class="sourceLineNo">032</span> * NameValuePairs params = <jk>new</jk> NameValuePairs()<a name="line.32"></a> +<span class="sourceLineNo">033</span> * .append(<js>"j_username"</js>, user)<a name="line.33"></a> +<span class="sourceLineNo">034</span> * .append(<js>"j_password"</js>, pw);<a name="line.34"></a> +<span class="sourceLineNo">035</span> * restClient.doPost(url, params).run();<a name="line.35"></a> +<span class="sourceLineNo">036</span> * </p><a name="line.36"></a> +<span class="sourceLineNo">037</span> */<a name="line.37"></a> +<span class="sourceLineNo">038</span>public final class NameValuePairs extends LinkedList<NameValuePair> {<a name="line.38"></a> +<span class="sourceLineNo">039</span><a name="line.39"></a> +<span class="sourceLineNo">040</span> private static final long serialVersionUID = 1L;<a name="line.40"></a> +<span class="sourceLineNo">041</span><a name="line.41"></a> +<span class="sourceLineNo">042</span> /**<a name="line.42"></a> +<span class="sourceLineNo">043</span> * Appends the specified pair to the end of this list.<a name="line.43"></a> +<span class="sourceLineNo">044</span> *<a name="line.44"></a> +<span class="sourceLineNo">045</span> * @param pair The pair to append to this list.<a name="line.45"></a> +<span class="sourceLineNo">046</span> * @return This object (for method chaining).<a name="line.46"></a> +<span class="sourceLineNo">047</span> */<a name="line.47"></a> +<span class="sourceLineNo">048</span> public NameValuePairs append(NameValuePair pair) {<a name="line.48"></a> +<span class="sourceLineNo">049</span> super.add(pair);<a name="line.49"></a> +<span class="sourceLineNo">050</span> return this;<a name="line.50"></a> +<span class="sourceLineNo">051</span> }<a name="line.51"></a> +<span class="sourceLineNo">052</span><a name="line.52"></a> +<span class="sourceLineNo">053</span> /**<a name="line.53"></a> +<span class="sourceLineNo">054</span> * Appends the specified name/value pair to the end of this list.<a name="line.54"></a> +<span class="sourceLineNo">055</span> * <p><a name="line.55"></a> +<span class="sourceLineNo">056</span> * The value is simply converted to a string using <code>toString()</code>, or <js>"null"</js> if <jk>null</jk>.<a name="line.56"></a> +<span class="sourceLineNo">057</span> *<a name="line.57"></a> +<span class="sourceLineNo">058</span> * @param name The pair name.<a name="line.58"></a> +<span class="sourceLineNo">059</span> * @param value The pair value.<a name="line.59"></a> +<span class="sourceLineNo">060</span> * @return This object (for method chaining).<a name="line.60"></a> +<span class="sourceLineNo">061</span> */<a name="line.61"></a> +<span class="sourceLineNo">062</span> public NameValuePairs append(String name, Object value) {<a name="line.62"></a> +<span class="sourceLineNo">063</span> super.add(new BasicNameValuePair(name, StringUtils.toString(value)));<a name="line.63"></a> +<span class="sourceLineNo">064</span> return this;<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> /**<a name="line.67"></a> +<span class="sourceLineNo">068</span> * Appends the specified name/value pair to the end of this list.<a name="line.68"></a> +<span class="sourceLineNo">069</span> * <p><a name="line.69"></a> +<span class="sourceLineNo">070</span> * The value is converted to UON notation using the {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)} method<a name="line.70"></a> +<span class="sourceLineNo">071</span> * of the specified serializer.<a name="line.71"></a> +<span class="sourceLineNo">072</span> *<a name="line.72"></a> +<span class="sourceLineNo">073</span> * @param name The pair name.<a name="line.73"></a> +<span class="sourceLineNo">074</span> * @param value The pair value.<a name="line.74"></a> +<span class="sourceLineNo">075</span> * @param serializer The serializer to use to convert the value to a string.<a name="line.75"></a> +<span class="sourceLineNo">076</span> * @return This object (for method chaining).<a name="line.76"></a> +<span class="sourceLineNo">077</span> */<a name="line.77"></a> +<span class="sourceLineNo">078</span> public NameValuePairs append(String name, Object value, UrlEncodingSerializer serializer) {<a name="line.78"></a> +<span class="sourceLineNo">079</span> super.add(new SerializedNameValuePair(name, value, serializer));<a name="line.79"></a> +<span class="sourceLineNo">080</span> return this;<a name="line.80"></a> +<span class="sourceLineNo">081</span> }<a name="line.81"></a> +<span class="sourceLineNo">082</span>}<a name="line.82"></a>
