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