Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.6 / xref / org / apache / shiro / web / session / mgt / DefaultWebSessionManager.html
blob: 3ed1093ba0b6d1350266183111021d2b3940c150 [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>DefaultWebSessionManager xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/shiro/web/session/mgt/DefaultWebSessionManager.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.session.mgt;
<a name="20" href="#20">20</a>
<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.ExpiredSessionException;
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.InvalidSessionException;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.Session;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.mgt.DefaultSessionManager;
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.mgt.DelegatingSession;
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.mgt.SessionContext;
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.mgt.SessionKey;
<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.servlet.Cookie;
<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.servlet.ShiroHttpServletRequest;
<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.servlet.ShiroHttpSession;
<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.servlet.SimpleCookie;
<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.util.WebUtils;
<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a name="35" href="#35">35</a>
<a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletRequest;
<a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletResponse;
<a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest;
<a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse;
<a name="40" href="#40">40</a> <strong class="jxr_keyword">import</strong> java.io.Serializable;
<a name="41" href="#41">41</a>
<a name="42" href="#42">42</a>
<a name="43" href="#43">43</a> <em class="jxr_javadoccomment">/**</em>
<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * Web-application capable {@link org.apache.shiro.session.mgt.SessionManager SessionManager} implementation.</em>
<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> *</em>
<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * @since 0.9</em>
<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> */</em>
<a name="48" href="#48">48</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/shiro/web/session/mgt/DefaultWebSessionManager.html">DefaultWebSessionManager</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/shiro/session/mgt/DefaultSessionManager.html">DefaultSessionManager</a> implements <a href="../../../../../../org/apache/shiro/web/session/mgt/WebSessionManager.html">WebSessionManager</a> {
<a name="49" href="#49">49</a>
<a name="50" href="#50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(DefaultWebSessionManager.<strong class="jxr_keyword">class</strong>);
<a name="51" href="#51">51</a>
<a name="52" href="#52">52</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/shiro/web/servlet/Cookie.html">Cookie</a> sessionIdCookie;
<a name="53" href="#53">53</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> sessionIdCookieEnabled;
<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/session/mgt/DefaultWebSessionManager.html">DefaultWebSessionManager</a>() {
<a name="56" href="#56">56</a> <a href="../../../../../../org/apache/shiro/web/servlet/Cookie.html">Cookie</a> cookie = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/shiro/web/servlet/SimpleCookie.html">SimpleCookie</a>(ShiroHttpSession.DEFAULT_SESSION_ID_NAME);
<a name="57" href="#57">57</a> cookie.setHttpOnly(<strong class="jxr_keyword">true</strong>); <em class="jxr_comment">//more secure, protects against XSS attacks</em>
<a name="58" href="#58">58</a> <strong class="jxr_keyword">this</strong>.sessionIdCookie = cookie;
<a name="59" href="#59">59</a> <strong class="jxr_keyword">this</strong>.sessionIdCookieEnabled = <strong class="jxr_keyword">true</strong>;
<a name="60" href="#60">60</a> }
<a name="61" href="#61">61</a>
<a name="62" href="#62">62</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/shiro/web/servlet/Cookie.html">Cookie</a> getSessionIdCookie() {
<a name="63" href="#63">63</a> <strong class="jxr_keyword">return</strong> sessionIdCookie;
<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> setSessionIdCookie(<a href="../../../../../../org/apache/shiro/web/servlet/Cookie.html">Cookie</a> sessionIdCookie) {
<a name="68" href="#68">68</a> <strong class="jxr_keyword">this</strong>.sessionIdCookie = sessionIdCookie;
<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> <strong class="jxr_keyword">boolean</strong> isSessionIdCookieEnabled() {
<a name="72" href="#72">72</a> <strong class="jxr_keyword">return</strong> sessionIdCookieEnabled;
<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> setSessionIdCookieEnabled(<strong class="jxr_keyword">boolean</strong> sessionIdCookieEnabled) {
<a name="77" href="#77">77</a> <strong class="jxr_keyword">this</strong>.sessionIdCookieEnabled = sessionIdCookieEnabled;
<a name="78" href="#78">78</a> }
<a name="79" href="#79">79</a>
<a name="80" href="#80">80</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> storeSessionId(Serializable currentId, HttpServletRequest request, HttpServletResponse response) {
<a name="81" href="#81">81</a> <strong class="jxr_keyword">if</strong> (currentId == <strong class="jxr_keyword">null</strong>) {
<a name="82" href="#82">82</a> String msg = <span class="jxr_string">"sessionId cannot be null when persisting for subsequent requests."</span>;
<a name="83" href="#83">83</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(msg);
<a name="84" href="#84">84</a> }
<a name="85" href="#85">85</a> <a href="../../../../../../org/apache/shiro/web/servlet/Cookie.html">Cookie</a> template = getSessionIdCookie();
<a name="86" href="#86">86</a> <a href="../../../../../../org/apache/shiro/web/servlet/Cookie.html">Cookie</a> cookie = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/shiro/web/servlet/SimpleCookie.html">SimpleCookie</a>(template);
<a name="87" href="#87">87</a> String idString = currentId.toString();
<a name="88" href="#88">88</a> cookie.setValue(idString);
<a name="89" href="#89">89</a> cookie.saveTo(request, response);
<a name="90" href="#90">90</a> log.trace(<span class="jxr_string">"Set session ID cookie for session with id {}"</span>, idString);
<a name="91" href="#91">91</a> }
<a name="92" href="#92">92</a>
<a name="93" href="#93">93</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> removeSessionIdCookie(HttpServletRequest request, HttpServletResponse response) {
<a name="94" href="#94">94</a> getSessionIdCookie().removeFrom(request, response);
<a name="95" href="#95">95</a> }
<a name="96" href="#96">96</a>
<a name="97" href="#97">97</a> <strong class="jxr_keyword">private</strong> String getSessionIdCookieValue(ServletRequest request, ServletResponse response) {
<a name="98" href="#98">98</a> <strong class="jxr_keyword">if</strong> (!isSessionIdCookieEnabled()) {
<a name="99" href="#99">99</a> log.debug(<span class="jxr_string">"Session ID cookie is disabled - session id will not be acquired from a request cookie."</span>);
<a name="100" href="#100">100</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="101" href="#101">101</a> }
<a name="102" href="#102">102</a> <strong class="jxr_keyword">if</strong> (!(request instanceof HttpServletRequest)) {
<a name="103" href="#103">103</a> log.debug(<span class="jxr_string">"Current request is not an HttpServletRequest - cannot get session ID cookie. Returning null."</span>);
<a name="104" href="#104">104</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="105" href="#105">105</a> }
<a name="106" href="#106">106</a> HttpServletRequest httpRequest = (HttpServletRequest) request;
<a name="107" href="#107">107</a> <strong class="jxr_keyword">return</strong> getSessionIdCookie().readValue(httpRequest, WebUtils.toHttp(response));
<a name="108" href="#108">108</a> }
<a name="109" href="#109">109</a>
<a name="110" href="#110">110</a> <strong class="jxr_keyword">private</strong> Serializable getReferencedSessionId(ServletRequest request, ServletResponse response) {
<a name="111" href="#111">111</a>
<a name="112" href="#112">112</a> String id = getSessionIdCookieValue(request, response);
<a name="113" href="#113">113</a> <strong class="jxr_keyword">if</strong> (id != <strong class="jxr_keyword">null</strong>) {
<a name="114" href="#114">114</a> request.setAttribute(ShiroHttpServletRequest.REFERENCED_SESSION_ID_SOURCE,
<a name="115" href="#115">115</a> ShiroHttpServletRequest.COOKIE_SESSION_ID_SOURCE);
<a name="116" href="#116">116</a> } <strong class="jxr_keyword">else</strong> {
<a name="117" href="#117">117</a> <em class="jxr_comment">//not in a cookie, or cookie is disabled - try the request URI as a fallback (i.e. due to URL rewriting):</em>
<a name="118" href="#118">118</a>
<a name="119" href="#119">119</a> <em class="jxr_comment">//try the URI path segment parameters first:</em>
<a name="120" href="#120">120</a> id = getUriPathSegmentParamValue(request, ShiroHttpSession.DEFAULT_SESSION_ID_NAME);
<a name="121" href="#121">121</a>
<a name="122" href="#122">122</a> <strong class="jxr_keyword">if</strong> (id == <strong class="jxr_keyword">null</strong>) {
<a name="123" href="#123">123</a> <em class="jxr_comment">//not a URI path segment parameter, try the query parameters:</em>
<a name="124" href="#124">124</a> String name = getSessionIdName();
<a name="125" href="#125">125</a> id = request.getParameter(name);
<a name="126" href="#126">126</a> <strong class="jxr_keyword">if</strong> (id == <strong class="jxr_keyword">null</strong>) {
<a name="127" href="#127">127</a> <em class="jxr_comment">//try lowercase:</em>
<a name="128" href="#128">128</a> id = request.getParameter(name.toLowerCase());
<a name="129" href="#129">129</a> }
<a name="130" href="#130">130</a> }
<a name="131" href="#131">131</a> <strong class="jxr_keyword">if</strong> (id != <strong class="jxr_keyword">null</strong>) {
<a name="132" href="#132">132</a> request.setAttribute(ShiroHttpServletRequest.REFERENCED_SESSION_ID_SOURCE,
<a name="133" href="#133">133</a> ShiroHttpServletRequest.URL_SESSION_ID_SOURCE);
<a name="134" href="#134">134</a> }
<a name="135" href="#135">135</a> }
<a name="136" href="#136">136</a> <strong class="jxr_keyword">if</strong> (id != <strong class="jxr_keyword">null</strong>) {
<a name="137" href="#137">137</a> request.setAttribute(ShiroHttpServletRequest.REFERENCED_SESSION_ID, id);
<a name="138" href="#138">138</a> <em class="jxr_comment">//automatically mark it valid here. If it is invalid, the</em>
<a name="139" href="#139">139</a> <em class="jxr_comment">//onUnknownSession method below will be invoked and we'll remove the attribute at that time.</em>
<a name="140" href="#140">140</a> request.setAttribute(ShiroHttpServletRequest.REFERENCED_SESSION_ID_IS_VALID, Boolean.TRUE);
<a name="141" href="#141">141</a> }
<a name="142" href="#142">142</a> <strong class="jxr_keyword">return</strong> id;
<a name="143" href="#143">143</a> }
<a name="144" href="#144">144</a>
<a name="145" href="#145">145</a> <em class="jxr_comment">//SHIRO-351</em>
<a name="146" href="#146">146</a> <em class="jxr_comment">//also see http://cdivilly.wordpress.com/2011/04/22/java-servlets-uri-parameters/</em>
<a name="147" href="#147">147</a> <em class="jxr_comment">//since 1.2.2</em>
<a name="148" href="#148">148</a> <strong class="jxr_keyword">private</strong> String getUriPathSegmentParamValue(ServletRequest servletRequest, String paramName) {
<a name="149" href="#149">149</a>
<a name="150" href="#150">150</a> <strong class="jxr_keyword">if</strong> (!(servletRequest instanceof HttpServletRequest)) {
<a name="151" href="#151">151</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="152" href="#152">152</a> }
<a name="153" href="#153">153</a> HttpServletRequest request = (HttpServletRequest)servletRequest;
<a name="154" href="#154">154</a> String uri = request.getRequestURI();
<a name="155" href="#155">155</a> <strong class="jxr_keyword">if</strong> (uri == <strong class="jxr_keyword">null</strong>) {
<a name="156" href="#156">156</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="157" href="#157">157</a> }
<a name="158" href="#158">158</a>
<a name="159" href="#159">159</a> <strong class="jxr_keyword">int</strong> queryStartIndex = uri.indexOf('?');
<a name="160" href="#160">160</a> <strong class="jxr_keyword">if</strong> (queryStartIndex &gt;= 0) { <em class="jxr_comment">//get rid of the query string</em>
<a name="161" href="#161">161</a> uri = uri.substring(0, queryStartIndex);
<a name="162" href="#162">162</a> }
<a name="163" href="#163">163</a>
<a name="164" href="#164">164</a> <strong class="jxr_keyword">int</strong> index = uri.indexOf(';'); <em class="jxr_comment">//now check for path segment parameters:</em>
<a name="165" href="#165">165</a> <strong class="jxr_keyword">if</strong> (index &lt; 0) {
<a name="166" href="#166">166</a> <em class="jxr_comment">//no path segment params - return:</em>
<a name="167" href="#167">167</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<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">//there are path segment params, let's get the last one that may exist:</em>
<a name="171" href="#171">171</a>
<a name="172" href="#172">172</a> <strong class="jxr_keyword">final</strong> String TOKEN = paramName + <span class="jxr_string">"="</span>;
<a name="173" href="#173">173</a>
<a name="174" href="#174">174</a> uri = uri.substring(index+1); <em class="jxr_comment">//uri now contains only the path segment params</em>
<a name="175" href="#175">175</a>
<a name="176" href="#176">176</a> <em class="jxr_comment">//we only care about the last JSESSIONID param:</em>
<a name="177" href="#177">177</a> index = uri.lastIndexOf(TOKEN);
<a name="178" href="#178">178</a> <strong class="jxr_keyword">if</strong> (index &lt; 0) {
<a name="179" href="#179">179</a> <em class="jxr_comment">//no segment param:</em>
<a name="180" href="#180">180</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="181" href="#181">181</a> }
<a name="182" href="#182">182</a>
<a name="183" href="#183">183</a> uri = uri.substring(index + TOKEN.length());
<a name="184" href="#184">184</a>
<a name="185" href="#185">185</a> index = uri.indexOf(';'); <em class="jxr_comment">//strip off any remaining segment params:</em>
<a name="186" href="#186">186</a> <strong class="jxr_keyword">if</strong>(index &gt;= 0) {
<a name="187" href="#187">187</a> uri = uri.substring(0, index);
<a name="188" href="#188">188</a> }
<a name="189" href="#189">189</a>
<a name="190" href="#190">190</a> <strong class="jxr_keyword">return</strong> uri; <em class="jxr_comment">//what remains is the value</em>
<a name="191" href="#191">191</a> }
<a name="192" href="#192">192</a>
<a name="193" href="#193">193</a> <em class="jxr_comment">//since 1.2.1</em>
<a name="194" href="#194">194</a> <strong class="jxr_keyword">private</strong> String getSessionIdName() {
<a name="195" href="#195">195</a> String name = <strong class="jxr_keyword">this</strong>.sessionIdCookie != <strong class="jxr_keyword">null</strong> ? <strong class="jxr_keyword">this</strong>.sessionIdCookie.getName() : <strong class="jxr_keyword">null</strong>;
<a name="196" href="#196">196</a> <strong class="jxr_keyword">if</strong> (name == <strong class="jxr_keyword">null</strong>) {
<a name="197" href="#197">197</a> name = ShiroHttpSession.DEFAULT_SESSION_ID_NAME;
<a name="198" href="#198">198</a> }
<a name="199" href="#199">199</a> <strong class="jxr_keyword">return</strong> name;
<a name="200" href="#200">200</a> }
<a name="201" href="#201">201</a>
<a name="202" href="#202">202</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> createExposedSession(<a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> session, <a href="../../../../../../org/apache/shiro/session/mgt/SessionContext.html">SessionContext</a> context) {
<a name="203" href="#203">203</a> <strong class="jxr_keyword">if</strong> (!WebUtils.isWeb(context)) {
<a name="204" href="#204">204</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">super</strong>.createExposedSession(session, context);
<a name="205" href="#205">205</a> }
<a name="206" href="#206">206</a> ServletRequest request = WebUtils.getRequest(context);
<a name="207" href="#207">207</a> ServletResponse response = WebUtils.getResponse(context);
<a name="208" href="#208">208</a> <a href="../../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/shiro/web/session/mgt/WebSessionKey.html">WebSessionKey</a>(session.getId(), request, response);
<a name="209" href="#209">209</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/shiro/session/mgt/DelegatingSession.html">DelegatingSession</a>(<strong class="jxr_keyword">this</strong>, key);
<a name="210" href="#210">210</a> }
<a name="211" href="#211">211</a>
<a name="212" href="#212">212</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> createExposedSession(<a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> session, <a href="../../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key) {
<a name="213" href="#213">213</a> <strong class="jxr_keyword">if</strong> (!WebUtils.isWeb(key)) {
<a name="214" href="#214">214</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">super</strong>.createExposedSession(session, key);
<a name="215" href="#215">215</a> }
<a name="216" href="#216">216</a>
<a name="217" href="#217">217</a> ServletRequest request = WebUtils.getRequest(key);
<a name="218" href="#218">218</a> ServletResponse response = WebUtils.getResponse(key);
<a name="219" href="#219">219</a> <a href="../../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> sessionKey = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/shiro/web/session/mgt/WebSessionKey.html">WebSessionKey</a>(session.getId(), request, response);
<a name="220" href="#220">220</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/shiro/session/mgt/DelegatingSession.html">DelegatingSession</a>(<strong class="jxr_keyword">this</strong>, sessionKey);
<a name="221" href="#221">221</a> }
<a name="222" href="#222">222</a>
<a name="223" href="#223">223</a> <em class="jxr_javadoccomment">/**</em>
<a name="224" href="#224">224</a> <em class="jxr_javadoccomment"> * Stores the Session's ID, usually as a Cookie, to associate with future requests.</em>
<a name="225" href="#225">225</a> <em class="jxr_javadoccomment"> *</em>
<a name="226" href="#226">226</a> <em class="jxr_javadoccomment"> * @param session the session that was just {@link #createSession created}.</em>
<a name="227" href="#227">227</a> <em class="jxr_javadoccomment"> */</em>
<a name="228" href="#228">228</a> @Override
<a name="229" href="#229">229</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> onStart(<a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> session, <a href="../../../../../../org/apache/shiro/session/mgt/SessionContext.html">SessionContext</a> context) {
<a name="230" href="#230">230</a> <strong class="jxr_keyword">super</strong>.onStart(session, context);
<a name="231" href="#231">231</a>
<a name="232" href="#232">232</a> <strong class="jxr_keyword">if</strong> (!WebUtils.isHttp(context)) {
<a name="233" href="#233">233</a> log.debug(<span class="jxr_string">"SessionContext argument is not HTTP compatible or does not have an HTTP request/response "</span> +
<a name="234" href="#234">234</a> <span class="jxr_string">"pair. No session ID cookie will be set."</span>);
<a name="235" href="#235">235</a> <strong class="jxr_keyword">return</strong>;
<a name="236" href="#236">236</a>
<a name="237" href="#237">237</a> }
<a name="238" href="#238">238</a> HttpServletRequest request = WebUtils.getHttpRequest(context);
<a name="239" href="#239">239</a> HttpServletResponse response = WebUtils.getHttpResponse(context);
<a name="240" href="#240">240</a>
<a name="241" href="#241">241</a> <strong class="jxr_keyword">if</strong> (isSessionIdCookieEnabled()) {
<a name="242" href="#242">242</a> Serializable sessionId = session.getId();
<a name="243" href="#243">243</a> storeSessionId(sessionId, request, response);
<a name="244" href="#244">244</a> } <strong class="jxr_keyword">else</strong> {
<a name="245" href="#245">245</a> log.debug(<span class="jxr_string">"Session ID cookie is disabled. No cookie has been set for new session with id {}"</span>, session.getId());
<a name="246" href="#246">246</a> }
<a name="247" href="#247">247</a>
<a name="248" href="#248">248</a> request.removeAttribute(ShiroHttpServletRequest.REFERENCED_SESSION_ID_SOURCE);
<a name="249" href="#249">249</a> request.setAttribute(ShiroHttpServletRequest.REFERENCED_SESSION_IS_NEW, Boolean.TRUE);
<a name="250" href="#250">250</a> }
<a name="251" href="#251">251</a>
<a name="252" href="#252">252</a> @Override
<a name="253" href="#253">253</a> <strong class="jxr_keyword">public</strong> Serializable getSessionId(<a href="../../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key) {
<a name="254" href="#254">254</a> Serializable id = <strong class="jxr_keyword">super</strong>.getSessionId(key);
<a name="255" href="#255">255</a> <strong class="jxr_keyword">if</strong> (id == <strong class="jxr_keyword">null</strong> &amp;&amp; WebUtils.isWeb(key)) {
<a name="256" href="#256">256</a> ServletRequest request = WebUtils.getRequest(key);
<a name="257" href="#257">257</a> ServletResponse response = WebUtils.getResponse(key);
<a name="258" href="#258">258</a> id = getSessionId(request, response);
<a name="259" href="#259">259</a> }
<a name="260" href="#260">260</a> <strong class="jxr_keyword">return</strong> id;
<a name="261" href="#261">261</a> }
<a name="262" href="#262">262</a>
<a name="263" href="#263">263</a> <strong class="jxr_keyword">protected</strong> Serializable getSessionId(ServletRequest request, ServletResponse response) {
<a name="264" href="#264">264</a> <strong class="jxr_keyword">return</strong> getReferencedSessionId(request, response);
<a name="265" href="#265">265</a> }
<a name="266" href="#266">266</a>
<a name="267" href="#267">267</a> @Override
<a name="268" href="#268">268</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> onExpiration(<a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> s, <a href="../../../../../../org/apache/shiro/session/ExpiredSessionException.html">ExpiredSessionException</a> ese, <a href="../../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key) {
<a name="269" href="#269">269</a> <strong class="jxr_keyword">super</strong>.onExpiration(s, ese, key);
<a name="270" href="#270">270</a> onInvalidation(key);
<a name="271" href="#271">271</a> }
<a name="272" href="#272">272</a>
<a name="273" href="#273">273</a> @Override
<a name="274" href="#274">274</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> onInvalidation(<a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> session, <a href="../../../../../../org/apache/shiro/session/InvalidSessionException.html">InvalidSessionException</a> ise, <a href="../../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key) {
<a name="275" href="#275">275</a> <strong class="jxr_keyword">super</strong>.onInvalidation(session, ise, key);
<a name="276" href="#276">276</a> onInvalidation(key);
<a name="277" href="#277">277</a> }
<a name="278" href="#278">278</a>
<a name="279" href="#279">279</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> onInvalidation(<a href="../../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key) {
<a name="280" href="#280">280</a> ServletRequest request = WebUtils.getRequest(key);
<a name="281" href="#281">281</a> <strong class="jxr_keyword">if</strong> (request != <strong class="jxr_keyword">null</strong>) {
<a name="282" href="#282">282</a> request.removeAttribute(ShiroHttpServletRequest.REFERENCED_SESSION_ID_IS_VALID);
<a name="283" href="#283">283</a> }
<a name="284" href="#284">284</a> <strong class="jxr_keyword">if</strong> (WebUtils.isHttp(key)) {
<a name="285" href="#285">285</a> log.debug(<span class="jxr_string">"Referenced session was invalid. Removing session ID cookie."</span>);
<a name="286" href="#286">286</a> removeSessionIdCookie(WebUtils.getHttpRequest(key), WebUtils.getHttpResponse(key));
<a name="287" href="#287">287</a> } <strong class="jxr_keyword">else</strong> {
<a name="288" href="#288">288</a> log.debug(<span class="jxr_string">"SessionKey argument is not HTTP compatible or does not have an HTTP request/response "</span> +
<a name="289" href="#289">289</a> <span class="jxr_string">"pair. Session ID cookie will not be removed due to invalidated session."</span>);
<a name="290" href="#290">290</a> }
<a name="291" href="#291">291</a> }
<a name="292" href="#292">292</a>
<a name="293" href="#293">293</a> @Override
<a name="294" href="#294">294</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> onStop(<a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> session, <a href="../../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key) {
<a name="295" href="#295">295</a> <strong class="jxr_keyword">super</strong>.onStop(session, key);
<a name="296" href="#296">296</a> <strong class="jxr_keyword">if</strong> (WebUtils.isHttp(key)) {
<a name="297" href="#297">297</a> HttpServletRequest request = WebUtils.getHttpRequest(key);
<a name="298" href="#298">298</a> HttpServletResponse response = WebUtils.getHttpResponse(key);
<a name="299" href="#299">299</a> log.debug(<span class="jxr_string">"Session has been stopped (subject logout or explicit stop). Removing session ID cookie."</span>);
<a name="300" href="#300">300</a> removeSessionIdCookie(request, response);
<a name="301" href="#301">301</a> } <strong class="jxr_keyword">else</strong> {
<a name="302" href="#302">302</a> log.debug(<span class="jxr_string">"SessionKey argument is not HTTP compatible or does not have an HTTP request/response "</span> +
<a name="303" href="#303">303</a> <span class="jxr_string">"pair. Session ID cookie will not be removed due to stopped session."</span>);
<a name="304" href="#304">304</a> }
<a name="305" href="#305">305</a> }
<a name="306" href="#306">306</a>
<a name="307" href="#307">307</a> <em class="jxr_javadoccomment">/**</em>
<a name="308" href="#308">308</a> <em class="jxr_javadoccomment"> * This is a native session manager implementation, so this method returns {@code false} always.</em>
<a name="309" href="#309">309</a> <em class="jxr_javadoccomment"> *</em>
<a name="310" href="#310">310</a> <em class="jxr_javadoccomment"> * @return {@code false} always</em>
<a name="311" href="#311">311</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a name="312" href="#312">312</a> <em class="jxr_javadoccomment"> */</em>
<a name="313" href="#313">313</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isServletContainerSessions() {
<a name="314" href="#314">314</a> <strong class="jxr_keyword">return</strong> false;
<a name="315" href="#315">315</a> }
<a name="316" href="#316">316</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>