| <!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=UTF-8" /> |
| <title>WebUtils xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/web/util/WebUtils.html">View Javadoc</a></div><pre> |
| <a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> |
| <a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L10" href="#L10">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 class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.web.util; |
| <a class="jxr_linenumber" name="L20" href="#L20">20</a> |
| <a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.SecurityUtils; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.Session; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.Subject; |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.support.DefaultSubjectContext; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils; |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.env.EnvironmentLoader; |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.env.WebEnvironment; |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.filter.AccessControlFilter; |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.owasp.encoder.Encode; |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletContext; |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletRequest; |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletResponse; |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest; |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse; |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> java.io.IOException; |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> java.io.UnsupportedEncodingException; |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> java.net.URLDecoder; |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> java.util.Map; |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * Simple utility class for operations used across multiple class hierarchies in the web framework code.</em> |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * Some methods in this class were copied from the Spring Framework so we didn't have to re-invent the wheel,</em> |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * and in these cases, we have retained all license, copyright and author information.</em> |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="WebUtils" href="../../../../../org/apache/shiro/web/util/WebUtils.html#WebUtils">WebUtils</a> { |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_comment">//TODO - complete JavaDoc</em> |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(WebUtils.<strong class="jxr_keyword">class</strong>); |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SERVLET_REQUEST_KEY = ServletRequest.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">"_SHIRO_THREAD_CONTEXT_KEY"</span>; |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SERVLET_RESPONSE_KEY = ServletResponse.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">"_SHIRO_THREAD_CONTEXT_KEY"</span>; |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.session.Session Session} key used to save a request and later restore it, for example when redirecting to a</em> |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * requested page after login, equal to {@code shiroSavedRequest}.</em> |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SAVED_REQUEST_KEY = <span class="jxr_string">"shiroSavedRequest"</span>; |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * Standard Servlet 2.3+ spec request attributes for include URI and paths.</em> |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * <p>If included via a RequestDispatcher, the current resource will see the</em> |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * originating request. Its own URI and paths are exposed as request attributes.</em> |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String INCLUDE_REQUEST_URI_ATTRIBUTE = <span class="jxr_string">"javax.servlet.include.request_uri"</span>; |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String INCLUDE_CONTEXT_PATH_ATTRIBUTE = <span class="jxr_string">"javax.servlet.include.context_path"</span>; |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String INCLUDE_SERVLET_PATH_ATTRIBUTE = <span class="jxr_string">"javax.servlet.include.servlet_path"</span>; |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String INCLUDE_PATH_INFO_ATTRIBUTE = <span class="jxr_string">"javax.servlet.include.path_info"</span>; |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String INCLUDE_QUERY_STRING_ATTRIBUTE = <span class="jxr_string">"javax.servlet.include.query_string"</span>; |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * Standard Servlet 2.4+ spec request attributes for forward URI and paths.</em> |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * <p>If forwarded to via a RequestDispatcher, the current resource will see its</em> |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * own URI and paths. The originating URI and paths are exposed as request attributes.</em> |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String FORWARD_REQUEST_URI_ATTRIBUTE = <span class="jxr_string">"javax.servlet.forward.request_uri"</span>; |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String FORWARD_CONTEXT_PATH_ATTRIBUTE = <span class="jxr_string">"javax.servlet.forward.context_path"</span>; |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String FORWARD_SERVLET_PATH_ATTRIBUTE = <span class="jxr_string">"javax.servlet.forward.servlet_path"</span>; |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String FORWARD_PATH_INFO_ATTRIBUTE = <span class="jxr_string">"javax.servlet.forward.path_info"</span>; |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String FORWARD_QUERY_STRING_ATTRIBUTE = <span class="jxr_string">"javax.servlet.forward.query_string"</span>; |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * Default character encoding to use when <code>request.getCharacterEncoding</code></em> |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * returns <code>null</code>, according to the Servlet spec.</em> |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * @see javax.servlet.ServletRequest#getCharacterEncoding</em> |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_CHARACTER_ENCODING = <span class="jxr_string">"ISO-8859-1"</span>; |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * Return the path within the web application for the given request.</em> |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * Detects include request URL if called within a RequestDispatcher include.</em> |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * For example, for a request to URL</em> |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * <code><a href="http://www.somehost.com/myapp/my/url.jsp</code>," target="alexandria_uri">http://www.somehost.com/myapp/my/url.jsp</code>,</a></em> |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * for an application deployed to <code>/mayapp</code> (the application's context path), this method would return</em> |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * <code>/my/url.jsp</code>.</em> |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * @param request current HTTP request</em> |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * @return the path within the web application</em> |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String getPathWithinApplication(HttpServletRequest request) { |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> String contextPath = getContextPath(request); |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> String requestUri = getRequestUri(request); |
| <a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">if</strong> (StringUtils.startsWithIgnoreCase(requestUri, contextPath)) { |
| <a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_comment">// Normal case: URI contains context path.</em> |
| <a class="jxr_linenumber" name="L116" href="#L116">116</a> String path = requestUri.substring(contextPath.length()); |
| <a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">return</strong> (StringUtils.hasText(path) ? path : <span class="jxr_string">"/"</span>); |
| <a class="jxr_linenumber" name="L118" href="#L118">118</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_comment">// Special case: rather unusual.</em> |
| <a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">return</strong> requestUri; |
| <a class="jxr_linenumber" name="L121" href="#L121">121</a> } |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> } |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> |
| <a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * Return the request URI for the given request, detecting an include request</em> |
| <a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * URL if called within a RequestDispatcher include.</em> |
| <a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * <p>As the value returned by <code>request.getRequestURI()</code> is <i>not</i></em> |
| <a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * decoded by the servlet container, this method will decode it.</em> |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * <p>The URI that the web container resolves <i>should</i> be correct, but some</em> |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * containers like JBoss/Jetty incorrectly include ";" strings like ";jsessionid"</em> |
| <a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * in the URI. This method cuts off such incorrect appendices.</em> |
| <a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * @param request current HTTP request</em> |
| <a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * @return the request URI</em> |
| <a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String getRequestUri(HttpServletRequest request) { |
| <a class="jxr_linenumber" name="L137" href="#L137">137</a> String uri = (String) request.getAttribute(INCLUDE_REQUEST_URI_ATTRIBUTE); |
| <a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">if</strong> (uri == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L139" href="#L139">139</a> uri = request.getRequestURI(); |
| <a class="jxr_linenumber" name="L140" href="#L140">140</a> } |
| <a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">return</strong> normalize(decodeAndCleanUriString(request, uri)); |
| <a class="jxr_linenumber" name="L142" href="#L142">142</a> } |
| <a class="jxr_linenumber" name="L143" href="#L143">143</a> |
| <a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * Normalize a relative URI path that may have relative values ("/./",</em> |
| <a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * "/../", and so on ) it it. <strong>WARNING</strong> - This method is</em> |
| <a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * useful only for normalizing application-generated paths. It does not</em> |
| <a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * try to perform security checks for malicious input.</em> |
| <a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * Normalize operations were was happily taken from org.apache.catalina.util.RequestUtil in</em> |
| <a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * Tomcat trunk, r939305</em> |
| <a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * @param path Relative path to be normalized</em> |
| <a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * @return normalized path</em> |
| <a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String normalize(String path) { |
| <a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">return</strong> normalize(path, <strong class="jxr_keyword">true</strong>); |
| <a class="jxr_linenumber" name="L157" href="#L157">157</a> } |
| <a class="jxr_linenumber" name="L158" href="#L158">158</a> |
| <a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * Normalize a relative URI path that may have relative values ("/./",</em> |
| <a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * "/../", and so on ) it it. <strong>WARNING</strong> - This method is</em> |
| <a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * useful only for normalizing application-generated paths. It does not</em> |
| <a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * try to perform security checks for malicious input.</em> |
| <a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * Normalize operations were was happily taken from org.apache.catalina.util.RequestUtil in</em> |
| <a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * Tomcat trunk, r939305</em> |
| <a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * @param path Relative path to be normalized</em> |
| <a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * @param replaceBackSlash Should '\\' be replaced with '/'</em> |
| <a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * @return normalized path</em> |
| <a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String normalize(String path, <strong class="jxr_keyword">boolean</strong> replaceBackSlash) { |
| <a class="jxr_linenumber" name="L172" href="#L172">172</a> |
| <a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">if</strong> (path == <strong class="jxr_keyword">null</strong>) |
| <a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L175" href="#L175">175</a> |
| <a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_comment">// Create a place for the normalized path</em> |
| <a class="jxr_linenumber" name="L177" href="#L177">177</a> String normalized = path; |
| <a class="jxr_linenumber" name="L178" href="#L178">178</a> |
| <a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">if</strong> (replaceBackSlash && normalized.indexOf('\\') >= 0) |
| <a class="jxr_linenumber" name="L180" href="#L180">180</a> normalized = normalized.replace('\\', '/'); |
| <a class="jxr_linenumber" name="L181" href="#L181">181</a> |
| <a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">if</strong> (normalized.equals(<span class="jxr_string">"/."</span>)) |
| <a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"/"</span>; |
| <a class="jxr_linenumber" name="L184" href="#L184">184</a> |
| <a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_comment">// Add a leading "/" if necessary</em> |
| <a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">if</strong> (!normalized.startsWith(<span class="jxr_string">"/"</span>)) |
| <a class="jxr_linenumber" name="L187" href="#L187">187</a> normalized = <span class="jxr_string">"/"</span> + normalized; |
| <a class="jxr_linenumber" name="L188" href="#L188">188</a> |
| <a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_comment">// Resolve occurrences of "//" in the normalized path</em> |
| <a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">while</strong> (<strong class="jxr_keyword">true</strong>) { |
| <a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">int</strong> index = normalized.indexOf(<span class="jxr_string">"//"</span>); |
| <a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">if</strong> (index < 0) |
| <a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">break</strong>; |
| <a class="jxr_linenumber" name="L194" href="#L194">194</a> normalized = normalized.substring(0, index) + |
| <a class="jxr_linenumber" name="L195" href="#L195">195</a> normalized.substring(index + 1); |
| <a class="jxr_linenumber" name="L196" href="#L196">196</a> } |
| <a class="jxr_linenumber" name="L197" href="#L197">197</a> |
| <a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_comment">// Resolve occurrences of "/./" in the normalized path</em> |
| <a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">while</strong> (<strong class="jxr_keyword">true</strong>) { |
| <a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">int</strong> index = normalized.indexOf(<span class="jxr_string">"/./"</span>); |
| <a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong class="jxr_keyword">if</strong> (index < 0) |
| <a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">break</strong>; |
| <a class="jxr_linenumber" name="L203" href="#L203">203</a> normalized = normalized.substring(0, index) + |
| <a class="jxr_linenumber" name="L204" href="#L204">204</a> normalized.substring(index + 2); |
| <a class="jxr_linenumber" name="L205" href="#L205">205</a> } |
| <a class="jxr_linenumber" name="L206" href="#L206">206</a> |
| <a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_comment">// Resolve occurrences of "/../" in the normalized path</em> |
| <a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">while</strong> (<strong class="jxr_keyword">true</strong>) { |
| <a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">int</strong> index = normalized.indexOf(<span class="jxr_string">"/../"</span>); |
| <a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">if</strong> (index < 0) |
| <a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">break</strong>; |
| <a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">if</strong> (index == 0) |
| <a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">return</strong> (<strong class="jxr_keyword">null</strong>); <em class="jxr_comment">// Trying to go outside our context</em> |
| <a class="jxr_linenumber" name="L214" href="#L214">214</a> <strong class="jxr_keyword">int</strong> index2 = normalized.lastIndexOf('/', index - 1); |
| <a class="jxr_linenumber" name="L215" href="#L215">215</a> normalized = normalized.substring(0, index2) + |
| <a class="jxr_linenumber" name="L216" href="#L216">216</a> normalized.substring(index + 3); |
| <a class="jxr_linenumber" name="L217" href="#L217">217</a> } |
| <a class="jxr_linenumber" name="L218" href="#L218">218</a> |
| <a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_comment">// Return the normalized path that we have completed</em> |
| <a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong class="jxr_keyword">return</strong> (normalized); |
| <a class="jxr_linenumber" name="L221" href="#L221">221</a> |
| <a class="jxr_linenumber" name="L222" href="#L222">222</a> } |
| <a class="jxr_linenumber" name="L223" href="#L223">223</a> |
| <a class="jxr_linenumber" name="L224" href="#L224">224</a> |
| <a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment"> * Decode the supplied URI string and strips any extraneous portion after a ';'.</em> |
| <a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment"> * @param request the incoming HttpServletRequest</em> |
| <a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment"> * @param uri the application's URI string</em> |
| <a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> * @return the supplied URI string stripped of any extraneous portion after a ';'.</em> |
| <a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String decodeAndCleanUriString(HttpServletRequest request, String uri) { |
| <a class="jxr_linenumber" name="L233" href="#L233">233</a> uri = decodeRequestString(request, uri); |
| <a class="jxr_linenumber" name="L234" href="#L234">234</a> <strong class="jxr_keyword">int</strong> semicolonIndex = uri.indexOf(';'); |
| <a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">return</strong> (semicolonIndex != -1 ? uri.substring(0, semicolonIndex) : uri); |
| <a class="jxr_linenumber" name="L236" href="#L236">236</a> } |
| <a class="jxr_linenumber" name="L237" href="#L237">237</a> |
| <a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> * Return the context path for the given request, detecting an include request</em> |
| <a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> * URL if called within a RequestDispatcher include.</em> |
| <a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> * <p>As the value returned by <code>request.getContextPath()</code> is <i>not</i></em> |
| <a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment"> * decoded by the servlet container, this method will decode it.</em> |
| <a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> * @param request current HTTP request</em> |
| <a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment"> * @return the context path</em> |
| <a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String getContextPath(HttpServletRequest request) { |
| <a class="jxr_linenumber" name="L248" href="#L248">248</a> String contextPath = (String) request.getAttribute(INCLUDE_CONTEXT_PATH_ATTRIBUTE); |
| <a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">if</strong> (contextPath == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L250" href="#L250">250</a> contextPath = request.getContextPath(); |
| <a class="jxr_linenumber" name="L251" href="#L251">251</a> } |
| <a class="jxr_linenumber" name="L252" href="#L252">252</a> contextPath = normalize(decodeRequestString(request, contextPath)); |
| <a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"/"</span>.equals(contextPath)) { |
| <a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_comment">// the normalize method will return a "/" and includes on Jetty, will also be a "/".</em> |
| <a class="jxr_linenumber" name="L255" href="#L255">255</a> contextPath = <span class="jxr_string">""</span>; |
| <a class="jxr_linenumber" name="L256" href="#L256">256</a> } |
| <a class="jxr_linenumber" name="L257" href="#L257">257</a> <strong class="jxr_keyword">return</strong> contextPath; |
| <a class="jxr_linenumber" name="L258" href="#L258">258</a> } |
| <a class="jxr_linenumber" name="L259" href="#L259">259</a> |
| <a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment"> * Find the Shiro {@link WebEnvironment} for this web application, which is typically loaded via the</em> |
| <a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.web.env.EnvironmentLoaderListener}.</em> |
| <a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> * This implementation rethrows an exception that happened on environment startup to differentiate between a failed</em> |
| <a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> * environment startup and no environment at all.</em> |
| <a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> * @param sc ServletContext to find the web application context for</em> |
| <a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> * @return the root WebApplicationContext for this web app</em> |
| <a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> * @throws IllegalStateException if the root WebApplicationContext could not be found</em> |
| <a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.web.env.EnvironmentLoader#ENVIRONMENT_ATTRIBUTE_KEY</em> |
| <a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a name="WebEnvironment" href="../../../../../org/apache/shiro/web/env/WebEnvironment.html#WebEnvironment">WebEnvironment</a> getRequiredWebEnvironment(ServletContext sc) |
| <a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong class="jxr_keyword">throws</strong> IllegalStateException { |
| <a class="jxr_linenumber" name="L275" href="#L275">275</a> |
| <a class="jxr_linenumber" name="L276" href="#L276">276</a> <a name="WebEnvironment" href="../../../../../org/apache/shiro/web/env/WebEnvironment.html#WebEnvironment">WebEnvironment</a> we = getWebEnvironment(sc); |
| <a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong class="jxr_keyword">if</strong> (we == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"No WebEnvironment found: no EnvironmentLoaderListener registered?"</span>); |
| <a class="jxr_linenumber" name="L279" href="#L279">279</a> } |
| <a class="jxr_linenumber" name="L280" href="#L280">280</a> <strong class="jxr_keyword">return</strong> we; |
| <a class="jxr_linenumber" name="L281" href="#L281">281</a> } |
| <a class="jxr_linenumber" name="L282" href="#L282">282</a> |
| <a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment"> * Find the Shiro {@link WebEnvironment} for this web application, which is typically loaded via</em> |
| <a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.web.env.EnvironmentLoaderListener}.</em> |
| <a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> * This implementation rethrows an exception that happened on environment startup to differentiate between a failed</em> |
| <a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> * environment startup and no environment at all.</em> |
| <a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> * @param sc ServletContext to find the web application context for</em> |
| <a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> * @return the root WebApplicationContext for this web app, or <code>null</code> if none</em> |
| <a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.web.env.EnvironmentLoader#ENVIRONMENT_ATTRIBUTE_KEY</em> |
| <a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a name="WebEnvironment" href="../../../../../org/apache/shiro/web/env/WebEnvironment.html#WebEnvironment">WebEnvironment</a> getWebEnvironment(ServletContext sc) { |
| <a class="jxr_linenumber" name="L296" href="#L296">296</a> <strong class="jxr_keyword">return</strong> getWebEnvironment(sc, EnvironmentLoader.ENVIRONMENT_ATTRIBUTE_KEY); |
| <a class="jxr_linenumber" name="L297" href="#L297">297</a> } |
| <a class="jxr_linenumber" name="L298" href="#L298">298</a> |
| <a class="jxr_linenumber" name="L299" href="#L299">299</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment"> * Find the Shiro {@link WebEnvironment} for this web application.</em> |
| <a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> * @param sc ServletContext to find the web application context for</em> |
| <a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_javadoccomment"> * @param attrName the name of the ServletContext attribute to look for</em> |
| <a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_javadoccomment"> * @return the desired WebEnvironment for this web app, or <code>null</code> if none</em> |
| <a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a class="jxr_linenumber" name="L306" href="#L306">306</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L307" href="#L307">307</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a name="WebEnvironment" href="../../../../../org/apache/shiro/web/env/WebEnvironment.html#WebEnvironment">WebEnvironment</a> getWebEnvironment(ServletContext sc, String attrName) { |
| <a class="jxr_linenumber" name="L308" href="#L308">308</a> <strong class="jxr_keyword">if</strong> (sc == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L309" href="#L309">309</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"ServletContext argument must not be null."</span>); |
| <a class="jxr_linenumber" name="L310" href="#L310">310</a> } |
| <a class="jxr_linenumber" name="L311" href="#L311">311</a> Object attr = sc.getAttribute(attrName); |
| <a class="jxr_linenumber" name="L312" href="#L312">312</a> <strong class="jxr_keyword">if</strong> (attr == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L314" href="#L314">314</a> } |
| <a class="jxr_linenumber" name="L315" href="#L315">315</a> <strong class="jxr_keyword">if</strong> (attr instanceof RuntimeException) { |
| <a class="jxr_linenumber" name="L316" href="#L316">316</a> <strong class="jxr_keyword">throw</strong> (RuntimeException) attr; |
| <a class="jxr_linenumber" name="L317" href="#L317">317</a> } |
| <a class="jxr_linenumber" name="L318" href="#L318">318</a> <strong class="jxr_keyword">if</strong> (attr instanceof Error) { |
| <a class="jxr_linenumber" name="L319" href="#L319">319</a> <strong class="jxr_keyword">throw</strong> (Error) attr; |
| <a class="jxr_linenumber" name="L320" href="#L320">320</a> } |
| <a class="jxr_linenumber" name="L321" href="#L321">321</a> <strong class="jxr_keyword">if</strong> (attr instanceof Exception) { |
| <a class="jxr_linenumber" name="L322" href="#L322">322</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException((Exception) attr); |
| <a class="jxr_linenumber" name="L323" href="#L323">323</a> } |
| <a class="jxr_linenumber" name="L324" href="#L324">324</a> <strong class="jxr_keyword">if</strong> (!(attr instanceof <a name="WebEnvironment" href="../../../../../org/apache/shiro/web/env/WebEnvironment.html#WebEnvironment">WebEnvironment</a>)) { |
| <a class="jxr_linenumber" name="L325" href="#L325">325</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"Context attribute is not of type WebEnvironment: "</span> + attr); |
| <a class="jxr_linenumber" name="L326" href="#L326">326</a> } |
| <a class="jxr_linenumber" name="L327" href="#L327">327</a> <strong class="jxr_keyword">return</strong> (<a name="WebEnvironment" href="../../../../../org/apache/shiro/web/env/WebEnvironment.html#WebEnvironment">WebEnvironment</a>) attr; |
| <a class="jxr_linenumber" name="L328" href="#L328">328</a> } |
| <a class="jxr_linenumber" name="L329" href="#L329">329</a> |
| <a class="jxr_linenumber" name="L330" href="#L330">330</a> |
| <a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> * Decode the given source string with a URLDecoder. The encoding will be taken</em> |
| <a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment"> * from the request, falling back to the default "ISO-8859-1".</em> |
| <a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment"> * <p>The default implementation uses <code>URLDecoder.decode(input, enc)</code>.</em> |
| <a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment"> * @param request current HTTP request</em> |
| <a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_javadoccomment"> * @param source the String to decode</em> |
| <a class="jxr_linenumber" name="L338" href="#L338">338</a> <em class="jxr_javadoccomment"> * @return the decoded String</em> |
| <a class="jxr_linenumber" name="L339" href="#L339">339</a> <em class="jxr_javadoccomment"> * @see #DEFAULT_CHARACTER_ENCODING</em> |
| <a class="jxr_linenumber" name="L340" href="#L340">340</a> <em class="jxr_javadoccomment"> * @see javax.servlet.ServletRequest#getCharacterEncoding</em> |
| <a class="jxr_linenumber" name="L341" href="#L341">341</a> <em class="jxr_javadoccomment"> * @see java.net.URLDecoder#decode(String, String)</em> |
| <a class="jxr_linenumber" name="L342" href="#L342">342</a> <em class="jxr_javadoccomment"> * @see java.net.URLDecoder#decode(String)</em> |
| <a class="jxr_linenumber" name="L343" href="#L343">343</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L344" href="#L344">344</a> @SuppressWarnings({<span class="jxr_string">"deprecation"</span>}) |
| <a class="jxr_linenumber" name="L345" href="#L345">345</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String decodeRequestString(HttpServletRequest request, String source) { |
| <a class="jxr_linenumber" name="L346" href="#L346">346</a> String enc = determineEncoding(request); |
| <a class="jxr_linenumber" name="L347" href="#L347">347</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L348" href="#L348">348</a> <strong class="jxr_keyword">return</strong> URLDecoder.decode(source, enc); |
| <a class="jxr_linenumber" name="L349" href="#L349">349</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException ex) { |
| <a class="jxr_linenumber" name="L350" href="#L350">350</a> <strong class="jxr_keyword">if</strong> (log.isWarnEnabled()) { |
| <a class="jxr_linenumber" name="L351" href="#L351">351</a> log.warn(<span class="jxr_string">"Could not decode request string ["</span> + Encode.forHtml(source) + <span class="jxr_string">"] with encoding '"</span> + Encode.forHtml(enc) + |
| <a class="jxr_linenumber" name="L352" href="#L352">352</a> <span class="jxr_string">"': falling back to platform default encoding; exception message: "</span> + ex.getMessage()); |
| <a class="jxr_linenumber" name="L353" href="#L353">353</a> } |
| <a class="jxr_linenumber" name="L354" href="#L354">354</a> <strong class="jxr_keyword">return</strong> URLDecoder.decode(source); |
| <a class="jxr_linenumber" name="L355" href="#L355">355</a> } |
| <a class="jxr_linenumber" name="L356" href="#L356">356</a> } |
| <a class="jxr_linenumber" name="L357" href="#L357">357</a> |
| <a class="jxr_linenumber" name="L358" href="#L358">358</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L359" href="#L359">359</a> <em class="jxr_javadoccomment"> * Determine the encoding for the given request.</em> |
| <a class="jxr_linenumber" name="L360" href="#L360">360</a> <em class="jxr_javadoccomment"> * Can be overridden in subclasses.</em> |
| <a class="jxr_linenumber" name="L361" href="#L361">361</a> <em class="jxr_javadoccomment"> * <p>The default implementation checks the request's</em> |
| <a class="jxr_linenumber" name="L362" href="#L362">362</a> <em class="jxr_javadoccomment"> * {@link ServletRequest#getCharacterEncoding() character encoding}, and if that</em> |
| <a class="jxr_linenumber" name="L363" href="#L363">363</a> <em class="jxr_javadoccomment"> * <code>null</code>, falls back to the {@link #DEFAULT_CHARACTER_ENCODING}.</em> |
| <a class="jxr_linenumber" name="L364" href="#L364">364</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L365" href="#L365">365</a> <em class="jxr_javadoccomment"> * @param request current HTTP request</em> |
| <a class="jxr_linenumber" name="L366" href="#L366">366</a> <em class="jxr_javadoccomment"> * @return the encoding for the request (never <code>null</code>)</em> |
| <a class="jxr_linenumber" name="L367" href="#L367">367</a> <em class="jxr_javadoccomment"> * @see javax.servlet.ServletRequest#getCharacterEncoding()</em> |
| <a class="jxr_linenumber" name="L368" href="#L368">368</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L369" href="#L369">369</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> String determineEncoding(HttpServletRequest request) { |
| <a class="jxr_linenumber" name="L370" href="#L370">370</a> String enc = request.getCharacterEncoding(); |
| <a class="jxr_linenumber" name="L371" href="#L371">371</a> <strong class="jxr_keyword">if</strong> (enc == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L372" href="#L372">372</a> enc = DEFAULT_CHARACTER_ENCODING; |
| <a class="jxr_linenumber" name="L373" href="#L373">373</a> } |
| <a class="jxr_linenumber" name="L374" href="#L374">374</a> <strong class="jxr_keyword">return</strong> enc; |
| <a class="jxr_linenumber" name="L375" href="#L375">375</a> } |
| <a class="jxr_linenumber" name="L376" href="#L376">376</a> |
| <a class="jxr_linenumber" name="L377" href="#L377">377</a> <em class="jxr_comment">/*</em> |
| <a class="jxr_linenumber" name="L378" href="#L378">378</a> <em class="jxr_comment"> * Returns {@code true} IFF the specified {@code SubjectContext}:</em> |
| <a class="jxr_linenumber" name="L379" href="#L379">379</a> <em class="jxr_comment"> * <ol></em> |
| <a class="jxr_linenumber" name="L380" href="#L380">380</a> <em class="jxr_comment"> * <li>A {@link WebSubjectContext} instance</li></em> |
| <a class="jxr_linenumber" name="L381" href="#L381">381</a> <em class="jxr_comment"> * <li>The {@code WebSubjectContext}'s request/response pair are not null</li></em> |
| <a class="jxr_linenumber" name="L382" href="#L382">382</a> <em class="jxr_comment"> * <li>The request is an {@link HttpServletRequest} instance</li></em> |
| <a class="jxr_linenumber" name="L383" href="#L383">383</a> <em class="jxr_comment"> * <li>The response is an {@link HttpServletResponse} instance</li></em> |
| <a class="jxr_linenumber" name="L384" href="#L384">384</a> <em class="jxr_comment"> * </ol></em> |
| <a class="jxr_linenumber" name="L385" href="#L385">385</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L386" href="#L386">386</a> <em class="jxr_comment"> * @param context the SubjectContext to check to see if it is HTTP compatible.</em> |
| <a class="jxr_linenumber" name="L387" href="#L387">387</a> <em class="jxr_comment"> * @return {@code true} IFF the specified context has HTTP request/response objects, {@code false} otherwise.</em> |
| <a class="jxr_linenumber" name="L388" href="#L388">388</a> <em class="jxr_comment"> * @since 1.0</em> |
| <a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="L390" href="#L390">390</a> |
| <a class="jxr_linenumber" name="L391" href="#L391">391</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isWeb(Object requestPairSource) { |
| <a class="jxr_linenumber" name="L392" href="#L392">392</a> <strong class="jxr_keyword">return</strong> requestPairSource instanceof <a name="RequestPairSource" href="..<a name="RequestPairSource" href="../../../../../org/apache/shiro/web/util/RequestPairSource.html#RequestPairSource">RequestPairSource</a>apache/shiro/web/util/RequestPairSource.html#RequestPairSource">RequestPairSource</a> && isWeb((<a name="RequestPairSource" href="../../../../../org/apache/shiro/web/util/RequestPairSource.html#RequestPairSource">RequestPairSource</a>) requestPairSource); |
| <a class="jxr_linenumber" name="L393" href="#L393">393</a> } |
| <a class="jxr_linenumber" name="L394" href="#L394">394</a> |
| <a class="jxr_linenumber" name="L395" href="#L395">395</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isHttp(Object requestPairSource) { |
| <a class="jxr_linenumber" name="L396" href="#L396">396</a> <strong class="jxr_keyword">return</strong> requestPairSource instanceof <a name="RequestPairSource" href="../<a name="RequestPairSource" href="../../../../../org/apache/shiro/web/util/RequestPairSource.html#RequestPairSource">RequestPairSource</a>pache/shiro/web/util/RequestPairSource.html#RequestPairSource">RequestPairSource</a> && isHttp((<a name="RequestPairSource" href="../../../../../org/apache/shiro/web/util/RequestPairSource.html#RequestPairSource">RequestPairSource</a>) requestPairSource); |
| <a class="jxr_linenumber" name="L397" href="#L397">397</a> } |
| <a class="jxr_linenumber" name="L398" href="#L398">398</a> |
| <a class="jxr_linenumber" name="L399" href="#L399">399</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> ServletRequest getRequest(Object requestPairSource) { |
| <a class="jxr_linenumber" name="L400" href="#L400">400</a> <strong class="jxr_keyword">if</strong> (requestPairSource instanceof <a name="RequestPairSource" href="../../../../../org/apache/shiro/web/util/RequestPairSource.html#RequestPairSource">RequestPairSource</a>) { |
| <a class="jxr_linenumber" name="L401" href="#L401">401</a> <strong class="jxr_keyword">return</strong> ((<a name="RequestPairSource" href="../../../../../org/apache/shiro/web/util/RequestPairSource.html#RequestPairSource">RequestPairSource</a>) requestPairSource).getServletRequest(); |
| <a class="jxr_linenumber" name="L402" href="#L402">402</a> } |
| <a class="jxr_linenumber" name="L403" href="#L403">403</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L404" href="#L404">404</a> } |
| <a class="jxr_linenumber" name="L405" href="#L405">405</a> |
| <a class="jxr_linenumber" name="L406" href="#L406">406</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> ServletResponse getResponse(Object requestPairSource) { |
| <a class="jxr_linenumber" name="L407" href="#L407">407</a> <strong class="jxr_keyword">if</strong> (requestPairSource instanceof <a name="RequestPairSource" href="../../../../../org/apache/shiro/web/util/RequestPairSource.html#RequestPairSource">RequestPairSource</a>) { |
| <a class="jxr_linenumber" name="L408" href="#L408">408</a> <strong class="jxr_keyword">return</strong> ((<a name="RequestPairSource" href="../../../../../org/apache/shiro/web/util/RequestPairSource.html#RequestPairSource">RequestPairSource</a>) requestPairSource).getServletResponse(); |
| <a class="jxr_linenumber" name="L409" href="#L409">409</a> } |
| <a class="jxr_linenumber" name="L410" href="#L410">410</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L411" href="#L411">411</a> } |
| <a class="jxr_linenumber" name="L412" href="#L412">412</a> |
| <a class="jxr_linenumber" name="L413" href="#L413">413</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> HttpServletRequest getHttpRequest(Object requestPairSource) { |
| <a class="jxr_linenumber" name="L414" href="#L414">414</a> ServletRequest request = getRequest(requestPairSource); |
| <a class="jxr_linenumber" name="L415" href="#L415">415</a> <strong class="jxr_keyword">if</strong> (request instanceof HttpServletRequest) { |
| <a class="jxr_linenumber" name="L416" href="#L416">416</a> <strong class="jxr_keyword">return</strong> (HttpServletRequest) request; |
| <a class="jxr_linenumber" name="L417" href="#L417">417</a> } |
| <a class="jxr_linenumber" name="L418" href="#L418">418</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L419" href="#L419">419</a> } |
| <a class="jxr_linenumber" name="L420" href="#L420">420</a> |
| <a class="jxr_linenumber" name="L421" href="#L421">421</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> HttpServletResponse getHttpResponse(Object requestPairSource) { |
| <a class="jxr_linenumber" name="L422" href="#L422">422</a> ServletResponse response = getResponse(requestPairSource); |
| <a class="jxr_linenumber" name="L423" href="#L423">423</a> <strong class="jxr_keyword">if</strong> (response instanceof HttpServletResponse) { |
| <a class="jxr_linenumber" name="L424" href="#L424">424</a> <strong class="jxr_keyword">return</strong> (HttpServletResponse) response; |
| <a class="jxr_linenumber" name="L425" href="#L425">425</a> } |
| <a class="jxr_linenumber" name="L426" href="#L426">426</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L427" href="#L427">427</a> } |
| <a class="jxr_linenumber" name="L428" href="#L428">428</a> |
| <a class="jxr_linenumber" name="L429" href="#L429">429</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isWeb(<a name="RequestPairSource" href="../../../../../org/apache/shiro/web/util/RequestPairSource.html#RequestPairSource">RequestPairSource</a> source) { |
| <a class="jxr_linenumber" name="L430" href="#L430">430</a> ServletRequest request = source.getServletRequest(); |
| <a class="jxr_linenumber" name="L431" href="#L431">431</a> ServletResponse response = source.getServletResponse(); |
| <a class="jxr_linenumber" name="L432" href="#L432">432</a> <strong class="jxr_keyword">return</strong> request != <strong class="jxr_keyword">null</strong> && response != <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L433" href="#L433">433</a> } |
| <a class="jxr_linenumber" name="L434" href="#L434">434</a> |
| <a class="jxr_linenumber" name="L435" href="#L435">435</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isHttp(<a name="RequestPairSource" href="../../../../../org/apache/shiro/web/util/RequestPairSource.html#RequestPairSource">RequestPairSource</a> source) { |
| <a class="jxr_linenumber" name="L436" href="#L436">436</a> ServletRequest request = source.getServletRequest(); |
| <a class="jxr_linenumber" name="L437" href="#L437">437</a> ServletResponse response = source.getServletResponse(); |
| <a class="jxr_linenumber" name="L438" href="#L438">438</a> <strong class="jxr_keyword">return</strong> request instanceof HttpServletRequest && response instanceof HttpServletResponse; |
| <a class="jxr_linenumber" name="L439" href="#L439">439</a> } |
| <a class="jxr_linenumber" name="L440" href="#L440">440</a> |
| <a class="jxr_linenumber" name="L441" href="#L441">441</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L442" href="#L442">442</a> <em class="jxr_javadoccomment"> * Returns {@code true} if a session is allowed to be created for a subject-associated request, {@code false}</em> |
| <a class="jxr_linenumber" name="L443" href="#L443">443</a> <em class="jxr_javadoccomment"> * otherwise.</em> |
| <a class="jxr_linenumber" name="L444" href="#L444">444</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L445" href="#L445">445</a> <em class="jxr_javadoccomment"> * <b>This method exists for Shiro's internal framework needs and should never be called by Shiro end-users. It</em> |
| <a class="jxr_linenumber" name="L446" href="#L446">446</a> <em class="jxr_javadoccomment"> * could be changed/removed at any time.</b></em> |
| <a class="jxr_linenumber" name="L447" href="#L447">447</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L448" href="#L448">448</a> <em class="jxr_javadoccomment"> * @param requestPairSource a {@link RequestPairSource} instance, almost always a</em> |
| <a class="jxr_linenumber" name="L449" href="#L449">449</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.web.subject.WebSubject WebSubject} instance.</em> |
| <a class="jxr_linenumber" name="L450" href="#L450">450</a> <em class="jxr_javadoccomment"> * @return {@code true} if a session is allowed to be created for a subject-associated request, {@code false}</em> |
| <a class="jxr_linenumber" name="L451" href="#L451">451</a> <em class="jxr_javadoccomment"> * otherwise.</em> |
| <a class="jxr_linenumber" name="L452" href="#L452">452</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L453" href="#L453">453</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> _isSessionCreationEnabled(Object requestPairSource) { |
| <a class="jxr_linenumber" name="L454" href="#L454">454</a> <strong class="jxr_keyword">if</strong> (requestPairSource instanceof <a name="RequestPairSource" href="../../../../../org/apache/shiro/web/util/RequestPairSource.html#RequestPairSource">RequestPairSource</a>) { |
| <a class="jxr_linenumber" name="L455" href="#L455">455</a> <a name="RequestPairSource" <a name="RequestPairSource" href="../../../../../org/apache/shiro/web/util/RequestPairSource.html#RequestPairSource">RequestPairSource</a>/../org/apache/shiro/web/util/RequestPairSource.html#RequestPairSource">RequestPairSource</a> source = (<a name="RequestPairSource" href="../../../../../org/apache/shiro/web/util/RequestPairSource.html#RequestPairSource">RequestPairSource</a>) requestPairSource; |
| <a class="jxr_linenumber" name="L456" href="#L456">456</a> <strong class="jxr_keyword">return</strong> _isSessionCreationEnabled(source.getServletRequest()); |
| <a class="jxr_linenumber" name="L457" href="#L457">457</a> } |
| <a class="jxr_linenumber" name="L458" href="#L458">458</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; <em class="jxr_comment">//by default</em> |
| <a class="jxr_linenumber" name="L459" href="#L459">459</a> } |
| <a class="jxr_linenumber" name="L460" href="#L460">460</a> |
| <a class="jxr_linenumber" name="L461" href="#L461">461</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L462" href="#L462">462</a> <em class="jxr_javadoccomment"> * Returns {@code true} if a session is allowed to be created for a subject-associated request, {@code false}</em> |
| <a class="jxr_linenumber" name="L463" href="#L463">463</a> <em class="jxr_javadoccomment"> * otherwise.</em> |
| <a class="jxr_linenumber" name="L464" href="#L464">464</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L465" href="#L465">465</a> <em class="jxr_javadoccomment"> * <b>This method exists for Shiro's internal framework needs and should never be called by Shiro end-users. It</em> |
| <a class="jxr_linenumber" name="L466" href="#L466">466</a> <em class="jxr_javadoccomment"> * could be changed/removed at any time.</b></em> |
| <a class="jxr_linenumber" name="L467" href="#L467">467</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L468" href="#L468">468</a> <em class="jxr_javadoccomment"> * @param request incoming servlet request.</em> |
| <a class="jxr_linenumber" name="L469" href="#L469">469</a> <em class="jxr_javadoccomment"> * @return {@code true} if a session is allowed to be created for a subject-associated request, {@code false}</em> |
| <a class="jxr_linenumber" name="L470" href="#L470">470</a> <em class="jxr_javadoccomment"> * otherwise.</em> |
| <a class="jxr_linenumber" name="L471" href="#L471">471</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L472" href="#L472">472</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> _isSessionCreationEnabled(ServletRequest request) { |
| <a class="jxr_linenumber" name="L473" href="#L473">473</a> <strong class="jxr_keyword">if</strong> (request != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L474" href="#L474">474</a> Object val = request.getAttribute(DefaultSubjectContext.SESSION_CREATION_ENABLED); |
| <a class="jxr_linenumber" name="L475" href="#L475">475</a> <strong class="jxr_keyword">if</strong> (val != <strong class="jxr_keyword">null</strong> && val instanceof Boolean) { |
| <a class="jxr_linenumber" name="L476" href="#L476">476</a> <strong class="jxr_keyword">return</strong> (Boolean) val; |
| <a class="jxr_linenumber" name="L477" href="#L477">477</a> } |
| <a class="jxr_linenumber" name="L478" href="#L478">478</a> } |
| <a class="jxr_linenumber" name="L479" href="#L479">479</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; <em class="jxr_comment">//by default</em> |
| <a class="jxr_linenumber" name="L480" href="#L480">480</a> } |
| <a class="jxr_linenumber" name="L481" href="#L481">481</a> |
| <a class="jxr_linenumber" name="L482" href="#L482">482</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L483" href="#L483">483</a> <em class="jxr_javadoccomment"> * A convenience method that merely casts the incoming <code>ServletRequest</code> to an</em> |
| <a class="jxr_linenumber" name="L484" href="#L484">484</a> <em class="jxr_javadoccomment"> * <code>HttpServletRequest</code>:</em> |
| <a class="jxr_linenumber" name="L485" href="#L485">485</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L486" href="#L486">486</a> <em class="jxr_javadoccomment"> * <code>return (HttpServletRequest)request;</code></em> |
| <a class="jxr_linenumber" name="L487" href="#L487">487</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L488" href="#L488">488</a> <em class="jxr_javadoccomment"> * Logic could be changed in the future for logging or throwing an meaningful exception in</em> |
| <a class="jxr_linenumber" name="L489" href="#L489">489</a> <em class="jxr_javadoccomment"> * non HTTP request environments (e.g. Portlet API).</em> |
| <a class="jxr_linenumber" name="L490" href="#L490">490</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L491" href="#L491">491</a> <em class="jxr_javadoccomment"> * @param request the incoming ServletRequest</em> |
| <a class="jxr_linenumber" name="L492" href="#L492">492</a> <em class="jxr_javadoccomment"> * @return the <code>request</code> argument casted to an <code>HttpServletRequest</code>.</em> |
| <a class="jxr_linenumber" name="L493" href="#L493">493</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L494" href="#L494">494</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> HttpServletRequest toHttp(ServletRequest request) { |
| <a class="jxr_linenumber" name="L495" href="#L495">495</a> <strong class="jxr_keyword">return</strong> (HttpServletRequest) request; |
| <a class="jxr_linenumber" name="L496" href="#L496">496</a> } |
| <a class="jxr_linenumber" name="L497" href="#L497">497</a> |
| <a class="jxr_linenumber" name="L498" href="#L498">498</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L499" href="#L499">499</a> <em class="jxr_javadoccomment"> * A convenience method that merely casts the incoming <code>ServletResponse</code> to an</em> |
| <a class="jxr_linenumber" name="L500" href="#L500">500</a> <em class="jxr_javadoccomment"> * <code>HttpServletResponse</code>:</em> |
| <a class="jxr_linenumber" name="L501" href="#L501">501</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L502" href="#L502">502</a> <em class="jxr_javadoccomment"> * <code>return (HttpServletResponse)response;</code></em> |
| <a class="jxr_linenumber" name="L503" href="#L503">503</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L504" href="#L504">504</a> <em class="jxr_javadoccomment"> * Logic could be changed in the future for logging or throwing an meaningful exception in</em> |
| <a class="jxr_linenumber" name="L505" href="#L505">505</a> <em class="jxr_javadoccomment"> * non HTTP request environments (e.g. Portlet API).</em> |
| <a class="jxr_linenumber" name="L506" href="#L506">506</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L507" href="#L507">507</a> <em class="jxr_javadoccomment"> * @param response the outgoing ServletResponse</em> |
| <a class="jxr_linenumber" name="L508" href="#L508">508</a> <em class="jxr_javadoccomment"> * @return the <code>response</code> argument casted to an <code>HttpServletResponse</code>.</em> |
| <a class="jxr_linenumber" name="L509" href="#L509">509</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L510" href="#L510">510</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> HttpServletResponse toHttp(ServletResponse response) { |
| <a class="jxr_linenumber" name="L511" href="#L511">511</a> <strong class="jxr_keyword">return</strong> (HttpServletResponse) response; |
| <a class="jxr_linenumber" name="L512" href="#L512">512</a> } |
| <a class="jxr_linenumber" name="L513" href="#L513">513</a> |
| <a class="jxr_linenumber" name="L514" href="#L514">514</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L515" href="#L515">515</a> <em class="jxr_javadoccomment"> * Redirects the current request to a new URL based on the given parameters.</em> |
| <a class="jxr_linenumber" name="L516" href="#L516">516</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L517" href="#L517">517</a> <em class="jxr_javadoccomment"> * @param request the servlet request.</em> |
| <a class="jxr_linenumber" name="L518" href="#L518">518</a> <em class="jxr_javadoccomment"> * @param response the servlet response.</em> |
| <a class="jxr_linenumber" name="L519" href="#L519">519</a> <em class="jxr_javadoccomment"> * @param url the URL to redirect the user to.</em> |
| <a class="jxr_linenumber" name="L520" href="#L520">520</a> <em class="jxr_javadoccomment"> * @param queryParams a map of parameters that should be set as request parameters for the new request.</em> |
| <a class="jxr_linenumber" name="L521" href="#L521">521</a> <em class="jxr_javadoccomment"> * @param contextRelative true if the URL is relative to the servlet context path, or false if the URL is absolute.</em> |
| <a class="jxr_linenumber" name="L522" href="#L522">522</a> <em class="jxr_javadoccomment"> * @param http10Compatible whether to stay compatible with HTTP 1.0 clients.</em> |
| <a class="jxr_linenumber" name="L523" href="#L523">523</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException if thrown by response methods.</em> |
| <a class="jxr_linenumber" name="L524" href="#L524">524</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L525" href="#L525">525</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> issueRedirect(ServletRequest request, ServletResponse response, String url, Map queryParams, <strong class="jxr_keyword">boolean</strong> contextRelative, <strong class="jxr_keyword">boolean</strong> http10Compatible) <strong class="jxr_keyword">throws</strong> IOException { |
| <a class="jxr_linenumber" name="L526" href="#L526">526</a> <a name="RedirectView" href="../../../../../org/apache/shiro/<a name="RedirectView" href="../../../../../org/apache/shiro/web/util/RedirectView.html#RedirectView">RedirectView</a>irectView.html#RedirectView">RedirectView</a> view = <strong class="jxr_keyword">new</strong> <a name="RedirectView" href="../../../../../org/apache/shiro/web/util/RedirectView.html#RedirectView">RedirectView</a>(url, contextRelative, http10Compatible); |
| <a class="jxr_linenumber" name="L527" href="#L527">527</a> view.renderMergedOutputModel(queryParams, toHttp(request), toHttp(response)); |
| <a class="jxr_linenumber" name="L528" href="#L528">528</a> } |
| <a class="jxr_linenumber" name="L529" href="#L529">529</a> |
| <a class="jxr_linenumber" name="L530" href="#L530">530</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L531" href="#L531">531</a> <em class="jxr_javadoccomment"> * Redirects the current request to a new URL based on the given parameters and default values</em> |
| <a class="jxr_linenumber" name="L532" href="#L532">532</a> <em class="jxr_javadoccomment"> * for unspecified parameters.</em> |
| <a class="jxr_linenumber" name="L533" href="#L533">533</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L534" href="#L534">534</a> <em class="jxr_javadoccomment"> * @param request the servlet request.</em> |
| <a class="jxr_linenumber" name="L535" href="#L535">535</a> <em class="jxr_javadoccomment"> * @param response the servlet response.</em> |
| <a class="jxr_linenumber" name="L536" href="#L536">536</a> <em class="jxr_javadoccomment"> * @param url the URL to redirect the user to.</em> |
| <a class="jxr_linenumber" name="L537" href="#L537">537</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException if thrown by response methods.</em> |
| <a class="jxr_linenumber" name="L538" href="#L538">538</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L539" href="#L539">539</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> issueRedirect(ServletRequest request, ServletResponse response, String url) <strong class="jxr_keyword">throws</strong> IOException { |
| <a class="jxr_linenumber" name="L540" href="#L540">540</a> issueRedirect(request, response, url, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">true</strong>, <strong class="jxr_keyword">true</strong>); |
| <a class="jxr_linenumber" name="L541" href="#L541">541</a> } |
| <a class="jxr_linenumber" name="L542" href="#L542">542</a> |
| <a class="jxr_linenumber" name="L543" href="#L543">543</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L544" href="#L544">544</a> <em class="jxr_javadoccomment"> * Redirects the current request to a new URL based on the given parameters and default values</em> |
| <a class="jxr_linenumber" name="L545" href="#L545">545</a> <em class="jxr_javadoccomment"> * for unspecified parameters.</em> |
| <a class="jxr_linenumber" name="L546" href="#L546">546</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L547" href="#L547">547</a> <em class="jxr_javadoccomment"> * @param request the servlet request.</em> |
| <a class="jxr_linenumber" name="L548" href="#L548">548</a> <em class="jxr_javadoccomment"> * @param response the servlet response.</em> |
| <a class="jxr_linenumber" name="L549" href="#L549">549</a> <em class="jxr_javadoccomment"> * @param url the URL to redirect the user to.</em> |
| <a class="jxr_linenumber" name="L550" href="#L550">550</a> <em class="jxr_javadoccomment"> * @param queryParams a map of parameters that should be set as request parameters for the new request.</em> |
| <a class="jxr_linenumber" name="L551" href="#L551">551</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException if thrown by response methods.</em> |
| <a class="jxr_linenumber" name="L552" href="#L552">552</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L553" href="#L553">553</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> issueRedirect(ServletRequest request, ServletResponse response, String url, Map queryParams) <strong class="jxr_keyword">throws</strong> IOException { |
| <a class="jxr_linenumber" name="L554" href="#L554">554</a> issueRedirect(request, response, url, queryParams, <strong class="jxr_keyword">true</strong>, <strong class="jxr_keyword">true</strong>); |
| <a class="jxr_linenumber" name="L555" href="#L555">555</a> } |
| <a class="jxr_linenumber" name="L556" href="#L556">556</a> |
| <a class="jxr_linenumber" name="L557" href="#L557">557</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L558" href="#L558">558</a> <em class="jxr_javadoccomment"> * Redirects the current request to a new URL based on the given parameters and default values</em> |
| <a class="jxr_linenumber" name="L559" href="#L559">559</a> <em class="jxr_javadoccomment"> * for unspecified parameters.</em> |
| <a class="jxr_linenumber" name="L560" href="#L560">560</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L561" href="#L561">561</a> <em class="jxr_javadoccomment"> * @param request the servlet request.</em> |
| <a class="jxr_linenumber" name="L562" href="#L562">562</a> <em class="jxr_javadoccomment"> * @param response the servlet response.</em> |
| <a class="jxr_linenumber" name="L563" href="#L563">563</a> <em class="jxr_javadoccomment"> * @param url the URL to redirect the user to.</em> |
| <a class="jxr_linenumber" name="L564" href="#L564">564</a> <em class="jxr_javadoccomment"> * @param queryParams a map of parameters that should be set as request parameters for the new request.</em> |
| <a class="jxr_linenumber" name="L565" href="#L565">565</a> <em class="jxr_javadoccomment"> * @param contextRelative true if the URL is relative to the servlet context path, or false if the URL is absolute.</em> |
| <a class="jxr_linenumber" name="L566" href="#L566">566</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException if thrown by response methods.</em> |
| <a class="jxr_linenumber" name="L567" href="#L567">567</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L568" href="#L568">568</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> issueRedirect(ServletRequest request, ServletResponse response, String url, Map queryParams, <strong class="jxr_keyword">boolean</strong> contextRelative) <strong class="jxr_keyword">throws</strong> IOException { |
| <a class="jxr_linenumber" name="L569" href="#L569">569</a> issueRedirect(request, response, url, queryParams, contextRelative, <strong class="jxr_keyword">true</strong>); |
| <a class="jxr_linenumber" name="L570" href="#L570">570</a> } |
| <a class="jxr_linenumber" name="L571" href="#L571">571</a> |
| <a class="jxr_linenumber" name="L572" href="#L572">572</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L573" href="#L573">573</a> <em class="jxr_javadoccomment"> * <p>Checks to see if a request param is considered true using a loose matching strategy for</em> |
| <a class="jxr_linenumber" name="L574" href="#L574">574</a> <em class="jxr_javadoccomment"> * general values that indicate that something is true or enabled, etc.</p></em> |
| <a class="jxr_linenumber" name="L575" href="#L575">575</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L576" href="#L576">576</a> <em class="jxr_javadoccomment"> * <p>Values that are considered "true" include (case-insensitive): true, t, 1, enabled, y, yes, on.</p></em> |
| <a class="jxr_linenumber" name="L577" href="#L577">577</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L578" href="#L578">578</a> <em class="jxr_javadoccomment"> * @param request the servlet request</em> |
| <a class="jxr_linenumber" name="L579" href="#L579">579</a> <em class="jxr_javadoccomment"> * @param paramName @return true if the param value is considered true or false if it isn't.</em> |
| <a class="jxr_linenumber" name="L580" href="#L580">580</a> <em class="jxr_javadoccomment"> * @return true if the given parameter is considered "true" - false otherwise.</em> |
| <a class="jxr_linenumber" name="L581" href="#L581">581</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L582" href="#L582">582</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isTrue(ServletRequest request, String paramName) { |
| <a class="jxr_linenumber" name="L583" href="#L583">583</a> String value = getCleanParam(request, paramName); |
| <a class="jxr_linenumber" name="L584" href="#L584">584</a> <strong class="jxr_keyword">return</strong> value != <strong class="jxr_keyword">null</strong> && |
| <a class="jxr_linenumber" name="L585" href="#L585">585</a> (value.equalsIgnoreCase(<span class="jxr_string">"true"</span>) || |
| <a class="jxr_linenumber" name="L586" href="#L586">586</a> value.equalsIgnoreCase(<span class="jxr_string">"t"</span>) || |
| <a class="jxr_linenumber" name="L587" href="#L587">587</a> value.equalsIgnoreCase(<span class="jxr_string">"1"</span>) || |
| <a class="jxr_linenumber" name="L588" href="#L588">588</a> value.equalsIgnoreCase(<span class="jxr_string">"enabled"</span>) || |
| <a class="jxr_linenumber" name="L589" href="#L589">589</a> value.equalsIgnoreCase(<span class="jxr_string">"y"</span>) || |
| <a class="jxr_linenumber" name="L590" href="#L590">590</a> value.equalsIgnoreCase(<span class="jxr_string">"yes"</span>) || |
| <a class="jxr_linenumber" name="L591" href="#L591">591</a> value.equalsIgnoreCase(<span class="jxr_string">"on"</span>)); |
| <a class="jxr_linenumber" name="L592" href="#L592">592</a> } |
| <a class="jxr_linenumber" name="L593" href="#L593">593</a> |
| <a class="jxr_linenumber" name="L594" href="#L594">594</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L595" href="#L595">595</a> <em class="jxr_javadoccomment"> * Convenience method that returns a request parameter value, first running it through</em> |
| <a class="jxr_linenumber" name="L596" href="#L596">596</a> <em class="jxr_javadoccomment"> * {@link StringUtils#clean(String)}.</em> |
| <a class="jxr_linenumber" name="L597" href="#L597">597</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L598" href="#L598">598</a> <em class="jxr_javadoccomment"> * @param request the servlet request.</em> |
| <a class="jxr_linenumber" name="L599" href="#L599">599</a> <em class="jxr_javadoccomment"> * @param paramName the parameter name.</em> |
| <a class="jxr_linenumber" name="L600" href="#L600">600</a> <em class="jxr_javadoccomment"> * @return the clean param value, or null if the param does not exist or is empty.</em> |
| <a class="jxr_linenumber" name="L601" href="#L601">601</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L602" href="#L602">602</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String getCleanParam(ServletRequest request, String paramName) { |
| <a class="jxr_linenumber" name="L603" href="#L603">603</a> <strong class="jxr_keyword">return</strong> StringUtils.clean(request.getParameter(paramName)); |
| <a class="jxr_linenumber" name="L604" href="#L604">604</a> } |
| <a class="jxr_linenumber" name="L605" href="#L605">605</a> |
| <a class="jxr_linenumber" name="L606" href="#L606">606</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> saveRequest(ServletRequest request) { |
| <a class="jxr_linenumber" name="L607" href="#L607">607</a> Subject subject = SecurityUtils.getSubject(); |
| <a class="jxr_linenumber" name="L608" href="#L608">608</a> Session session = subject.getSession(); |
| <a class="jxr_linenumber" name="L609" href="#L609">609</a> HttpServletRequest httpRequest = toHttp(request); |
| <a class="jxr_linenumber" name="L610" href="#L610">610</a> <a name="SavedRequest" href="../../../../../org/apache/shiro/web/util<a name="SavedRequest" href="../../../../../org/apache/shiro/web/util/SavedRequest.html#SavedRequest">SavedRequest</a>t.html#SavedRequest">SavedRequest</a> savedRequest = <strong class="jxr_keyword">new</strong> <a name="SavedRequest" href="../../../../../org/apache/shiro/web/util/SavedRequest.html#SavedRequest">SavedRequest</a>(httpRequest); |
| <a class="jxr_linenumber" name="L611" href="#L611">611</a> session.setAttribute(SAVED_REQUEST_KEY, savedRequest); |
| <a class="jxr_linenumber" name="L612" href="#L612">612</a> } |
| <a class="jxr_linenumber" name="L613" href="#L613">613</a> |
| <a class="jxr_linenumber" name="L614" href="#L614">614</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a name="SavedRequest" href="../../../../../org/apache/shiro/web/util/SavedRequest.html#SavedRequest">SavedRequest</a> getAndClearSavedRequest(ServletRequest request) { |
| <a class="jxr_linenumber" name="L615" href="#L615">615</a> <a name="SavedRequest" href="../../../../../org/apache/shiro/web/util/SavedRequest.html#SavedRequest">SavedRequest</a> savedRequest = getSavedRequest(request); |
| <a class="jxr_linenumber" name="L616" href="#L616">616</a> <strong class="jxr_keyword">if</strong> (savedRequest != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L617" href="#L617">617</a> Subject subject = SecurityUtils.getSubject(); |
| <a class="jxr_linenumber" name="L618" href="#L618">618</a> Session session = subject.getSession(); |
| <a class="jxr_linenumber" name="L619" href="#L619">619</a> session.removeAttribute(SAVED_REQUEST_KEY); |
| <a class="jxr_linenumber" name="L620" href="#L620">620</a> } |
| <a class="jxr_linenumber" name="L621" href="#L621">621</a> <strong class="jxr_keyword">return</strong> savedRequest; |
| <a class="jxr_linenumber" name="L622" href="#L622">622</a> } |
| <a class="jxr_linenumber" name="L623" href="#L623">623</a> |
| <a class="jxr_linenumber" name="L624" href="#L624">624</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a name="SavedRequest" href="../../../../../org/apache/shiro/web/util/SavedRequest.html#SavedRequest">SavedRequest</a> getSavedRequest(ServletRequest request) { |
| <a class="jxr_linenumber" name="L625" href="#L625">625</a> <a name="SavedRequest" href="../../../../../org/apache/shiro/web/util/SavedRequest.html#SavedRequest">SavedRequest</a> savedRequest = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L626" href="#L626">626</a> Subject subject = SecurityUtils.getSubject(); |
| <a class="jxr_linenumber" name="L627" href="#L627">627</a> Session session = subject.getSession(false); |
| <a class="jxr_linenumber" name="L628" href="#L628">628</a> <strong class="jxr_keyword">if</strong> (session != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L629" href="#L629">629</a> savedRequest = (<a name="SavedRequest" href="../../../../../org/apache/shiro/web/util/SavedRequest.html#SavedRequest">SavedRequest</a>) session.getAttribute(SAVED_REQUEST_KEY); |
| <a class="jxr_linenumber" name="L630" href="#L630">630</a> } |
| <a class="jxr_linenumber" name="L631" href="#L631">631</a> <strong class="jxr_keyword">return</strong> savedRequest; |
| <a class="jxr_linenumber" name="L632" href="#L632">632</a> } |
| <a class="jxr_linenumber" name="L633" href="#L633">633</a> |
| <a class="jxr_linenumber" name="L634" href="#L634">634</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L635" href="#L635">635</a> <em class="jxr_javadoccomment"> * Redirects the to the request url from a previously</em> |
| <a class="jxr_linenumber" name="L636" href="#L636">636</a> <em class="jxr_javadoccomment"> * {@link #saveRequest(javax.servlet.ServletRequest) saved} request, or if there is no saved request, redirects the</em> |
| <a class="jxr_linenumber" name="L637" href="#L637">637</a> <em class="jxr_javadoccomment"> * end user to the specified {@code fallbackUrl}. If there is no saved request or fallback url, this method</em> |
| <a class="jxr_linenumber" name="L638" href="#L638">638</a> <em class="jxr_javadoccomment"> * throws an {@link IllegalStateException}.</em> |
| <a class="jxr_linenumber" name="L639" href="#L639">639</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L640" href="#L640">640</a> <em class="jxr_javadoccomment"> * This method is primarily used to support a common login scenario - if an unauthenticated user accesses a</em> |
| <a class="jxr_linenumber" name="L641" href="#L641">641</a> <em class="jxr_javadoccomment"> * page that requires authentication, it is expected that request is</em> |
| <a class="jxr_linenumber" name="L642" href="#L642">642</a> <em class="jxr_javadoccomment"> * {@link #saveRequest(javax.servlet.ServletRequest) saved} first and then redirected to the login page. Then,</em> |
| <a class="jxr_linenumber" name="L643" href="#L643">643</a> <em class="jxr_javadoccomment"> * after a successful login, this method can be called to redirect them back to their originally requested URL, a</em> |
| <a class="jxr_linenumber" name="L644" href="#L644">644</a> <em class="jxr_javadoccomment"> * nice usability feature.</em> |
| <a class="jxr_linenumber" name="L645" href="#L645">645</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L646" href="#L646">646</a> <em class="jxr_javadoccomment"> * @param request the incoming request</em> |
| <a class="jxr_linenumber" name="L647" href="#L647">647</a> <em class="jxr_javadoccomment"> * @param response the outgoing response</em> |
| <a class="jxr_linenumber" name="L648" href="#L648">648</a> <em class="jxr_javadoccomment"> * @param fallbackUrl the fallback url to redirect to if there is no saved request available.</em> |
| <a class="jxr_linenumber" name="L649" href="#L649">649</a> <em class="jxr_javadoccomment"> * @throws IllegalStateException if there is no saved request and the {@code fallbackUrl} is {@code null}.</em> |
| <a class="jxr_linenumber" name="L650" href="#L650">650</a> <em class="jxr_javadoccomment"> * @throws IOException if there is an error redirecting</em> |
| <a class="jxr_linenumber" name="L651" href="#L651">651</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a class="jxr_linenumber" name="L652" href="#L652">652</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L653" href="#L653">653</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> redirectToSavedRequest(ServletRequest request, ServletResponse response, String fallbackUrl) |
| <a class="jxr_linenumber" name="L654" href="#L654">654</a> <strong class="jxr_keyword">throws</strong> IOException { |
| <a class="jxr_linenumber" name="L655" href="#L655">655</a> String successUrl = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L656" href="#L656">656</a> <strong class="jxr_keyword">boolean</strong> contextRelative = <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="L657" href="#L657">657</a> <a name="SavedRequest" href="../../../../../org/apache/shiro/web/util/SavedRequest.html#SavedRequest">SavedRequest</a> savedRequest = WebUtils.getAndClearSavedRequest(request); |
| <a class="jxr_linenumber" name="L658" href="#L658">658</a> <strong class="jxr_keyword">if</strong> (savedRequest != <strong class="jxr_keyword">null</strong> && savedRequest.getMethod().equalsIgnoreCase(AccessControlFilter.GET_METHOD)) { |
| <a class="jxr_linenumber" name="L659" href="#L659">659</a> successUrl = savedRequest.getRequestUrl(); |
| <a class="jxr_linenumber" name="L660" href="#L660">660</a> contextRelative = false; |
| <a class="jxr_linenumber" name="L661" href="#L661">661</a> } |
| <a class="jxr_linenumber" name="L662" href="#L662">662</a> |
| <a class="jxr_linenumber" name="L663" href="#L663">663</a> <strong class="jxr_keyword">if</strong> (successUrl == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L664" href="#L664">664</a> successUrl = fallbackUrl; |
| <a class="jxr_linenumber" name="L665" href="#L665">665</a> } |
| <a class="jxr_linenumber" name="L666" href="#L666">666</a> |
| <a class="jxr_linenumber" name="L667" href="#L667">667</a> <strong class="jxr_keyword">if</strong> (successUrl == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L668" href="#L668">668</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"Success URL not available via saved request or via the "</span> + |
| <a class="jxr_linenumber" name="L669" href="#L669">669</a> <span class="jxr_string">"successUrlFallback method parameter. One of these must be non-null for "</span> + |
| <a class="jxr_linenumber" name="L670" href="#L670">670</a> <span class="jxr_string">"issueSuccessRedirect() to work."</span>); |
| <a class="jxr_linenumber" name="L671" href="#L671">671</a> } |
| <a class="jxr_linenumber" name="L672" href="#L672">672</a> |
| <a class="jxr_linenumber" name="L673" href="#L673">673</a> WebUtils.issueRedirect(request, response, successUrl, <strong class="jxr_keyword">null</strong>, contextRelative); |
| <a class="jxr_linenumber" name="L674" href="#L674">674</a> } |
| <a class="jxr_linenumber" name="L675" href="#L675">675</a> |
| <a class="jxr_linenumber" name="L676" href="#L676">676</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 2004–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
