Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.3.0 / xref / org / apache / shiro / web / servlet / ShiroHttpServletResponse.html
blob: 0bc74d65f45276a97db2e40bf8feca56e67babe3 [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=ISO-8859-1" />
<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 name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a> <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em>
<a name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.web.servlet;
<a name="20" href="#20">20</a>
<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletContext;
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponseWrapper;
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpSession;
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.net.MalformedURLException;
<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.net.URL;
<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.net.URLEncoder;
<a name="30" href="#30">30</a>
<a name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em>
<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * HttpServletResponse implementation to support URL Encoding of Shiro Session IDs.</em>
<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="34" href="#34">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 name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * Container session configuration, which is Shiro's default in a web environment). Because the servlet container</em>
<a name="36" href="#36">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 name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * native sessions.</em>
<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="39" href="#39">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 name="40" href="#40">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 name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * Apache 2.0 license, all regular licenses and conditions have remained in tact.</em>
<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> *</em>
<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @since 0.2</em>
<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> */</em>
<a name="45" href="#45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletResponse.html">ShiroHttpServletResponse</a> <strong class="jxr_keyword">extends</strong> HttpServletResponseWrapper {
<a name="46" href="#46">46</a>
<a name="47" href="#47">47</a> <em class="jxr_comment">//TODO - complete JavaDoc</em>
<a name="48" href="#48">48</a>
<a name="49" href="#49">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 name="50" href="#50">50</a>
<a name="51" href="#51">51</a> <strong class="jxr_keyword">private</strong> ServletContext context = <strong class="jxr_keyword">null</strong>;
<a name="52" href="#52">52</a> <em class="jxr_comment">//the associated request</em>
<a name="53" href="#53">53</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletRequest.html">ShiroHttpServletRequest</a> request = <strong class="jxr_keyword">null</strong>;
<a name="54" href="#54">54</a>
<a name="55" href="#55">55</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletResponse.html">ShiroHttpServletResponse</a>(HttpServletResponse wrapped, ServletContext context, <a href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletRequest.html">ShiroHttpServletRequest</a> request) {
<a name="56" href="#56">56</a> <strong class="jxr_keyword">super</strong>(wrapped);
<a name="57" href="#57">57</a> <strong class="jxr_keyword">this</strong>.context = context;
<a name="58" href="#58">58</a> <strong class="jxr_keyword">this</strong>.request = request;
<a name="59" href="#59">59</a> }
<a name="60" href="#60">60</a>
<a name="61" href="#61">61</a> @SuppressWarnings({<span class="jxr_string">"UnusedDeclaration"</span>})
<a name="62" href="#62">62</a> <strong class="jxr_keyword">public</strong> ServletContext getContext() {
<a name="63" href="#63">63</a> <strong class="jxr_keyword">return</strong> context;
<a name="64" href="#64">64</a> }
<a name="65" href="#65">65</a>
<a name="66" href="#66">66</a> @SuppressWarnings({<span class="jxr_string">"UnusedDeclaration"</span>})
<a name="67" href="#67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setContext(ServletContext context) {
<a name="68" href="#68">68</a> <strong class="jxr_keyword">this</strong>.context = context;
<a name="69" href="#69">69</a> }
<a name="70" href="#70">70</a>
<a name="71" href="#71">71</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletRequest.html">ShiroHttpServletRequest</a> getRequest() {
<a name="72" href="#72">72</a> <strong class="jxr_keyword">return</strong> request;
<a name="73" href="#73">73</a> }
<a name="74" href="#74">74</a>
<a name="75" href="#75">75</a> @SuppressWarnings({<span class="jxr_string">"UnusedDeclaration"</span>})
<a name="76" href="#76">76</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setRequest(<a href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletRequest.html">ShiroHttpServletRequest</a> request) {
<a name="77" href="#77">77</a> <strong class="jxr_keyword">this</strong>.request = request;
<a name="78" href="#78">78</a> }
<a name="79" href="#79">79</a>
<a name="80" href="#80">80</a> <em class="jxr_javadoccomment">/**</em>
<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * Encode the session identifier associated with this response</em>
<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * into the specified redirect URL, if necessary.</em>
<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> *</em>
<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * @param url URL to be encoded</em>
<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> */</em>
<a name="86" href="#86">86</a> <strong class="jxr_keyword">public</strong> String encodeRedirectURL(String url) {
<a name="87" href="#87">87</a> <strong class="jxr_keyword">if</strong> (isEncodeable(toAbsolute(url))) {
<a name="88" href="#88">88</a> <strong class="jxr_keyword">return</strong> toEncoded(url, request.getSession().getId());
<a name="89" href="#89">89</a> } <strong class="jxr_keyword">else</strong> {
<a name="90" href="#90">90</a> <strong class="jxr_keyword">return</strong> url;
<a name="91" href="#91">91</a> }
<a name="92" href="#92">92</a> }
<a name="93" href="#93">93</a>
<a name="94" href="#94">94</a>
<a name="95" href="#95">95</a> <strong class="jxr_keyword">public</strong> String encodeRedirectUrl(String s) {
<a name="96" href="#96">96</a> <strong class="jxr_keyword">return</strong> encodeRedirectURL(s);
<a name="97" href="#97">97</a> }
<a name="98" href="#98">98</a>
<a name="99" href="#99">99</a>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment">/**</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * Encode the session identifier associated with this response</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * into the specified URL, if necessary.</em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> *</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * @param url URL to be encoded</em>
<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> */</em>
<a name="106" href="#106">106</a> <strong class="jxr_keyword">public</strong> String encodeURL(String url) {
<a name="107" href="#107">107</a> String absolute = toAbsolute(url);
<a name="108" href="#108">108</a> <strong class="jxr_keyword">if</strong> (isEncodeable(absolute)) {
<a name="109" href="#109">109</a> <em class="jxr_comment">// W3c spec clearly said</em>
<a name="110" href="#110">110</a> <strong class="jxr_keyword">if</strong> (url.equalsIgnoreCase(<span class="jxr_string">""</span>)) {
<a name="111" href="#111">111</a> url = absolute;
<a name="112" href="#112">112</a> }
<a name="113" href="#113">113</a> <strong class="jxr_keyword">return</strong> toEncoded(url, request.getSession().getId());
<a name="114" href="#114">114</a> } <strong class="jxr_keyword">else</strong> {
<a name="115" href="#115">115</a> <strong class="jxr_keyword">return</strong> url;
<a name="116" href="#116">116</a> }
<a name="117" href="#117">117</a> }
<a name="118" href="#118">118</a>
<a name="119" href="#119">119</a> <strong class="jxr_keyword">public</strong> String encodeUrl(String s) {
<a name="120" href="#120">120</a> <strong class="jxr_keyword">return</strong> encodeURL(s);
<a name="121" href="#121">121</a> }
<a name="122" href="#122">122</a>
<a name="123" href="#123">123</a> <em class="jxr_javadoccomment">/**</em>
<a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * Return &lt;code&gt;true&lt;/code&gt; if the specified URL should be encoded with</em>
<a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * a session identifier. This will be true if all of the following</em>
<a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * conditions are met:</em>
<a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * &lt;ul&gt;</em>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * &lt;li&gt;The request we are responding to asked for a valid session</em>
<a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * &lt;li&gt;The requested session ID was not received via a cookie</em>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * &lt;li&gt;The specified URL points back to somewhere within the web</em>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * application that is responding to this request</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * &lt;/ul&gt;</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> *</em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * @param location Absolute URL to be validated</em>
<a name="135" href="#135">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 name="136" href="#136">136</a> <em class="jxr_javadoccomment"> */</em>
<a name="137" href="#137">137</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isEncodeable(<strong class="jxr_keyword">final</strong> String location) {
<a name="138" href="#138">138</a>
<a name="139" href="#139">139</a> <em class="jxr_comment">// First check if URL rewriting is disabled globally</em>
<a name="140" href="#140">140</a> <strong class="jxr_keyword">if</strong> (Boolean.FALSE.equals(request.getAttribute(ShiroHttpServletRequest.SESSION_ID_URL_REWRITING_ENABLED)))
<a name="141" href="#141">141</a> <strong class="jxr_keyword">return</strong> (false);
<a name="142" href="#142">142</a>
<a name="143" href="#143">143</a> <strong class="jxr_keyword">if</strong> (location == <strong class="jxr_keyword">null</strong>)
<a name="144" href="#144">144</a> <strong class="jxr_keyword">return</strong> (false);
<a name="145" href="#145">145</a>
<a name="146" href="#146">146</a> <em class="jxr_comment">// Is this an intra-document reference?</em>
<a name="147" href="#147">147</a> <strong class="jxr_keyword">if</strong> (location.startsWith(<span class="jxr_string">"#"</span>))
<a name="148" href="#148">148</a> <strong class="jxr_keyword">return</strong> (false);
<a name="149" href="#149">149</a>
<a name="150" href="#150">150</a> <em class="jxr_comment">// Are we in a valid session that is not using cookies?</em>
<a name="151" href="#151">151</a> <strong class="jxr_keyword">final</strong> HttpServletRequest hreq = request;
<a name="152" href="#152">152</a> <strong class="jxr_keyword">final</strong> HttpSession session = hreq.getSession(false);
<a name="153" href="#153">153</a> <strong class="jxr_keyword">if</strong> (session == <strong class="jxr_keyword">null</strong>)
<a name="154" href="#154">154</a> <strong class="jxr_keyword">return</strong> (false);
<a name="155" href="#155">155</a> <strong class="jxr_keyword">if</strong> (hreq.isRequestedSessionIdFromCookie())
<a name="156" href="#156">156</a> <strong class="jxr_keyword">return</strong> (false);
<a name="157" href="#157">157</a>
<a name="158" href="#158">158</a> <strong class="jxr_keyword">return</strong> doIsEncodeable(hreq, session, location);
<a name="159" href="#159">159</a> }
<a name="160" href="#160">160</a>
<a name="161" href="#161">161</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> doIsEncodeable(HttpServletRequest hreq, HttpSession session, String location) {
<a name="162" href="#162">162</a> <em class="jxr_comment">// Is this a valid absolute URL?</em>
<a name="163" href="#163">163</a> URL url;
<a name="164" href="#164">164</a> <strong class="jxr_keyword">try</strong> {
<a name="165" href="#165">165</a> url = <strong class="jxr_keyword">new</strong> URL(location);
<a name="166" href="#166">166</a> } <strong class="jxr_keyword">catch</strong> (MalformedURLException e) {
<a name="167" href="#167">167</a> <strong class="jxr_keyword">return</strong> (false);
<a name="168" href="#168">168</a> }
<a name="169" href="#169">169</a>
<a name="170" href="#170">170</a> <em class="jxr_comment">// Does this URL match down to (and including) the context path?</em>
<a name="171" href="#171">171</a> <strong class="jxr_keyword">if</strong> (!hreq.getScheme().equalsIgnoreCase(url.getProtocol()))
<a name="172" href="#172">172</a> <strong class="jxr_keyword">return</strong> (false);
<a name="173" href="#173">173</a> <strong class="jxr_keyword">if</strong> (!hreq.getServerName().equalsIgnoreCase(url.getHost()))
<a name="174" href="#174">174</a> <strong class="jxr_keyword">return</strong> (false);
<a name="175" href="#175">175</a> <strong class="jxr_keyword">int</strong> serverPort = hreq.getServerPort();
<a name="176" href="#176">176</a> <strong class="jxr_keyword">if</strong> (serverPort == -1) {
<a name="177" href="#177">177</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"https"</span>.equals(hreq.getScheme()))
<a name="178" href="#178">178</a> serverPort = 443;
<a name="179" href="#179">179</a> <strong class="jxr_keyword">else</strong>
<a name="180" href="#180">180</a> serverPort = 80;
<a name="181" href="#181">181</a> }
<a name="182" href="#182">182</a> <strong class="jxr_keyword">int</strong> urlPort = url.getPort();
<a name="183" href="#183">183</a> <strong class="jxr_keyword">if</strong> (urlPort == -1) {
<a name="184" href="#184">184</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"https"</span>.equals(url.getProtocol()))
<a name="185" href="#185">185</a> urlPort = 443;
<a name="186" href="#186">186</a> <strong class="jxr_keyword">else</strong>
<a name="187" href="#187">187</a> urlPort = 80;
<a name="188" href="#188">188</a> }
<a name="189" href="#189">189</a> <strong class="jxr_keyword">if</strong> (serverPort != urlPort)
<a name="190" href="#190">190</a> <strong class="jxr_keyword">return</strong> (false);
<a name="191" href="#191">191</a>
<a name="192" href="#192">192</a> String contextPath = getRequest().getContextPath();
<a name="193" href="#193">193</a> <strong class="jxr_keyword">if</strong> (contextPath != <strong class="jxr_keyword">null</strong>) {
<a name="194" href="#194">194</a> String file = url.getFile();
<a name="195" href="#195">195</a> <strong class="jxr_keyword">if</strong> ((file == <strong class="jxr_keyword">null</strong>) || !file.startsWith(contextPath))
<a name="196" href="#196">196</a> <strong class="jxr_keyword">return</strong> (false);
<a name="197" href="#197">197</a> String tok = <span class="jxr_string">";"</span> + DEFAULT_SESSION_ID_PARAMETER_NAME + <span class="jxr_string">"="</span> + session.getId();
<a name="198" href="#198">198</a> <strong class="jxr_keyword">if</strong> (file.indexOf(tok, contextPath.length()) &gt;= 0)
<a name="199" href="#199">199</a> <strong class="jxr_keyword">return</strong> (false);
<a name="200" href="#200">200</a> }
<a name="201" href="#201">201</a>
<a name="202" href="#202">202</a> <em class="jxr_comment">// This URL belongs to our web application, so it is encodeable</em>
<a name="203" href="#203">203</a> <strong class="jxr_keyword">return</strong> (<strong class="jxr_keyword">true</strong>);
<a name="204" href="#204">204</a>
<a name="205" href="#205">205</a> }
<a name="206" href="#206">206</a>
<a name="207" href="#207">207</a>
<a name="208" href="#208">208</a> <em class="jxr_javadoccomment">/**</em>
<a name="209" href="#209">209</a> <em class="jxr_javadoccomment"> * Convert (if necessary) and return the absolute URL that represents the</em>
<a name="210" href="#210">210</a> <em class="jxr_javadoccomment"> * resource referenced by this possibly relative URL. If this URL is</em>
<a name="211" href="#211">211</a> <em class="jxr_javadoccomment"> * already absolute, return it unchanged.</em>
<a name="212" href="#212">212</a> <em class="jxr_javadoccomment"> *</em>
<a name="213" href="#213">213</a> <em class="jxr_javadoccomment"> * @param location URL to be (possibly) converted and then returned</em>
<a name="214" href="#214">214</a> <em class="jxr_javadoccomment"> * @return resource location as an absolute url</em>
<a name="215" href="#215">215</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if a MalformedURLException is</em>
<a name="216" href="#216">216</a> <em class="jxr_javadoccomment"> * thrown when converting the relative URL to an absolute one</em>
<a name="217" href="#217">217</a> <em class="jxr_javadoccomment"> */</em>
<a name="218" href="#218">218</a> <strong class="jxr_keyword">private</strong> String toAbsolute(String location) {
<a name="219" href="#219">219</a>
<a name="220" href="#220">220</a> <strong class="jxr_keyword">if</strong> (location == <strong class="jxr_keyword">null</strong>)
<a name="221" href="#221">221</a> <strong class="jxr_keyword">return</strong> (location);
<a name="222" href="#222">222</a>
<a name="223" href="#223">223</a> <strong class="jxr_keyword">boolean</strong> leadingSlash = location.startsWith(<span class="jxr_string">"/"</span>);
<a name="224" href="#224">224</a>
<a name="225" href="#225">225</a> <strong class="jxr_keyword">if</strong> (leadingSlash || !hasScheme(location)) {
<a name="226" href="#226">226</a>
<a name="227" href="#227">227</a> StringBuilder buf = <strong class="jxr_keyword">new</strong> StringBuilder();
<a name="228" href="#228">228</a>
<a name="229" href="#229">229</a> String scheme = request.getScheme();
<a name="230" href="#230">230</a> String name = request.getServerName();
<a name="231" href="#231">231</a> <strong class="jxr_keyword">int</strong> port = request.getServerPort();
<a name="232" href="#232">232</a>
<a name="233" href="#233">233</a> <strong class="jxr_keyword">try</strong> {
<a name="234" href="#234">234</a> buf.append(scheme).append(<span class="jxr_string">"://"</span>).append(name);
<a name="235" href="#235">235</a> <strong class="jxr_keyword">if</strong> ((scheme.equals(<span class="jxr_string">"http"</span>) &amp;&amp; port != 80)
<a name="236" href="#236">236</a> || (scheme.equals(<span class="jxr_string">"https"</span>) &amp;&amp; port != 443)) {
<a name="237" href="#237">237</a> buf.append(':').append(port);
<a name="238" href="#238">238</a> }
<a name="239" href="#239">239</a> <strong class="jxr_keyword">if</strong> (!leadingSlash) {
<a name="240" href="#240">240</a> String relativePath = request.getRequestURI();
<a name="241" href="#241">241</a> <strong class="jxr_keyword">int</strong> pos = relativePath.lastIndexOf('/');
<a name="242" href="#242">242</a> relativePath = relativePath.substring(0, pos);
<a name="243" href="#243">243</a>
<a name="244" href="#244">244</a> String encodedURI = URLEncoder.encode(relativePath, getCharacterEncoding());
<a name="245" href="#245">245</a> buf.append(encodedURI).append('/');
<a name="246" href="#246">246</a> }
<a name="247" href="#247">247</a> buf.append(location);
<a name="248" href="#248">248</a> } <strong class="jxr_keyword">catch</strong> (IOException e) {
<a name="249" href="#249">249</a> IllegalArgumentException iae = <strong class="jxr_keyword">new</strong> IllegalArgumentException(location);
<a name="250" href="#250">250</a> iae.initCause(e);
<a name="251" href="#251">251</a> <strong class="jxr_keyword">throw</strong> iae;
<a name="252" href="#252">252</a> }
<a name="253" href="#253">253</a>
<a name="254" href="#254">254</a> <strong class="jxr_keyword">return</strong> buf.toString();
<a name="255" href="#255">255</a>
<a name="256" href="#256">256</a> } <strong class="jxr_keyword">else</strong> {
<a name="257" href="#257">257</a> <strong class="jxr_keyword">return</strong> location;
<a name="258" href="#258">258</a> }
<a name="259" href="#259">259</a> }
<a name="260" href="#260">260</a>
<a name="261" href="#261">261</a> <em class="jxr_javadoccomment">/**</em>
<a name="262" href="#262">262</a> <em class="jxr_javadoccomment"> * Determine if the character is allowed in the scheme of a URI.</em>
<a name="263" href="#263">263</a> <em class="jxr_javadoccomment"> * See RFC 2396, Section 3.1</em>
<a name="264" href="#264">264</a> <em class="jxr_javadoccomment"> *</em>
<a name="265" href="#265">265</a> <em class="jxr_javadoccomment"> * @param c the character to check</em>
<a name="266" href="#266">266</a> <em class="jxr_javadoccomment"> * @return {@code true} if the character is allowed in a URI scheme, {@code false} otherwise.</em>
<a name="267" href="#267">267</a> <em class="jxr_javadoccomment"> */</em>
<a name="268" href="#268">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 name="269" href="#269">269</a> <strong class="jxr_keyword">return</strong> Character.isLetterOrDigit(c) ||
<a name="270" href="#270">270</a> c == '+' || c == '-' || c == '.';
<a name="271" href="#271">271</a> }
<a name="272" href="#272">272</a>
<a name="273" href="#273">273</a>
<a name="274" href="#274">274</a> <em class="jxr_javadoccomment">/**</em>
<a name="275" href="#275">275</a> <em class="jxr_javadoccomment"> * Returns {@code true} if the URI string has a {@code scheme} component, {@code false} otherwise.</em>
<a name="276" href="#276">276</a> <em class="jxr_javadoccomment"> *</em>
<a name="277" href="#277">277</a> <em class="jxr_javadoccomment"> * @param uri the URI string to check for a scheme component</em>
<a name="278" href="#278">278</a> <em class="jxr_javadoccomment"> * @return {@code true} if the URI string has a {@code scheme} component, {@code false} otherwise.</em>
<a name="279" href="#279">279</a> <em class="jxr_javadoccomment"> */</em>
<a name="280" href="#280">280</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> hasScheme(String uri) {
<a name="281" href="#281">281</a> <strong class="jxr_keyword">int</strong> len = uri.length();
<a name="282" href="#282">282</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; len; i++) {
<a name="283" href="#283">283</a> <strong class="jxr_keyword">char</strong> c = uri.charAt(i);
<a name="284" href="#284">284</a> <strong class="jxr_keyword">if</strong> (c == ':') {
<a name="285" href="#285">285</a> <strong class="jxr_keyword">return</strong> i &gt; 0;
<a name="286" href="#286">286</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (!isSchemeChar(c)) {
<a name="287" href="#287">287</a> <strong class="jxr_keyword">return</strong> false;
<a name="288" href="#288">288</a> }
<a name="289" href="#289">289</a> }
<a name="290" href="#290">290</a> <strong class="jxr_keyword">return</strong> false;
<a name="291" href="#291">291</a> }
<a name="292" href="#292">292</a>
<a name="293" href="#293">293</a> <em class="jxr_javadoccomment">/**</em>
<a name="294" href="#294">294</a> <em class="jxr_javadoccomment"> * Return the specified URL with the specified session identifier suitably encoded.</em>
<a name="295" href="#295">295</a> <em class="jxr_javadoccomment"> *</em>
<a name="296" href="#296">296</a> <em class="jxr_javadoccomment"> * @param url URL to be encoded with the session id</em>
<a name="297" href="#297">297</a> <em class="jxr_javadoccomment"> * @param sessionId Session id to be included in the encoded URL</em>
<a name="298" href="#298">298</a> <em class="jxr_javadoccomment"> * @return the url with the session identifer properly encoded.</em>
<a name="299" href="#299">299</a> <em class="jxr_javadoccomment"> */</em>
<a name="300" href="#300">300</a> <strong class="jxr_keyword">protected</strong> String toEncoded(String url, String sessionId) {
<a name="301" href="#301">301</a>
<a name="302" href="#302">302</a> <strong class="jxr_keyword">if</strong> ((url == <strong class="jxr_keyword">null</strong>) || (sessionId == <strong class="jxr_keyword">null</strong>))
<a name="303" href="#303">303</a> <strong class="jxr_keyword">return</strong> (url);
<a name="304" href="#304">304</a>
<a name="305" href="#305">305</a> String path = url;
<a name="306" href="#306">306</a> String query = <span class="jxr_string">""</span>;
<a name="307" href="#307">307</a> String anchor = <span class="jxr_string">""</span>;
<a name="308" href="#308">308</a> <strong class="jxr_keyword">int</strong> question = url.indexOf('?');
<a name="309" href="#309">309</a> <strong class="jxr_keyword">if</strong> (question &gt;= 0) {
<a name="310" href="#310">310</a> path = url.substring(0, question);
<a name="311" href="#311">311</a> query = url.substring(question);
<a name="312" href="#312">312</a> }
<a name="313" href="#313">313</a> <strong class="jxr_keyword">int</strong> pound = path.indexOf('#');
<a name="314" href="#314">314</a> <strong class="jxr_keyword">if</strong> (pound &gt;= 0) {
<a name="315" href="#315">315</a> anchor = path.substring(pound);
<a name="316" href="#316">316</a> path = path.substring(0, pound);
<a name="317" href="#317">317</a> }
<a name="318" href="#318">318</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder(path);
<a name="319" href="#319">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 name="320" href="#320">320</a> sb.append(<span class="jxr_string">";"</span>);
<a name="321" href="#321">321</a> sb.append(DEFAULT_SESSION_ID_PARAMETER_NAME);
<a name="322" href="#322">322</a> sb.append(<span class="jxr_string">"="</span>);
<a name="323" href="#323">323</a> sb.append(sessionId);
<a name="324" href="#324">324</a> }
<a name="325" href="#325">325</a> sb.append(anchor);
<a name="326" href="#326">326</a> sb.append(query);
<a name="327" href="#327">327</a> <strong class="jxr_keyword">return</strong> (sb.toString());
<a name="328" href="#328">328</a>
<a name="329" href="#329">329</a> }
<a name="330" href="#330">330</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>