blob: e64a76c8d8ade603be41e1be3e9dda3d22e6fd8d [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a>
<span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">009</span><a id="line.9"> *</a>
<span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">011</span><a id="line.11"> *</a>
<span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a>
<span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a>
<span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a>
<span class="sourceLineNo">018</span><a id="line.18"> */</a>
<span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.web.servlet;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import javax.servlet.ServletContext;</a>
<span class="sourceLineNo">022</span><a id="line.22">import javax.servlet.http.HttpServletRequest;</a>
<span class="sourceLineNo">023</span><a id="line.23">import javax.servlet.http.HttpServletResponse;</a>
<span class="sourceLineNo">024</span><a id="line.24">import javax.servlet.http.HttpServletResponseWrapper;</a>
<span class="sourceLineNo">025</span><a id="line.25">import javax.servlet.http.HttpSession;</a>
<span class="sourceLineNo">026</span><a id="line.26">import java.io.IOException;</a>
<span class="sourceLineNo">027</span><a id="line.27">import java.net.MalformedURLException;</a>
<span class="sourceLineNo">028</span><a id="line.28">import java.net.URL;</a>
<span class="sourceLineNo">029</span><a id="line.29">import java.net.URLEncoder;</a>
<span class="sourceLineNo">030</span><a id="line.30"></a>
<span class="sourceLineNo">031</span><a id="line.31">/**</a>
<span class="sourceLineNo">032</span><a id="line.32"> * HttpServletResponse implementation to support URL Encoding of Shiro Session IDs.</a>
<span class="sourceLineNo">033</span><a id="line.33"> * &lt;p/&gt;</a>
<span class="sourceLineNo">034</span><a id="line.34"> * It is only used when using Shiro's native Session Management configuration (and not when using the Servlet</a>
<span class="sourceLineNo">035</span><a id="line.35"> * Container session configuration, which is Shiro's default in a web environment). Because the servlet container</a>
<span class="sourceLineNo">036</span><a id="line.36"> * already performs url encoding of its own session ids, instances of this class are only needed when using Shiro</a>
<span class="sourceLineNo">037</span><a id="line.37"> * native sessions.</a>
<span class="sourceLineNo">038</span><a id="line.38"> * &lt;p/&gt;</a>
<span class="sourceLineNo">039</span><a id="line.39"> * Note that this implementation relies in part on source code from the Tomcat 6.x distribution for</a>
<span class="sourceLineNo">040</span><a id="line.40"> * encoding URLs for session ID URL Rewriting (we didn't want to re-invent the wheel). Since Shiro is also</a>
<span class="sourceLineNo">041</span><a id="line.41"> * Apache 2.0 license, all regular licenses and conditions have remained in tact.</a>
<span class="sourceLineNo">042</span><a id="line.42"> *</a>
<span class="sourceLineNo">043</span><a id="line.43"> * @since 0.2</a>
<span class="sourceLineNo">044</span><a id="line.44"> */</a>
<span class="sourceLineNo">045</span><a id="line.45">public class ShiroHttpServletResponse extends HttpServletResponseWrapper {</a>
<span class="sourceLineNo">046</span><a id="line.46"></a>
<span class="sourceLineNo">047</span><a id="line.47"> //TODO - complete JavaDoc</a>
<span class="sourceLineNo">048</span><a id="line.48"></a>
<span class="sourceLineNo">049</span><a id="line.49"> private static final String DEFAULT_SESSION_ID_PARAMETER_NAME = ShiroHttpSession.DEFAULT_SESSION_ID_NAME;</a>
<span class="sourceLineNo">050</span><a id="line.50"></a>
<span class="sourceLineNo">051</span><a id="line.51"> private ServletContext context = null;</a>
<span class="sourceLineNo">052</span><a id="line.52"> //the associated request</a>
<span class="sourceLineNo">053</span><a id="line.53"> private ShiroHttpServletRequest request = null;</a>
<span class="sourceLineNo">054</span><a id="line.54"></a>
<span class="sourceLineNo">055</span><a id="line.55"> public ShiroHttpServletResponse(HttpServletResponse wrapped, ServletContext context, ShiroHttpServletRequest request) {</a>
<span class="sourceLineNo">056</span><a id="line.56"> super(wrapped);</a>
<span class="sourceLineNo">057</span><a id="line.57"> this.context = context;</a>
<span class="sourceLineNo">058</span><a id="line.58"> this.request = request;</a>
<span class="sourceLineNo">059</span><a id="line.59"> }</a>
<span class="sourceLineNo">060</span><a id="line.60"></a>
<span class="sourceLineNo">061</span><a id="line.61"> @SuppressWarnings({"UnusedDeclaration"})</a>
<span class="sourceLineNo">062</span><a id="line.62"> public ServletContext getContext() {</a>
<span class="sourceLineNo">063</span><a id="line.63"> return context;</a>
<span class="sourceLineNo">064</span><a id="line.64"> }</a>
<span class="sourceLineNo">065</span><a id="line.65"></a>
<span class="sourceLineNo">066</span><a id="line.66"> @SuppressWarnings({"UnusedDeclaration"})</a>
<span class="sourceLineNo">067</span><a id="line.67"> public void setContext(ServletContext context) {</a>
<span class="sourceLineNo">068</span><a id="line.68"> this.context = context;</a>
<span class="sourceLineNo">069</span><a id="line.69"> }</a>
<span class="sourceLineNo">070</span><a id="line.70"></a>
<span class="sourceLineNo">071</span><a id="line.71"> public ShiroHttpServletRequest getRequest() {</a>
<span class="sourceLineNo">072</span><a id="line.72"> return request;</a>
<span class="sourceLineNo">073</span><a id="line.73"> }</a>
<span class="sourceLineNo">074</span><a id="line.74"></a>
<span class="sourceLineNo">075</span><a id="line.75"> @SuppressWarnings({"UnusedDeclaration"})</a>
<span class="sourceLineNo">076</span><a id="line.76"> public void setRequest(ShiroHttpServletRequest request) {</a>
<span class="sourceLineNo">077</span><a id="line.77"> this.request = request;</a>
<span class="sourceLineNo">078</span><a id="line.78"> }</a>
<span class="sourceLineNo">079</span><a id="line.79"></a>
<span class="sourceLineNo">080</span><a id="line.80"> /**</a>
<span class="sourceLineNo">081</span><a id="line.81"> * Encode the session identifier associated with this response</a>
<span class="sourceLineNo">082</span><a id="line.82"> * into the specified redirect URL, if necessary.</a>
<span class="sourceLineNo">083</span><a id="line.83"> *</a>
<span class="sourceLineNo">084</span><a id="line.84"> * @param url URL to be encoded</a>
<span class="sourceLineNo">085</span><a id="line.85"> */</a>
<span class="sourceLineNo">086</span><a id="line.86"> public String encodeRedirectURL(String url) {</a>
<span class="sourceLineNo">087</span><a id="line.87"> if (isEncodeable(toAbsolute(url))) {</a>
<span class="sourceLineNo">088</span><a id="line.88"> return toEncoded(url, request.getSession().getId());</a>
<span class="sourceLineNo">089</span><a id="line.89"> } else {</a>
<span class="sourceLineNo">090</span><a id="line.90"> return url;</a>
<span class="sourceLineNo">091</span><a id="line.91"> }</a>
<span class="sourceLineNo">092</span><a id="line.92"> }</a>
<span class="sourceLineNo">093</span><a id="line.93"></a>
<span class="sourceLineNo">094</span><a id="line.94"></a>
<span class="sourceLineNo">095</span><a id="line.95"> public String encodeRedirectUrl(String s) {</a>
<span class="sourceLineNo">096</span><a id="line.96"> return encodeRedirectURL(s);</a>
<span class="sourceLineNo">097</span><a id="line.97"> }</a>
<span class="sourceLineNo">098</span><a id="line.98"></a>
<span class="sourceLineNo">099</span><a id="line.99"></a>
<span class="sourceLineNo">100</span><a id="line.100"> /**</a>
<span class="sourceLineNo">101</span><a id="line.101"> * Encode the session identifier associated with this response</a>
<span class="sourceLineNo">102</span><a id="line.102"> * into the specified URL, if necessary.</a>
<span class="sourceLineNo">103</span><a id="line.103"> *</a>
<span class="sourceLineNo">104</span><a id="line.104"> * @param url URL to be encoded</a>
<span class="sourceLineNo">105</span><a id="line.105"> */</a>
<span class="sourceLineNo">106</span><a id="line.106"> public String encodeURL(String url) {</a>
<span class="sourceLineNo">107</span><a id="line.107"> String absolute = toAbsolute(url);</a>
<span class="sourceLineNo">108</span><a id="line.108"> if (isEncodeable(absolute)) {</a>
<span class="sourceLineNo">109</span><a id="line.109"> // W3c spec clearly said</a>
<span class="sourceLineNo">110</span><a id="line.110"> if (url.equalsIgnoreCase("")) {</a>
<span class="sourceLineNo">111</span><a id="line.111"> url = absolute;</a>
<span class="sourceLineNo">112</span><a id="line.112"> }</a>
<span class="sourceLineNo">113</span><a id="line.113"> return toEncoded(url, request.getSession().getId());</a>
<span class="sourceLineNo">114</span><a id="line.114"> } else {</a>
<span class="sourceLineNo">115</span><a id="line.115"> return url;</a>
<span class="sourceLineNo">116</span><a id="line.116"> }</a>
<span class="sourceLineNo">117</span><a id="line.117"> }</a>
<span class="sourceLineNo">118</span><a id="line.118"></a>
<span class="sourceLineNo">119</span><a id="line.119"> public String encodeUrl(String s) {</a>
<span class="sourceLineNo">120</span><a id="line.120"> return encodeURL(s);</a>
<span class="sourceLineNo">121</span><a id="line.121"> }</a>
<span class="sourceLineNo">122</span><a id="line.122"></a>
<span class="sourceLineNo">123</span><a id="line.123"> /**</a>
<span class="sourceLineNo">124</span><a id="line.124"> * Return &lt;code&gt;true&lt;/code&gt; if the specified URL should be encoded with</a>
<span class="sourceLineNo">125</span><a id="line.125"> * a session identifier. This will be true if all of the following</a>
<span class="sourceLineNo">126</span><a id="line.126"> * conditions are met:</a>
<span class="sourceLineNo">127</span><a id="line.127"> * &lt;ul&gt;</a>
<span class="sourceLineNo">128</span><a id="line.128"> * &lt;li&gt;The request we are responding to asked for a valid session</a>
<span class="sourceLineNo">129</span><a id="line.129"> * &lt;li&gt;The requested session ID was not received via a cookie</a>
<span class="sourceLineNo">130</span><a id="line.130"> * &lt;li&gt;The specified URL points back to somewhere within the web</a>
<span class="sourceLineNo">131</span><a id="line.131"> * application that is responding to this request</a>
<span class="sourceLineNo">132</span><a id="line.132"> * &lt;/ul&gt;</a>
<span class="sourceLineNo">133</span><a id="line.133"> *</a>
<span class="sourceLineNo">134</span><a id="line.134"> * @param location Absolute URL to be validated</a>
<span class="sourceLineNo">135</span><a id="line.135"> * @return {@code true} if the specified URL should be encoded with a session identifier, {@code false} otherwise.</a>
<span class="sourceLineNo">136</span><a id="line.136"> */</a>
<span class="sourceLineNo">137</span><a id="line.137"> protected boolean isEncodeable(final String location) {</a>
<span class="sourceLineNo">138</span><a id="line.138"></a>
<span class="sourceLineNo">139</span><a id="line.139"> // First check if URL rewriting is disabled globally</a>
<span class="sourceLineNo">140</span><a id="line.140"> if (Boolean.FALSE.equals(request.getAttribute(ShiroHttpServletRequest.SESSION_ID_URL_REWRITING_ENABLED)))</a>
<span class="sourceLineNo">141</span><a id="line.141"> return (false);</a>
<span class="sourceLineNo">142</span><a id="line.142"></a>
<span class="sourceLineNo">143</span><a id="line.143"> if (location == null)</a>
<span class="sourceLineNo">144</span><a id="line.144"> return (false);</a>
<span class="sourceLineNo">145</span><a id="line.145"></a>
<span class="sourceLineNo">146</span><a id="line.146"> // Is this an intra-document reference?</a>
<span class="sourceLineNo">147</span><a id="line.147"> if (location.startsWith("#"))</a>
<span class="sourceLineNo">148</span><a id="line.148"> return (false);</a>
<span class="sourceLineNo">149</span><a id="line.149"></a>
<span class="sourceLineNo">150</span><a id="line.150"> // Are we in a valid session that is not using cookies?</a>
<span class="sourceLineNo">151</span><a id="line.151"> final HttpServletRequest hreq = request;</a>
<span class="sourceLineNo">152</span><a id="line.152"> final HttpSession session = hreq.getSession(false);</a>
<span class="sourceLineNo">153</span><a id="line.153"> if (session == null)</a>
<span class="sourceLineNo">154</span><a id="line.154"> return (false);</a>
<span class="sourceLineNo">155</span><a id="line.155"> if (hreq.isRequestedSessionIdFromCookie())</a>
<span class="sourceLineNo">156</span><a id="line.156"> return (false);</a>
<span class="sourceLineNo">157</span><a id="line.157"></a>
<span class="sourceLineNo">158</span><a id="line.158"> return doIsEncodeable(hreq, session, location);</a>
<span class="sourceLineNo">159</span><a id="line.159"> }</a>
<span class="sourceLineNo">160</span><a id="line.160"></a>
<span class="sourceLineNo">161</span><a id="line.161"> private boolean doIsEncodeable(HttpServletRequest hreq, HttpSession session, String location) {</a>
<span class="sourceLineNo">162</span><a id="line.162"> // Is this a valid absolute URL?</a>
<span class="sourceLineNo">163</span><a id="line.163"> URL url;</a>
<span class="sourceLineNo">164</span><a id="line.164"> try {</a>
<span class="sourceLineNo">165</span><a id="line.165"> url = new URL(location);</a>
<span class="sourceLineNo">166</span><a id="line.166"> } catch (MalformedURLException e) {</a>
<span class="sourceLineNo">167</span><a id="line.167"> return (false);</a>
<span class="sourceLineNo">168</span><a id="line.168"> }</a>
<span class="sourceLineNo">169</span><a id="line.169"></a>
<span class="sourceLineNo">170</span><a id="line.170"> // Does this URL match down to (and including) the context path?</a>
<span class="sourceLineNo">171</span><a id="line.171"> if (!hreq.getScheme().equalsIgnoreCase(url.getProtocol()))</a>
<span class="sourceLineNo">172</span><a id="line.172"> return (false);</a>
<span class="sourceLineNo">173</span><a id="line.173"> if (!hreq.getServerName().equalsIgnoreCase(url.getHost()))</a>
<span class="sourceLineNo">174</span><a id="line.174"> return (false);</a>
<span class="sourceLineNo">175</span><a id="line.175"> int serverPort = hreq.getServerPort();</a>
<span class="sourceLineNo">176</span><a id="line.176"> if (serverPort == -1) {</a>
<span class="sourceLineNo">177</span><a id="line.177"> if ("https".equals(hreq.getScheme()))</a>
<span class="sourceLineNo">178</span><a id="line.178"> serverPort = 443;</a>
<span class="sourceLineNo">179</span><a id="line.179"> else</a>
<span class="sourceLineNo">180</span><a id="line.180"> serverPort = 80;</a>
<span class="sourceLineNo">181</span><a id="line.181"> }</a>
<span class="sourceLineNo">182</span><a id="line.182"> int urlPort = url.getPort();</a>
<span class="sourceLineNo">183</span><a id="line.183"> if (urlPort == -1) {</a>
<span class="sourceLineNo">184</span><a id="line.184"> if ("https".equals(url.getProtocol()))</a>
<span class="sourceLineNo">185</span><a id="line.185"> urlPort = 443;</a>
<span class="sourceLineNo">186</span><a id="line.186"> else</a>
<span class="sourceLineNo">187</span><a id="line.187"> urlPort = 80;</a>
<span class="sourceLineNo">188</span><a id="line.188"> }</a>
<span class="sourceLineNo">189</span><a id="line.189"> if (serverPort != urlPort)</a>
<span class="sourceLineNo">190</span><a id="line.190"> return (false);</a>
<span class="sourceLineNo">191</span><a id="line.191"></a>
<span class="sourceLineNo">192</span><a id="line.192"> String contextPath = getRequest().getContextPath();</a>
<span class="sourceLineNo">193</span><a id="line.193"> if (contextPath != null) {</a>
<span class="sourceLineNo">194</span><a id="line.194"> String file = url.getFile();</a>
<span class="sourceLineNo">195</span><a id="line.195"> if ((file == null) || !file.startsWith(contextPath))</a>
<span class="sourceLineNo">196</span><a id="line.196"> return (false);</a>
<span class="sourceLineNo">197</span><a id="line.197"> String tok = ";" + DEFAULT_SESSION_ID_PARAMETER_NAME + "=" + session.getId();</a>
<span class="sourceLineNo">198</span><a id="line.198"> if (file.indexOf(tok, contextPath.length()) &gt;= 0)</a>
<span class="sourceLineNo">199</span><a id="line.199"> return (false);</a>
<span class="sourceLineNo">200</span><a id="line.200"> }</a>
<span class="sourceLineNo">201</span><a id="line.201"></a>
<span class="sourceLineNo">202</span><a id="line.202"> // This URL belongs to our web application, so it is encodeable</a>
<span class="sourceLineNo">203</span><a id="line.203"> return (true);</a>
<span class="sourceLineNo">204</span><a id="line.204"></a>
<span class="sourceLineNo">205</span><a id="line.205"> }</a>
<span class="sourceLineNo">206</span><a id="line.206"></a>
<span class="sourceLineNo">207</span><a id="line.207"></a>
<span class="sourceLineNo">208</span><a id="line.208"> /**</a>
<span class="sourceLineNo">209</span><a id="line.209"> * Convert (if necessary) and return the absolute URL that represents the</a>
<span class="sourceLineNo">210</span><a id="line.210"> * resource referenced by this possibly relative URL. If this URL is</a>
<span class="sourceLineNo">211</span><a id="line.211"> * already absolute, return it unchanged.</a>
<span class="sourceLineNo">212</span><a id="line.212"> *</a>
<span class="sourceLineNo">213</span><a id="line.213"> * @param location URL to be (possibly) converted and then returned</a>
<span class="sourceLineNo">214</span><a id="line.214"> * @return resource location as an absolute url</a>
<span class="sourceLineNo">215</span><a id="line.215"> * @throws IllegalArgumentException if a MalformedURLException is</a>
<span class="sourceLineNo">216</span><a id="line.216"> * thrown when converting the relative URL to an absolute one</a>
<span class="sourceLineNo">217</span><a id="line.217"> */</a>
<span class="sourceLineNo">218</span><a id="line.218"> private String toAbsolute(String location) {</a>
<span class="sourceLineNo">219</span><a id="line.219"></a>
<span class="sourceLineNo">220</span><a id="line.220"> if (location == null)</a>
<span class="sourceLineNo">221</span><a id="line.221"> return (location);</a>
<span class="sourceLineNo">222</span><a id="line.222"></a>
<span class="sourceLineNo">223</span><a id="line.223"> boolean leadingSlash = location.startsWith("/");</a>
<span class="sourceLineNo">224</span><a id="line.224"></a>
<span class="sourceLineNo">225</span><a id="line.225"> if (leadingSlash || !hasScheme(location)) {</a>
<span class="sourceLineNo">226</span><a id="line.226"></a>
<span class="sourceLineNo">227</span><a id="line.227"> StringBuilder buf = new StringBuilder();</a>
<span class="sourceLineNo">228</span><a id="line.228"></a>
<span class="sourceLineNo">229</span><a id="line.229"> String scheme = request.getScheme();</a>
<span class="sourceLineNo">230</span><a id="line.230"> String name = request.getServerName();</a>
<span class="sourceLineNo">231</span><a id="line.231"> int port = request.getServerPort();</a>
<span class="sourceLineNo">232</span><a id="line.232"></a>
<span class="sourceLineNo">233</span><a id="line.233"> try {</a>
<span class="sourceLineNo">234</span><a id="line.234"> buf.append(scheme).append("://").append(name);</a>
<span class="sourceLineNo">235</span><a id="line.235"> if ((scheme.equals("http") &amp;&amp; port != 80)</a>
<span class="sourceLineNo">236</span><a id="line.236"> || (scheme.equals("https") &amp;&amp; port != 443)) {</a>
<span class="sourceLineNo">237</span><a id="line.237"> buf.append(':').append(port);</a>
<span class="sourceLineNo">238</span><a id="line.238"> }</a>
<span class="sourceLineNo">239</span><a id="line.239"> if (!leadingSlash) {</a>
<span class="sourceLineNo">240</span><a id="line.240"> String relativePath = request.getRequestURI();</a>
<span class="sourceLineNo">241</span><a id="line.241"> int pos = relativePath.lastIndexOf('/');</a>
<span class="sourceLineNo">242</span><a id="line.242"> relativePath = relativePath.substring(0, pos);</a>
<span class="sourceLineNo">243</span><a id="line.243"></a>
<span class="sourceLineNo">244</span><a id="line.244"> String encodedURI = URLEncoder.encode(relativePath, getCharacterEncoding());</a>
<span class="sourceLineNo">245</span><a id="line.245"> buf.append(encodedURI).append('/');</a>
<span class="sourceLineNo">246</span><a id="line.246"> }</a>
<span class="sourceLineNo">247</span><a id="line.247"> buf.append(location);</a>
<span class="sourceLineNo">248</span><a id="line.248"> } catch (IOException e) {</a>
<span class="sourceLineNo">249</span><a id="line.249"> IllegalArgumentException iae = new IllegalArgumentException(location);</a>
<span class="sourceLineNo">250</span><a id="line.250"> iae.initCause(e);</a>
<span class="sourceLineNo">251</span><a id="line.251"> throw iae;</a>
<span class="sourceLineNo">252</span><a id="line.252"> }</a>
<span class="sourceLineNo">253</span><a id="line.253"></a>
<span class="sourceLineNo">254</span><a id="line.254"> return buf.toString();</a>
<span class="sourceLineNo">255</span><a id="line.255"></a>
<span class="sourceLineNo">256</span><a id="line.256"> } else {</a>
<span class="sourceLineNo">257</span><a id="line.257"> return location;</a>
<span class="sourceLineNo">258</span><a id="line.258"> }</a>
<span class="sourceLineNo">259</span><a id="line.259"> }</a>
<span class="sourceLineNo">260</span><a id="line.260"></a>
<span class="sourceLineNo">261</span><a id="line.261"> /**</a>
<span class="sourceLineNo">262</span><a id="line.262"> * Determine if the character is allowed in the scheme of a URI.</a>
<span class="sourceLineNo">263</span><a id="line.263"> * See RFC 2396, Section 3.1</a>
<span class="sourceLineNo">264</span><a id="line.264"> *</a>
<span class="sourceLineNo">265</span><a id="line.265"> * @param c the character to check</a>
<span class="sourceLineNo">266</span><a id="line.266"> * @return {@code true} if the character is allowed in a URI scheme, {@code false} otherwise.</a>
<span class="sourceLineNo">267</span><a id="line.267"> */</a>
<span class="sourceLineNo">268</span><a id="line.268"> public static boolean isSchemeChar(char c) {</a>
<span class="sourceLineNo">269</span><a id="line.269"> return Character.isLetterOrDigit(c) ||</a>
<span class="sourceLineNo">270</span><a id="line.270"> c == '+' || c == '-' || c == '.';</a>
<span class="sourceLineNo">271</span><a id="line.271"> }</a>
<span class="sourceLineNo">272</span><a id="line.272"></a>
<span class="sourceLineNo">273</span><a id="line.273"></a>
<span class="sourceLineNo">274</span><a id="line.274"> /**</a>
<span class="sourceLineNo">275</span><a id="line.275"> * Returns {@code true} if the URI string has a {@code scheme} component, {@code false} otherwise.</a>
<span class="sourceLineNo">276</span><a id="line.276"> *</a>
<span class="sourceLineNo">277</span><a id="line.277"> * @param uri the URI string to check for a scheme component</a>
<span class="sourceLineNo">278</span><a id="line.278"> * @return {@code true} if the URI string has a {@code scheme} component, {@code false} otherwise.</a>
<span class="sourceLineNo">279</span><a id="line.279"> */</a>
<span class="sourceLineNo">280</span><a id="line.280"> private boolean hasScheme(String uri) {</a>
<span class="sourceLineNo">281</span><a id="line.281"> int len = uri.length();</a>
<span class="sourceLineNo">282</span><a id="line.282"> for (int i = 0; i &lt; len; i++) {</a>
<span class="sourceLineNo">283</span><a id="line.283"> char c = uri.charAt(i);</a>
<span class="sourceLineNo">284</span><a id="line.284"> if (c == ':') {</a>
<span class="sourceLineNo">285</span><a id="line.285"> return i &gt; 0;</a>
<span class="sourceLineNo">286</span><a id="line.286"> } else if (!isSchemeChar(c)) {</a>
<span class="sourceLineNo">287</span><a id="line.287"> return false;</a>
<span class="sourceLineNo">288</span><a id="line.288"> }</a>
<span class="sourceLineNo">289</span><a id="line.289"> }</a>
<span class="sourceLineNo">290</span><a id="line.290"> return false;</a>
<span class="sourceLineNo">291</span><a id="line.291"> }</a>
<span class="sourceLineNo">292</span><a id="line.292"></a>
<span class="sourceLineNo">293</span><a id="line.293"> /**</a>
<span class="sourceLineNo">294</span><a id="line.294"> * Return the specified URL with the specified session identifier suitably encoded.</a>
<span class="sourceLineNo">295</span><a id="line.295"> *</a>
<span class="sourceLineNo">296</span><a id="line.296"> * @param url URL to be encoded with the session id</a>
<span class="sourceLineNo">297</span><a id="line.297"> * @param sessionId Session id to be included in the encoded URL</a>
<span class="sourceLineNo">298</span><a id="line.298"> * @return the url with the session identifer properly encoded.</a>
<span class="sourceLineNo">299</span><a id="line.299"> */</a>
<span class="sourceLineNo">300</span><a id="line.300"> protected String toEncoded(String url, String sessionId) {</a>
<span class="sourceLineNo">301</span><a id="line.301"></a>
<span class="sourceLineNo">302</span><a id="line.302"> if ((url == null) || (sessionId == null))</a>
<span class="sourceLineNo">303</span><a id="line.303"> return (url);</a>
<span class="sourceLineNo">304</span><a id="line.304"></a>
<span class="sourceLineNo">305</span><a id="line.305"> String path = url;</a>
<span class="sourceLineNo">306</span><a id="line.306"> String query = "";</a>
<span class="sourceLineNo">307</span><a id="line.307"> String anchor = "";</a>
<span class="sourceLineNo">308</span><a id="line.308"> int question = url.indexOf('?');</a>
<span class="sourceLineNo">309</span><a id="line.309"> if (question &gt;= 0) {</a>
<span class="sourceLineNo">310</span><a id="line.310"> path = url.substring(0, question);</a>
<span class="sourceLineNo">311</span><a id="line.311"> query = url.substring(question);</a>
<span class="sourceLineNo">312</span><a id="line.312"> }</a>
<span class="sourceLineNo">313</span><a id="line.313"> int pound = path.indexOf('#');</a>
<span class="sourceLineNo">314</span><a id="line.314"> if (pound &gt;= 0) {</a>
<span class="sourceLineNo">315</span><a id="line.315"> anchor = path.substring(pound);</a>
<span class="sourceLineNo">316</span><a id="line.316"> path = path.substring(0, pound);</a>
<span class="sourceLineNo">317</span><a id="line.317"> }</a>
<span class="sourceLineNo">318</span><a id="line.318"> StringBuilder sb = new StringBuilder(path);</a>
<span class="sourceLineNo">319</span><a id="line.319"> if (sb.length() &gt; 0) { // session id param can't be first.</a>
<span class="sourceLineNo">320</span><a id="line.320"> sb.append(";");</a>
<span class="sourceLineNo">321</span><a id="line.321"> sb.append(DEFAULT_SESSION_ID_PARAMETER_NAME);</a>
<span class="sourceLineNo">322</span><a id="line.322"> sb.append("=");</a>
<span class="sourceLineNo">323</span><a id="line.323"> sb.append(sessionId);</a>
<span class="sourceLineNo">324</span><a id="line.324"> }</a>
<span class="sourceLineNo">325</span><a id="line.325"> sb.append(anchor);</a>
<span class="sourceLineNo">326</span><a id="line.326"> sb.append(query);</a>
<span class="sourceLineNo">327</span><a id="line.327"> return (sb.toString());</a>
<span class="sourceLineNo">328</span><a id="line.328"></a>
<span class="sourceLineNo">329</span><a id="line.329"> }</a>
<span class="sourceLineNo">330</span><a id="line.330">}</a>
</pre>
</div>
</main>
</body>
</html>