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