Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.10.1 / shiro-web / xref / org / apache / shiro / web / servlet / ShiroHttpServletResponse.html
blob: 15131f4c482bda8b6618fbaac1449772049d1bce [file] [log] [blame]
<!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>ShiroHttpServletResponse xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/web/servlet/ShiroHttpServletResponse.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.servlet;
<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> javax.servlet.ServletContext;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponseWrapper;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpSession;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.net.MalformedURLException;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.net.URL;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.net.URLEncoder;
<a class="jxr_linenumber" name="L30" href="#L30">30</a>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * HttpServletResponse implementation to support URL Encoding of Shiro Session IDs.</em>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * It is only used when using Shiro's native Session Management configuration (and not when using the Servlet</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * Container session configuration, which is Shiro's default in a web environment). Because the servlet container</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * already performs url encoding of its own session ids, instances of this class are only needed when using Shiro</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * native sessions.</em>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * Note that this implementation relies in part on source code from the Tomcat 6.x distribution for</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * encoding URLs for session ID URL Rewriting (we didn't want to re-invent the wheel). Since Shiro is also</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * Apache 2.0 license, all regular licenses and conditions have remained in tact.</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * @since 0.2</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="ShiroHttpServletResponse" href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletResponse.html#ShiroHttpServletResponse">ShiroHttpServletResponse</a> <strong class="jxr_keyword">extends</strong> HttpServletResponseWrapper {
<a class="jxr_linenumber" name="L46" href="#L46">46</a>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_comment">//TODO - complete JavaDoc</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_SESSION_ID_PARAMETER_NAME = ShiroHttpSession.DEFAULT_SESSION_ID_NAME;
<a class="jxr_linenumber" name="L50" href="#L50">50</a>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">private</strong> ServletContext context = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_comment">//the associated request</em>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">private</strong> <a name="ShiroHttpServletRequest" href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletRequest.html#ShiroHttpServletRequest">ShiroHttpServletRequest</a> request = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L54" href="#L54">54</a>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">public</strong> <a name="ShiroHttpServletResponse" href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletResponse.html#ShiroHttpServletResponse">ShiroHttpServletResponse</a>(HttpServletResponse wrapped, ServletContext context, <a name="ShiroHttpServletRequest" href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletRequest.html#ShiroHttpServletRequest">ShiroHttpServletRequest</a> request) {
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">super</strong>(wrapped);
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">this</strong>.context = context;
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">this</strong>.request = request;
<a class="jxr_linenumber" name="L59" href="#L59">59</a> }
<a class="jxr_linenumber" name="L60" href="#L60">60</a>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> @SuppressWarnings({<span class="jxr_string">"UnusedDeclaration"</span>})
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">public</strong> ServletContext getContext() {
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">return</strong> context;
<a class="jxr_linenumber" name="L64" href="#L64">64</a> }
<a class="jxr_linenumber" name="L65" href="#L65">65</a>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> @SuppressWarnings({<span class="jxr_string">"UnusedDeclaration"</span>})
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setContext(ServletContext context) {
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">this</strong>.context = context;
<a class="jxr_linenumber" name="L69" href="#L69">69</a> }
<a class="jxr_linenumber" name="L70" href="#L70">70</a>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">public</strong> <a name="ShiroHttpServletRequest" href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletRequest.html#ShiroHttpServletRequest">ShiroHttpServletRequest</a> getRequest() {
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">return</strong> request;
<a class="jxr_linenumber" name="L73" href="#L73">73</a> }
<a class="jxr_linenumber" name="L74" href="#L74">74</a>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> @SuppressWarnings({<span class="jxr_string">"UnusedDeclaration"</span>})
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setRequest(<a name="ShiroHttpServletRequest" href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletRequest.html#ShiroHttpServletRequest">ShiroHttpServletRequest</a> request) {
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">this</strong>.request = request;
<a class="jxr_linenumber" name="L78" href="#L78">78</a> }
<a class="jxr_linenumber" name="L79" href="#L79">79</a>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * Encode the session identifier associated with this response</em>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * into the specified redirect URL, if necessary.</em>
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * @param url URL to be encoded</em>
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">public</strong> String encodeRedirectURL(String url) {
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">if</strong> (isEncodeable(toAbsolute(url))) {
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">return</strong> toEncoded(url, request.getSession().getId());
<a class="jxr_linenumber" name="L89" href="#L89">89</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">return</strong> url;
<a class="jxr_linenumber" name="L91" href="#L91">91</a> }
<a class="jxr_linenumber" name="L92" href="#L92">92</a> }
<a class="jxr_linenumber" name="L93" href="#L93">93</a>
<a class="jxr_linenumber" name="L94" href="#L94">94</a>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">public</strong> String encodeRedirectUrl(String s) {
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">return</strong> encodeRedirectURL(s);
<a class="jxr_linenumber" name="L97" href="#L97">97</a> }
<a class="jxr_linenumber" name="L98" href="#L98">98</a>
<a class="jxr_linenumber" name="L99" href="#L99">99</a>
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * Encode the session identifier associated with this response</em>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * into the specified URL, if necessary.</em>
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * @param url URL to be encoded</em>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">public</strong> String encodeURL(String url) {
<a class="jxr_linenumber" name="L107" href="#L107">107</a> String absolute = toAbsolute(url);
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">if</strong> (isEncodeable(absolute)) {
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_comment">// W3c spec clearly said</em>
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">if</strong> (url.equalsIgnoreCase(<span class="jxr_string">""</span>)) {
<a class="jxr_linenumber" name="L111" href="#L111">111</a> url = absolute;
<a class="jxr_linenumber" name="L112" href="#L112">112</a> }
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">return</strong> toEncoded(url, request.getSession().getId());
<a class="jxr_linenumber" name="L114" href="#L114">114</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">return</strong> url;
<a class="jxr_linenumber" name="L116" href="#L116">116</a> }
<a class="jxr_linenumber" name="L117" href="#L117">117</a> }
<a class="jxr_linenumber" name="L118" href="#L118">118</a>
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">public</strong> String encodeUrl(String s) {
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">return</strong> encodeURL(s);
<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> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * Return &lt;code&gt;true&lt;/code&gt; if the specified URL should be encoded with</em>
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * a session identifier. This will be true if all of the following</em>
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * conditions are met:</em>
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * &lt;ul&gt;</em>
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * &lt;li&gt;The request we are responding to asked for a valid session</em>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * &lt;li&gt;The requested session ID was not received via a cookie</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * &lt;li&gt;The specified URL points back to somewhere within the web</em>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * application that is responding to this request</em>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * &lt;/ul&gt;</em>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * @param location Absolute URL to be validated</em>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * @return {@code true} if the specified URL should be encoded with a session identifier, {@code false} otherwise.</em>
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isEncodeable(<strong class="jxr_keyword">final</strong> String location) {
<a class="jxr_linenumber" name="L138" href="#L138">138</a>
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_comment">// First check if URL rewriting is disabled globally</em>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">if</strong> (Boolean.FALSE.equals(request.getAttribute(ShiroHttpServletRequest.SESSION_ID_URL_REWRITING_ENABLED)))
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">return</strong> (false);
<a class="jxr_linenumber" name="L142" href="#L142">142</a>
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">if</strong> (location == <strong class="jxr_keyword">null</strong>)
<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">return</strong> (false);
<a class="jxr_linenumber" name="L145" href="#L145">145</a>
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_comment">// Is this an intra-document reference?</em>
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">if</strong> (location.startsWith(<span class="jxr_string">"#"</span>))
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">return</strong> (false);
<a class="jxr_linenumber" name="L149" href="#L149">149</a>
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_comment">// Are we in a valid session that is not using cookies?</em>
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">final</strong> HttpServletRequest hreq = request;
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">final</strong> HttpSession session = hreq.getSession(false);
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">if</strong> (session == <strong class="jxr_keyword">null</strong>)
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">return</strong> (false);
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">if</strong> (hreq.isRequestedSessionIdFromCookie())
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">return</strong> (false);
<a class="jxr_linenumber" name="L157" href="#L157">157</a>
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">return</strong> doIsEncodeable(hreq, session, location);
<a class="jxr_linenumber" name="L159" href="#L159">159</a> }
<a class="jxr_linenumber" name="L160" href="#L160">160</a>
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> doIsEncodeable(HttpServletRequest hreq, HttpSession session, String location) {
<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_comment">// Is this a valid absolute URL?</em>
<a class="jxr_linenumber" name="L163" href="#L163">163</a> URL url;
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L165" href="#L165">165</a> url = <strong class="jxr_keyword">new</strong> URL(location);
<a class="jxr_linenumber" name="L166" href="#L166">166</a> } <strong class="jxr_keyword">catch</strong> (MalformedURLException e) {
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">return</strong> (false);
<a class="jxr_linenumber" name="L168" href="#L168">168</a> }
<a class="jxr_linenumber" name="L169" href="#L169">169</a>
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_comment">// Does this URL match down to (and including) the context path?</em>
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">if</strong> (!hreq.getScheme().equalsIgnoreCase(url.getProtocol()))
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">return</strong> (false);
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">if</strong> (!hreq.getServerName().equalsIgnoreCase(url.getHost()))
<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">return</strong> (false);
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">int</strong> serverPort = hreq.getServerPort();
<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">if</strong> (serverPort == -1) {
<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"https"</span>.equals(hreq.getScheme()))
<a class="jxr_linenumber" name="L178" href="#L178">178</a> serverPort = 443;
<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="L180" href="#L180">180</a> serverPort = 80;
<a class="jxr_linenumber" name="L181" href="#L181">181</a> }
<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">int</strong> urlPort = url.getPort();
<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">if</strong> (urlPort == -1) {
<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"https"</span>.equals(url.getProtocol()))
<a class="jxr_linenumber" name="L185" href="#L185">185</a> urlPort = 443;
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="L187" href="#L187">187</a> urlPort = 80;
<a class="jxr_linenumber" name="L188" href="#L188">188</a> }
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">if</strong> (serverPort != urlPort)
<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">return</strong> (false);
<a class="jxr_linenumber" name="L191" href="#L191">191</a>
<a class="jxr_linenumber" name="L192" href="#L192">192</a> String contextPath = getRequest().getContextPath();
<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">if</strong> (contextPath != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L194" href="#L194">194</a> String file = url.getFile();
<a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">if</strong> ((file == <strong class="jxr_keyword">null</strong>) || !file.startsWith(contextPath))
<a class="jxr_linenumber" name="L196" href="#L196">196</a> <strong class="jxr_keyword">return</strong> (false);
<a class="jxr_linenumber" name="L197" href="#L197">197</a> String tok = <span class="jxr_string">";"</span> + DEFAULT_SESSION_ID_PARAMETER_NAME + <span class="jxr_string">"="</span> + session.getId();
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">if</strong> (file.indexOf(tok, contextPath.length()) &gt;= 0)
<a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">return</strong> (false);
<a class="jxr_linenumber" name="L200" href="#L200">200</a> }
<a class="jxr_linenumber" name="L201" href="#L201">201</a>
<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_comment">// This URL belongs to our web application, so it is encodeable</em>
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">return</strong> (<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="L204" href="#L204">204</a>
<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>
<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> * Convert (if necessary) and return the absolute URL that represents the</em>
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> * resource referenced by this possibly relative URL. If this URL is</em>
<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> * already absolute, return it unchanged.</em>
<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> * @param location URL to be (possibly) converted and then returned</em>
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> * @return resource location as an absolute url</em>
<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if a MalformedURLException is</em>
<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * thrown when converting the relative URL to an absolute one</em>
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">private</strong> String toAbsolute(String location) {
<a class="jxr_linenumber" name="L219" href="#L219">219</a>
<a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong class="jxr_keyword">if</strong> (location == <strong class="jxr_keyword">null</strong>)
<a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">return</strong> (location);
<a class="jxr_linenumber" name="L222" href="#L222">222</a>
<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">boolean</strong> leadingSlash = location.startsWith(<span class="jxr_string">"/"</span>);
<a class="jxr_linenumber" name="L224" href="#L224">224</a>
<a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">if</strong> (leadingSlash || !hasScheme(location)) {
<a class="jxr_linenumber" name="L226" href="#L226">226</a>
<a class="jxr_linenumber" name="L227" href="#L227">227</a> StringBuilder buf = <strong class="jxr_keyword">new</strong> StringBuilder();
<a class="jxr_linenumber" name="L228" href="#L228">228</a>
<a class="jxr_linenumber" name="L229" href="#L229">229</a> String scheme = request.getScheme();
<a class="jxr_linenumber" name="L230" href="#L230">230</a> String name = request.getServerName();
<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">int</strong> port = request.getServerPort();
<a class="jxr_linenumber" name="L232" href="#L232">232</a>
<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L234" href="#L234">234</a> buf.append(scheme).append(<span class="jxr_string">"://"</span>).append(name);
<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">if</strong> ((scheme.equals(<span class="jxr_string">"http"</span>) &amp;&amp; port != 80)
<a class="jxr_linenumber" name="L236" href="#L236">236</a> || (scheme.equals(<span class="jxr_string">"https"</span>) &amp;&amp; port != 443)) {
<a class="jxr_linenumber" name="L237" href="#L237">237</a> buf.append(':').append(port);
<a class="jxr_linenumber" name="L238" href="#L238">238</a> }
<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">if</strong> (!leadingSlash) {
<a class="jxr_linenumber" name="L240" href="#L240">240</a> String relativePath = request.getRequestURI();
<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">int</strong> pos = relativePath.lastIndexOf('/');
<a class="jxr_linenumber" name="L242" href="#L242">242</a> relativePath = relativePath.substring(0, pos);
<a class="jxr_linenumber" name="L243" href="#L243">243</a>
<a class="jxr_linenumber" name="L244" href="#L244">244</a> String encodedURI = URLEncoder.encode(relativePath, getCharacterEncoding());
<a class="jxr_linenumber" name="L245" href="#L245">245</a> buf.append(encodedURI).append('/');
<a class="jxr_linenumber" name="L246" href="#L246">246</a> }
<a class="jxr_linenumber" name="L247" href="#L247">247</a> buf.append(location);
<a class="jxr_linenumber" name="L248" href="#L248">248</a> } <strong class="jxr_keyword">catch</strong> (IOException e) {
<a class="jxr_linenumber" name="L249" href="#L249">249</a> IllegalArgumentException iae = <strong class="jxr_keyword">new</strong> IllegalArgumentException(location);
<a class="jxr_linenumber" name="L250" href="#L250">250</a> iae.initCause(e);
<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">throw</strong> iae;
<a class="jxr_linenumber" name="L252" href="#L252">252</a> }
<a class="jxr_linenumber" name="L253" href="#L253">253</a>
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">return</strong> buf.toString();
<a class="jxr_linenumber" name="L255" href="#L255">255</a>
<a class="jxr_linenumber" name="L256" href="#L256">256</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L257" href="#L257">257</a> <strong class="jxr_keyword">return</strong> location;
<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>
<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_javadoccomment"> * Determine if the character is allowed in the scheme of a URI.</em>
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> * See RFC 2396, Section 3.1</em>
<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> * @param c the character to check</em>
<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> * @return {@code true} if the character is allowed in a URI scheme, {@code false} otherwise.</em>
<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isSchemeChar(<strong class="jxr_keyword">char</strong> c) {
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong class="jxr_keyword">return</strong> Character.isLetterOrDigit(c) ||
<a class="jxr_linenumber" name="L270" href="#L270">270</a> c == '+' || c == '-' || c == '.';
<a class="jxr_linenumber" name="L271" href="#L271">271</a> }
<a class="jxr_linenumber" name="L272" href="#L272">272</a>
<a class="jxr_linenumber" name="L273" href="#L273">273</a>
<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_javadoccomment"> * Returns {@code true} if the URI string has a {@code scheme} component, {@code false} otherwise.</em>
<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_javadoccomment"> * @param uri the URI string to check for a scheme component</em>
<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_javadoccomment"> * @return {@code true} if the URI string has a {@code scheme} component, {@code false} otherwise.</em>
<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L280" href="#L280">280</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> hasScheme(String uri) {
<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">int</strong> len = uri.length();
<a class="jxr_linenumber" name="L282" href="#L282">282</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; len; i++) {
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">char</strong> c = uri.charAt(i);
<a class="jxr_linenumber" name="L284" href="#L284">284</a> <strong class="jxr_keyword">if</strong> (c == ':') {
<a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong class="jxr_keyword">return</strong> i &gt; 0;
<a class="jxr_linenumber" name="L286" href="#L286">286</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (!isSchemeChar(c)) {
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="L288" href="#L288">288</a> }
<a class="jxr_linenumber" name="L289" href="#L289">289</a> }
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="L291" href="#L291">291</a> }
<a class="jxr_linenumber" name="L292" href="#L292">292</a>
<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_javadoccomment"> * Return the specified URL with the specified session identifier suitably encoded.</em>
<a class="jxr_linenumber" name="L295" href="#L295">295</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment"> * @param url URL to be encoded with the session id</em>
<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment"> * @param sessionId Session id to be included in the encoded URL</em>
<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment"> * @return the url with the session identifer properly encoded.</em>
<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> <strong class="jxr_keyword">protected</strong> String toEncoded(String url, String sessionId) {
<a class="jxr_linenumber" name="L301" href="#L301">301</a>
<a class="jxr_linenumber" name="L302" href="#L302">302</a> <strong class="jxr_keyword">if</strong> ((url == <strong class="jxr_keyword">null</strong>) || (sessionId == <strong class="jxr_keyword">null</strong>))
<a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong class="jxr_keyword">return</strong> (url);
<a class="jxr_linenumber" name="L304" href="#L304">304</a>
<a class="jxr_linenumber" name="L305" href="#L305">305</a> String path = url;
<a class="jxr_linenumber" name="L306" href="#L306">306</a> String query = <span class="jxr_string">""</span>;
<a class="jxr_linenumber" name="L307" href="#L307">307</a> String anchor = <span class="jxr_string">""</span>;
<a class="jxr_linenumber" name="L308" href="#L308">308</a> <strong class="jxr_keyword">int</strong> question = url.indexOf('?');
<a class="jxr_linenumber" name="L309" href="#L309">309</a> <strong class="jxr_keyword">if</strong> (question &gt;= 0) {
<a class="jxr_linenumber" name="L310" href="#L310">310</a> path = url.substring(0, question);
<a class="jxr_linenumber" name="L311" href="#L311">311</a> query = url.substring(question);
<a class="jxr_linenumber" name="L312" href="#L312">312</a> }
<a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong class="jxr_keyword">int</strong> pound = path.indexOf('#');
<a class="jxr_linenumber" name="L314" href="#L314">314</a> <strong class="jxr_keyword">if</strong> (pound &gt;= 0) {
<a class="jxr_linenumber" name="L315" href="#L315">315</a> anchor = path.substring(pound);
<a class="jxr_linenumber" name="L316" href="#L316">316</a> path = path.substring(0, pound);
<a class="jxr_linenumber" name="L317" href="#L317">317</a> }
<a class="jxr_linenumber" name="L318" href="#L318">318</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder(path);
<a class="jxr_linenumber" name="L319" href="#L319">319</a> <strong class="jxr_keyword">if</strong> (sb.length() &gt; 0) { <em class="jxr_comment">// session id param can't be first.</em>
<a class="jxr_linenumber" name="L320" href="#L320">320</a> sb.append(<span class="jxr_string">";"</span>);
<a class="jxr_linenumber" name="L321" href="#L321">321</a> sb.append(DEFAULT_SESSION_ID_PARAMETER_NAME);
<a class="jxr_linenumber" name="L322" href="#L322">322</a> sb.append(<span class="jxr_string">"="</span>);
<a class="jxr_linenumber" name="L323" href="#L323">323</a> sb.append(sessionId);
<a class="jxr_linenumber" name="L324" href="#L324">324</a> }
<a class="jxr_linenumber" name="L325" href="#L325">325</a> sb.append(anchor);
<a class="jxr_linenumber" name="L326" href="#L326">326</a> sb.append(query);
<a class="jxr_linenumber" name="L327" href="#L327">327</a> <strong class="jxr_keyword">return</strong> (sb.toString());
<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> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>