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