blob: 29c11be6da1260507725140db2a4f9b28134b06a [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a>
<FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a>
<FONT color="green">017</FONT> * under the License.<a name="line.17"></a>
<FONT color="green">018</FONT> */<a name="line.18"></a>
<FONT color="green">019</FONT> package org.apache.shiro.web.util;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import javax.servlet.http.HttpServletRequest;<a name="line.21"></a>
<FONT color="green">022</FONT> import javax.servlet.http.HttpServletResponse;<a name="line.22"></a>
<FONT color="green">023</FONT> import java.io.IOException;<a name="line.23"></a>
<FONT color="green">024</FONT> import java.io.UnsupportedEncodingException;<a name="line.24"></a>
<FONT color="green">025</FONT> import java.net.URLEncoder;<a name="line.25"></a>
<FONT color="green">026</FONT> import java.util.Map;<a name="line.26"></a>
<FONT color="green">027</FONT> <a name="line.27"></a>
<FONT color="green">028</FONT> /**<a name="line.28"></a>
<FONT color="green">029</FONT> * View that redirects to an absolute, context relative, or current request<a name="line.29"></a>
<FONT color="green">030</FONT> * relative URL, exposing all model attributes as HTTP query parameters.<a name="line.30"></a>
<FONT color="green">031</FONT> * &lt;p/&gt;<a name="line.31"></a>
<FONT color="green">032</FONT> * A URL for this view is supposed to be a HTTP redirect URL, i.e.<a name="line.32"></a>
<FONT color="green">033</FONT> * suitable for HttpServletResponse's &lt;code&gt;sendRedirect&lt;/code&gt; method, which<a name="line.33"></a>
<FONT color="green">034</FONT> * is what actually does the redirect if the HTTP 1.0 flag is on, or via sending<a name="line.34"></a>
<FONT color="green">035</FONT> * back an HTTP 303 code - if the HTTP 1.0 compatibility flag is off.<a name="line.35"></a>
<FONT color="green">036</FONT> * &lt;p/&gt;<a name="line.36"></a>
<FONT color="green">037</FONT> * Note that while the default value for the "contextRelative" flag is off,<a name="line.37"></a>
<FONT color="green">038</FONT> * you will probably want to almost always set it to true. With the flag off,<a name="line.38"></a>
<FONT color="green">039</FONT> * URLs starting with "/" are considered relative to the web server root, while<a name="line.39"></a>
<FONT color="green">040</FONT> * with the flag on, they are considered relative to the web application root.<a name="line.40"></a>
<FONT color="green">041</FONT> * Since most web apps will never know or care what their context path actually<a name="line.41"></a>
<FONT color="green">042</FONT> * is, they are much better off setting this flag to true, and submitting paths<a name="line.42"></a>
<FONT color="green">043</FONT> * which are to be considered relative to the web application root.<a name="line.43"></a>
<FONT color="green">044</FONT> * &lt;p/&gt;<a name="line.44"></a>
<FONT color="green">045</FONT> * Note that in a Servlet 2.2 environment, i.e. a servlet container which<a name="line.45"></a>
<FONT color="green">046</FONT> * is only compliant to the limits of this spec, this class will probably fail<a name="line.46"></a>
<FONT color="green">047</FONT> * when feeding in URLs which are not fully absolute, or relative to the current<a name="line.47"></a>
<FONT color="green">048</FONT> * request (no leading "/"), as these are the only two types of URL that<a name="line.48"></a>
<FONT color="green">049</FONT> * &lt;code&gt;sendRedirect&lt;/code&gt; supports in a Servlet 2.2 environment.<a name="line.49"></a>
<FONT color="green">050</FONT> * &lt;p/&gt;<a name="line.50"></a>
<FONT color="green">051</FONT> * &lt;em&gt;This class was borrowed from a nearly identical version found in<a name="line.51"></a>
<FONT color="green">052</FONT> * the &lt;a href="http://www.springframework.org/"&gt;Spring Framework&lt;/a&gt;, with minor modifications to<a name="line.52"></a>
<FONT color="green">053</FONT> * avoid a dependency on Spring itself for a very small amount of code - we couldn't have done it better, and<a name="line.53"></a>
<FONT color="green">054</FONT> * don't want to repeat all of their great effort ;).<a name="line.54"></a>
<FONT color="green">055</FONT> * The original author names and copyright (Apache 2.0) has been left in place. A special<a name="line.55"></a>
<FONT color="green">056</FONT> * thanks to Rod Johnson, Juergen Hoeller, and Colin Sampaleanu for making this available.&lt;/em&gt;<a name="line.56"></a>
<FONT color="green">057</FONT> *<a name="line.57"></a>
<FONT color="green">058</FONT> * @see #setContextRelative<a name="line.58"></a>
<FONT color="green">059</FONT> * @see #setHttp10Compatible<a name="line.59"></a>
<FONT color="green">060</FONT> * @see javax.servlet.http.HttpServletResponse#sendRedirect<a name="line.60"></a>
<FONT color="green">061</FONT> * @since 0.2<a name="line.61"></a>
<FONT color="green">062</FONT> */<a name="line.62"></a>
<FONT color="green">063</FONT> public class RedirectView {<a name="line.63"></a>
<FONT color="green">064</FONT> <a name="line.64"></a>
<FONT color="green">065</FONT> //TODO - complete JavaDoc<a name="line.65"></a>
<FONT color="green">066</FONT> <a name="line.66"></a>
<FONT color="green">067</FONT> /**<a name="line.67"></a>
<FONT color="green">068</FONT> * The default encoding scheme: UTF-8<a name="line.68"></a>
<FONT color="green">069</FONT> */<a name="line.69"></a>
<FONT color="green">070</FONT> public static final String DEFAULT_ENCODING_SCHEME = "UTF-8";<a name="line.70"></a>
<FONT color="green">071</FONT> <a name="line.71"></a>
<FONT color="green">072</FONT> private String url;<a name="line.72"></a>
<FONT color="green">073</FONT> <a name="line.73"></a>
<FONT color="green">074</FONT> private boolean contextRelative = false;<a name="line.74"></a>
<FONT color="green">075</FONT> <a name="line.75"></a>
<FONT color="green">076</FONT> private boolean http10Compatible = true;<a name="line.76"></a>
<FONT color="green">077</FONT> <a name="line.77"></a>
<FONT color="green">078</FONT> private String encodingScheme = DEFAULT_ENCODING_SCHEME;<a name="line.78"></a>
<FONT color="green">079</FONT> <a name="line.79"></a>
<FONT color="green">080</FONT> /**<a name="line.80"></a>
<FONT color="green">081</FONT> * Constructor for use as a bean.<a name="line.81"></a>
<FONT color="green">082</FONT> */<a name="line.82"></a>
<FONT color="green">083</FONT> @SuppressWarnings({"UnusedDeclaration"})<a name="line.83"></a>
<FONT color="green">084</FONT> public RedirectView() {<a name="line.84"></a>
<FONT color="green">085</FONT> }<a name="line.85"></a>
<FONT color="green">086</FONT> <a name="line.86"></a>
<FONT color="green">087</FONT> /**<a name="line.87"></a>
<FONT color="green">088</FONT> * Create a new RedirectView with the given URL.<a name="line.88"></a>
<FONT color="green">089</FONT> * &lt;p&gt;The given URL will be considered as relative to the web server,<a name="line.89"></a>
<FONT color="green">090</FONT> * not as relative to the current ServletContext.<a name="line.90"></a>
<FONT color="green">091</FONT> *<a name="line.91"></a>
<FONT color="green">092</FONT> * @param url the URL to redirect to<a name="line.92"></a>
<FONT color="green">093</FONT> * @see #RedirectView(String, boolean)<a name="line.93"></a>
<FONT color="green">094</FONT> */<a name="line.94"></a>
<FONT color="green">095</FONT> public RedirectView(String url) {<a name="line.95"></a>
<FONT color="green">096</FONT> setUrl(url);<a name="line.96"></a>
<FONT color="green">097</FONT> }<a name="line.97"></a>
<FONT color="green">098</FONT> <a name="line.98"></a>
<FONT color="green">099</FONT> /**<a name="line.99"></a>
<FONT color="green">100</FONT> * Create a new RedirectView with the given URL.<a name="line.100"></a>
<FONT color="green">101</FONT> *<a name="line.101"></a>
<FONT color="green">102</FONT> * @param url the URL to redirect to<a name="line.102"></a>
<FONT color="green">103</FONT> * @param contextRelative whether to interpret the given URL as<a name="line.103"></a>
<FONT color="green">104</FONT> * relative to the current ServletContext<a name="line.104"></a>
<FONT color="green">105</FONT> */<a name="line.105"></a>
<FONT color="green">106</FONT> public RedirectView(String url, boolean contextRelative) {<a name="line.106"></a>
<FONT color="green">107</FONT> this(url);<a name="line.107"></a>
<FONT color="green">108</FONT> this.contextRelative = contextRelative;<a name="line.108"></a>
<FONT color="green">109</FONT> }<a name="line.109"></a>
<FONT color="green">110</FONT> <a name="line.110"></a>
<FONT color="green">111</FONT> /**<a name="line.111"></a>
<FONT color="green">112</FONT> * Create a new RedirectView with the given URL.<a name="line.112"></a>
<FONT color="green">113</FONT> *<a name="line.113"></a>
<FONT color="green">114</FONT> * @param url the URL to redirect to<a name="line.114"></a>
<FONT color="green">115</FONT> * @param contextRelative whether to interpret the given URL as<a name="line.115"></a>
<FONT color="green">116</FONT> * relative to the current ServletContext<a name="line.116"></a>
<FONT color="green">117</FONT> * @param http10Compatible whether to stay compatible with HTTP 1.0 clients<a name="line.117"></a>
<FONT color="green">118</FONT> */<a name="line.118"></a>
<FONT color="green">119</FONT> public RedirectView(String url, boolean contextRelative, boolean http10Compatible) {<a name="line.119"></a>
<FONT color="green">120</FONT> this(url);<a name="line.120"></a>
<FONT color="green">121</FONT> this.contextRelative = contextRelative;<a name="line.121"></a>
<FONT color="green">122</FONT> this.http10Compatible = http10Compatible;<a name="line.122"></a>
<FONT color="green">123</FONT> }<a name="line.123"></a>
<FONT color="green">124</FONT> <a name="line.124"></a>
<FONT color="green">125</FONT> <a name="line.125"></a>
<FONT color="green">126</FONT> public String getUrl() {<a name="line.126"></a>
<FONT color="green">127</FONT> return url;<a name="line.127"></a>
<FONT color="green">128</FONT> }<a name="line.128"></a>
<FONT color="green">129</FONT> <a name="line.129"></a>
<FONT color="green">130</FONT> public void setUrl(String url) {<a name="line.130"></a>
<FONT color="green">131</FONT> this.url = url;<a name="line.131"></a>
<FONT color="green">132</FONT> }<a name="line.132"></a>
<FONT color="green">133</FONT> <a name="line.133"></a>
<FONT color="green">134</FONT> /**<a name="line.134"></a>
<FONT color="green">135</FONT> * Set whether to interpret a given URL that starts with a slash ("/")<a name="line.135"></a>
<FONT color="green">136</FONT> * as relative to the current ServletContext, i.e. as relative to the<a name="line.136"></a>
<FONT color="green">137</FONT> * web application root.<a name="line.137"></a>
<FONT color="green">138</FONT> * &lt;p/&gt;<a name="line.138"></a>
<FONT color="green">139</FONT> * Default is "false": A URL that starts with a slash will be interpreted<a name="line.139"></a>
<FONT color="green">140</FONT> * as absolute, i.e. taken as-is. If true, the context path will be<a name="line.140"></a>
<FONT color="green">141</FONT> * prepended to the URL in such a case.<a name="line.141"></a>
<FONT color="green">142</FONT> *<a name="line.142"></a>
<FONT color="green">143</FONT> * @param contextRelative whether to interpret a given URL that starts with a slash ("/")<a name="line.143"></a>
<FONT color="green">144</FONT> * as relative to the current ServletContext, i.e. as relative to the<a name="line.144"></a>
<FONT color="green">145</FONT> * web application root.<a name="line.145"></a>
<FONT color="green">146</FONT> * @see javax.servlet.http.HttpServletRequest#getContextPath<a name="line.146"></a>
<FONT color="green">147</FONT> */<a name="line.147"></a>
<FONT color="green">148</FONT> public void setContextRelative(boolean contextRelative) {<a name="line.148"></a>
<FONT color="green">149</FONT> this.contextRelative = contextRelative;<a name="line.149"></a>
<FONT color="green">150</FONT> }<a name="line.150"></a>
<FONT color="green">151</FONT> <a name="line.151"></a>
<FONT color="green">152</FONT> /**<a name="line.152"></a>
<FONT color="green">153</FONT> * Set whether to stay compatible with HTTP 1.0 clients.<a name="line.153"></a>
<FONT color="green">154</FONT> * &lt;p&gt;In the default implementation, this will enforce HTTP status code 302<a name="line.154"></a>
<FONT color="green">155</FONT> * in any case, i.e. delegate to &lt;code&gt;HttpServletResponse.sendRedirect&lt;/code&gt;.<a name="line.155"></a>
<FONT color="green">156</FONT> * Turning this off will send HTTP status code 303, which is the correct<a name="line.156"></a>
<FONT color="green">157</FONT> * code for HTTP 1.1 clients, but not understood by HTTP 1.0 clients.<a name="line.157"></a>
<FONT color="green">158</FONT> * &lt;p&gt;Many HTTP 1.1 clients treat 302 just like 303, not making any<a name="line.158"></a>
<FONT color="green">159</FONT> * difference. However, some clients depend on 303 when redirecting<a name="line.159"></a>
<FONT color="green">160</FONT> * after a POST request; turn this flag off in such a scenario.<a name="line.160"></a>
<FONT color="green">161</FONT> *<a name="line.161"></a>
<FONT color="green">162</FONT> * @param http10Compatible whether to stay compatible with HTTP 1.0 clients.<a name="line.162"></a>
<FONT color="green">163</FONT> * @see javax.servlet.http.HttpServletResponse#sendRedirect<a name="line.163"></a>
<FONT color="green">164</FONT> */<a name="line.164"></a>
<FONT color="green">165</FONT> public void setHttp10Compatible(boolean http10Compatible) {<a name="line.165"></a>
<FONT color="green">166</FONT> this.http10Compatible = http10Compatible;<a name="line.166"></a>
<FONT color="green">167</FONT> }<a name="line.167"></a>
<FONT color="green">168</FONT> <a name="line.168"></a>
<FONT color="green">169</FONT> /**<a name="line.169"></a>
<FONT color="green">170</FONT> * Set the encoding scheme for this view. Default is UTF-8.<a name="line.170"></a>
<FONT color="green">171</FONT> *<a name="line.171"></a>
<FONT color="green">172</FONT> * @param encodingScheme the encoding scheme for this view. Default is UTF-8.<a name="line.172"></a>
<FONT color="green">173</FONT> */<a name="line.173"></a>
<FONT color="green">174</FONT> @SuppressWarnings({"UnusedDeclaration"})<a name="line.174"></a>
<FONT color="green">175</FONT> public void setEncodingScheme(String encodingScheme) {<a name="line.175"></a>
<FONT color="green">176</FONT> this.encodingScheme = encodingScheme;<a name="line.176"></a>
<FONT color="green">177</FONT> }<a name="line.177"></a>
<FONT color="green">178</FONT> <a name="line.178"></a>
<FONT color="green">179</FONT> <a name="line.179"></a>
<FONT color="green">180</FONT> /**<a name="line.180"></a>
<FONT color="green">181</FONT> * Convert model to request parameters and redirect to the given URL.<a name="line.181"></a>
<FONT color="green">182</FONT> *<a name="line.182"></a>
<FONT color="green">183</FONT> * @param model the model to convert<a name="line.183"></a>
<FONT color="green">184</FONT> * @param request the incoming HttpServletRequest<a name="line.184"></a>
<FONT color="green">185</FONT> * @param response the outgoing HttpServletResponse<a name="line.185"></a>
<FONT color="green">186</FONT> * @throws java.io.IOException if there is a problem issuing the redirect<a name="line.186"></a>
<FONT color="green">187</FONT> * @see #appendQueryProperties<a name="line.187"></a>
<FONT color="green">188</FONT> * @see #sendRedirect<a name="line.188"></a>
<FONT color="green">189</FONT> */<a name="line.189"></a>
<FONT color="green">190</FONT> public final void renderMergedOutputModel(<a name="line.190"></a>
<FONT color="green">191</FONT> Map model, HttpServletRequest request, HttpServletResponse response) throws IOException {<a name="line.191"></a>
<FONT color="green">192</FONT> <a name="line.192"></a>
<FONT color="green">193</FONT> // Prepare name URL.<a name="line.193"></a>
<FONT color="green">194</FONT> StringBuilder targetUrl = new StringBuilder();<a name="line.194"></a>
<FONT color="green">195</FONT> if (this.contextRelative &amp;&amp; getUrl().startsWith("/")) {<a name="line.195"></a>
<FONT color="green">196</FONT> // Do not apply context path to relative URLs.<a name="line.196"></a>
<FONT color="green">197</FONT> targetUrl.append(request.getContextPath());<a name="line.197"></a>
<FONT color="green">198</FONT> }<a name="line.198"></a>
<FONT color="green">199</FONT> targetUrl.append(getUrl());<a name="line.199"></a>
<FONT color="green">200</FONT> //change the following method to accept a StringBuilder instead of a StringBuilder for Shiro 2.x:<a name="line.200"></a>
<FONT color="green">201</FONT> appendQueryProperties(targetUrl, model, this.encodingScheme);<a name="line.201"></a>
<FONT color="green">202</FONT> <a name="line.202"></a>
<FONT color="green">203</FONT> sendRedirect(request, response, targetUrl.toString(), this.http10Compatible);<a name="line.203"></a>
<FONT color="green">204</FONT> }<a name="line.204"></a>
<FONT color="green">205</FONT> <a name="line.205"></a>
<FONT color="green">206</FONT> /**<a name="line.206"></a>
<FONT color="green">207</FONT> * Append query properties to the redirect URL.<a name="line.207"></a>
<FONT color="green">208</FONT> * Stringifies, URL-encodes and formats model attributes as query properties.<a name="line.208"></a>
<FONT color="green">209</FONT> *<a name="line.209"></a>
<FONT color="green">210</FONT> * @param targetUrl the StringBuffer to append the properties to<a name="line.210"></a>
<FONT color="green">211</FONT> * @param model Map that contains model attributes<a name="line.211"></a>
<FONT color="green">212</FONT> * @param encodingScheme the encoding scheme to use<a name="line.212"></a>
<FONT color="green">213</FONT> * @throws java.io.UnsupportedEncodingException if string encoding failed<a name="line.213"></a>
<FONT color="green">214</FONT> * @see #urlEncode<a name="line.214"></a>
<FONT color="green">215</FONT> * @see #queryProperties<a name="line.215"></a>
<FONT color="green">216</FONT> * @see #urlEncode(String, String)<a name="line.216"></a>
<FONT color="green">217</FONT> */<a name="line.217"></a>
<FONT color="green">218</FONT> protected void appendQueryProperties(StringBuilder targetUrl, Map model, String encodingScheme)<a name="line.218"></a>
<FONT color="green">219</FONT> throws UnsupportedEncodingException {<a name="line.219"></a>
<FONT color="green">220</FONT> <a name="line.220"></a>
<FONT color="green">221</FONT> // Extract anchor fragment, if any.<a name="line.221"></a>
<FONT color="green">222</FONT> // The following code does not use JDK 1.4's StringBuffer.indexOf(String)<a name="line.222"></a>
<FONT color="green">223</FONT> // method to retain JDK 1.3 compatibility.<a name="line.223"></a>
<FONT color="green">224</FONT> String fragment = null;<a name="line.224"></a>
<FONT color="green">225</FONT> int anchorIndex = targetUrl.toString().indexOf('#');<a name="line.225"></a>
<FONT color="green">226</FONT> if (anchorIndex &gt; -1) {<a name="line.226"></a>
<FONT color="green">227</FONT> fragment = targetUrl.substring(anchorIndex);<a name="line.227"></a>
<FONT color="green">228</FONT> targetUrl.delete(anchorIndex, targetUrl.length());<a name="line.228"></a>
<FONT color="green">229</FONT> }<a name="line.229"></a>
<FONT color="green">230</FONT> <a name="line.230"></a>
<FONT color="green">231</FONT> // If there aren't already some parameters, we need a "?".<a name="line.231"></a>
<FONT color="green">232</FONT> boolean first = (getUrl().indexOf('?') &lt; 0);<a name="line.232"></a>
<FONT color="green">233</FONT> Map queryProps = queryProperties(model);<a name="line.233"></a>
<FONT color="green">234</FONT> <a name="line.234"></a>
<FONT color="green">235</FONT> if (queryProps != null) {<a name="line.235"></a>
<FONT color="green">236</FONT> for (Object o : queryProps.entrySet()) {<a name="line.236"></a>
<FONT color="green">237</FONT> if (first) {<a name="line.237"></a>
<FONT color="green">238</FONT> targetUrl.append('?');<a name="line.238"></a>
<FONT color="green">239</FONT> first = false;<a name="line.239"></a>
<FONT color="green">240</FONT> } else {<a name="line.240"></a>
<FONT color="green">241</FONT> targetUrl.append('&amp;');<a name="line.241"></a>
<FONT color="green">242</FONT> }<a name="line.242"></a>
<FONT color="green">243</FONT> Map.Entry entry = (Map.Entry) o;<a name="line.243"></a>
<FONT color="green">244</FONT> String encodedKey = urlEncode(entry.getKey().toString(), encodingScheme);<a name="line.244"></a>
<FONT color="green">245</FONT> String encodedValue =<a name="line.245"></a>
<FONT color="green">246</FONT> (entry.getValue() != null ? urlEncode(entry.getValue().toString(), encodingScheme) : "");<a name="line.246"></a>
<FONT color="green">247</FONT> targetUrl.append(encodedKey).append('=').append(encodedValue);<a name="line.247"></a>
<FONT color="green">248</FONT> }<a name="line.248"></a>
<FONT color="green">249</FONT> }<a name="line.249"></a>
<FONT color="green">250</FONT> <a name="line.250"></a>
<FONT color="green">251</FONT> // Append anchor fragment, if any, to end of URL.<a name="line.251"></a>
<FONT color="green">252</FONT> if (fragment != null) {<a name="line.252"></a>
<FONT color="green">253</FONT> targetUrl.append(fragment);<a name="line.253"></a>
<FONT color="green">254</FONT> }<a name="line.254"></a>
<FONT color="green">255</FONT> }<a name="line.255"></a>
<FONT color="green">256</FONT> <a name="line.256"></a>
<FONT color="green">257</FONT> /**<a name="line.257"></a>
<FONT color="green">258</FONT> * URL-encode the given input String with the given encoding scheme, using<a name="line.258"></a>
<FONT color="green">259</FONT> * {@link URLEncoder#encode(String, String) URLEncoder.encode(input, enc)}.<a name="line.259"></a>
<FONT color="green">260</FONT> *<a name="line.260"></a>
<FONT color="green">261</FONT> * @param input the unencoded input String<a name="line.261"></a>
<FONT color="green">262</FONT> * @param encodingScheme the encoding scheme<a name="line.262"></a>
<FONT color="green">263</FONT> * @return the encoded output String<a name="line.263"></a>
<FONT color="green">264</FONT> * @throws UnsupportedEncodingException if thrown by the JDK URLEncoder<a name="line.264"></a>
<FONT color="green">265</FONT> * @see java.net.URLEncoder#encode(String, String)<a name="line.265"></a>
<FONT color="green">266</FONT> * @see java.net.URLEncoder#encode(String)<a name="line.266"></a>
<FONT color="green">267</FONT> */<a name="line.267"></a>
<FONT color="green">268</FONT> protected String urlEncode(String input, String encodingScheme) throws UnsupportedEncodingException {<a name="line.268"></a>
<FONT color="green">269</FONT> return URLEncoder.encode(input, encodingScheme);<a name="line.269"></a>
<FONT color="green">270</FONT> }<a name="line.270"></a>
<FONT color="green">271</FONT> <a name="line.271"></a>
<FONT color="green">272</FONT> /**<a name="line.272"></a>
<FONT color="green">273</FONT> * Determine name-value pairs for query strings, which will be stringified,<a name="line.273"></a>
<FONT color="green">274</FONT> * URL-encoded and formatted by appendQueryProperties.<a name="line.274"></a>
<FONT color="green">275</FONT> * &lt;p/&gt;<a name="line.275"></a>
<FONT color="green">276</FONT> * This implementation returns all model elements as-is.<a name="line.276"></a>
<FONT color="green">277</FONT> *<a name="line.277"></a>
<FONT color="green">278</FONT> * @param model the model elements for which to determine name-value pairs.<a name="line.278"></a>
<FONT color="green">279</FONT> * @return the name-value pairs for query strings.<a name="line.279"></a>
<FONT color="green">280</FONT> * @see #appendQueryProperties<a name="line.280"></a>
<FONT color="green">281</FONT> */<a name="line.281"></a>
<FONT color="green">282</FONT> protected Map queryProperties(Map model) {<a name="line.282"></a>
<FONT color="green">283</FONT> return model;<a name="line.283"></a>
<FONT color="green">284</FONT> }<a name="line.284"></a>
<FONT color="green">285</FONT> <a name="line.285"></a>
<FONT color="green">286</FONT> /**<a name="line.286"></a>
<FONT color="green">287</FONT> * Send a redirect back to the HTTP client<a name="line.287"></a>
<FONT color="green">288</FONT> *<a name="line.288"></a>
<FONT color="green">289</FONT> * @param request current HTTP request (allows for reacting to request method)<a name="line.289"></a>
<FONT color="green">290</FONT> * @param response current HTTP response (for sending response headers)<a name="line.290"></a>
<FONT color="green">291</FONT> * @param targetUrl the name URL to redirect to<a name="line.291"></a>
<FONT color="green">292</FONT> * @param http10Compatible whether to stay compatible with HTTP 1.0 clients<a name="line.292"></a>
<FONT color="green">293</FONT> * @throws IOException if thrown by response methods<a name="line.293"></a>
<FONT color="green">294</FONT> */<a name="line.294"></a>
<FONT color="green">295</FONT> @SuppressWarnings({"UnusedDeclaration"})<a name="line.295"></a>
<FONT color="green">296</FONT> protected void sendRedirect(HttpServletRequest request, HttpServletResponse response,<a name="line.296"></a>
<FONT color="green">297</FONT> String targetUrl, boolean http10Compatible) throws IOException {<a name="line.297"></a>
<FONT color="green">298</FONT> if (http10Compatible) {<a name="line.298"></a>
<FONT color="green">299</FONT> // Always send status code 302.<a name="line.299"></a>
<FONT color="green">300</FONT> response.sendRedirect(response.encodeRedirectURL(targetUrl));<a name="line.300"></a>
<FONT color="green">301</FONT> } else {<a name="line.301"></a>
<FONT color="green">302</FONT> // Correct HTTP status code is 303, in particular for POST requests.<a name="line.302"></a>
<FONT color="green">303</FONT> response.setStatus(303);<a name="line.303"></a>
<FONT color="green">304</FONT> response.setHeader("Location", response.encodeRedirectURL(targetUrl));<a name="line.304"></a>
<FONT color="green">305</FONT> }<a name="line.305"></a>
<FONT color="green">306</FONT> }<a name="line.306"></a>
<FONT color="green">307</FONT> <a name="line.307"></a>
<FONT color="green">308</FONT> }<a name="line.308"></a>
</PRE>
</BODY>
</HTML>