Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.4.2 / shiro-core / xref / org / apache / shiro / session / mgt / AbstractValidatingSessionManager.html
blob: 523ff060943a3357133a61a2beaadfcef84675fd [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>AbstractValidatingSessionManager xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.session.mgt;
<a class="jxr_linenumber" name="L20" href="#L20">20</a>
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authz.AuthorizationException;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.ExpiredSessionException;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.InvalidSessionException;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.Session;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.UnknownSessionException;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.Destroyable;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.LifecycleUtils;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a class="jxr_linenumber" name="L30" href="#L30">30</a>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> java.util.Collection;
<a class="jxr_linenumber" name="L32" href="#L32">32</a>
<a class="jxr_linenumber" name="L33" href="#L33">33</a>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * Default business-tier implementation of the {@link ValidatingSessionManager} interface.</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * @since 0.1</em>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html">AbstractValidatingSessionManager</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html">AbstractNativeSessionManager</a>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">implements</strong> ValidatingSessionManager, Destroyable {
<a class="jxr_linenumber" name="L41" href="#L41">41</a>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_comment">//TODO - complete JavaDoc</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(AbstractValidatingSessionManager.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="L45" href="#L45">45</a>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * The default interval at which sessions will be validated (1 hour);</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * This can be overridden by calling {@link #setSessionValidationInterval(long)}</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> DEFAULT_SESSION_VALIDATION_INTERVAL = MILLIS_PER_HOUR;
<a class="jxr_linenumber" name="L51" href="#L51">51</a>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> sessionValidationSchedulerEnabled;
<a class="jxr_linenumber" name="L53" href="#L53">53</a>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * Scheduler used to validate sessions on a regular basis.</em>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html">SessionValidationScheduler</a> sessionValidationScheduler;
<a class="jxr_linenumber" name="L58" href="#L58">58</a>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">long</strong> sessionValidationInterval;
<a class="jxr_linenumber" name="L60" href="#L60">60</a>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html">AbstractValidatingSessionManager</a>() {
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">this</strong>.sessionValidationSchedulerEnabled = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">this</strong>.sessionValidationInterval = DEFAULT_SESSION_VALIDATION_INTERVAL;
<a class="jxr_linenumber" name="L64" href="#L64">64</a> }
<a class="jxr_linenumber" name="L65" href="#L65">65</a>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isSessionValidationSchedulerEnabled() {
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">return</strong> sessionValidationSchedulerEnabled;
<a class="jxr_linenumber" name="L68" href="#L68">68</a> }
<a class="jxr_linenumber" name="L69" href="#L69">69</a>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> @SuppressWarnings({<span class="jxr_string">"UnusedDeclaration"</span>})
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSessionValidationSchedulerEnabled(<strong class="jxr_keyword">boolean</strong> sessionValidationSchedulerEnabled) {
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">this</strong>.sessionValidationSchedulerEnabled = sessionValidationSchedulerEnabled;
<a class="jxr_linenumber" name="L73" href="#L73">73</a> }
<a class="jxr_linenumber" name="L74" href="#L74">74</a>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSessionValidationScheduler(<a href="../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html">SessionValidationScheduler</a> sessionValidationScheduler) {
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">this</strong>.sessionValidationScheduler = sessionValidationScheduler;
<a class="jxr_linenumber" name="L77" href="#L77">77</a> }
<a class="jxr_linenumber" name="L78" href="#L78">78</a>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html">SessionValidationScheduler</a> getSessionValidationScheduler() {
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">return</strong> sessionValidationScheduler;
<a class="jxr_linenumber" name="L81" href="#L81">81</a> }
<a class="jxr_linenumber" name="L82" href="#L82">82</a>
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> enableSessionValidationIfNecessary() {
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <a href="../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html">SessionValidationScheduler</a> scheduler = getSessionValidationScheduler();
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">if</strong> (isSessionValidationSchedulerEnabled() &amp;&amp; (scheduler == <strong class="jxr_keyword">null</strong> || !scheduler.isEnabled())) {
<a class="jxr_linenumber" name="L86" href="#L86">86</a> enableSessionValidation();
<a class="jxr_linenumber" name="L87" href="#L87">87</a> }
<a class="jxr_linenumber" name="L88" href="#L88">88</a> }
<a class="jxr_linenumber" name="L89" href="#L89">89</a>
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * If using the underlying default &lt;tt&gt;SessionValidationScheduler&lt;/tt&gt; (that is, the</em>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * {@link #setSessionValidationScheduler(SessionValidationScheduler) setSessionValidationScheduler} method is</em>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * never called) , this method allows one to specify how</em>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * frequently session should be validated (to check for orphans). The default value is</em>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * {@link #DEFAULT_SESSION_VALIDATION_INTERVAL}.</em>
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * If you override the default scheduler, it is assumed that overriding instance 'knows' how often to</em>
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * validate sessions, and this attribute will be ignored.</em>
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * Unless this method is called, the default value is {@link #DEFAULT_SESSION_VALIDATION_INTERVAL}.</em>
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * @param sessionValidationInterval the time in milliseconds between checking for valid sessions to reap orphans.</em>
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSessionValidationInterval(<strong class="jxr_keyword">long</strong> sessionValidationInterval) {
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">this</strong>.sessionValidationInterval = sessionValidationInterval;
<a class="jxr_linenumber" name="L106" href="#L106">106</a> }
<a class="jxr_linenumber" name="L107" href="#L107">107</a>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> getSessionValidationInterval() {
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">return</strong> sessionValidationInterval;
<a class="jxr_linenumber" name="L110" href="#L110">110</a> }
<a class="jxr_linenumber" name="L111" href="#L111">111</a>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> @Override
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/shiro/session/Session.html">Session</a> doGetSession(<strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key) <strong class="jxr_keyword">throws</strong> InvalidSessionException {
<a class="jxr_linenumber" name="L114" href="#L114">114</a> enableSessionValidationIfNecessary();
<a class="jxr_linenumber" name="L115" href="#L115">115</a>
<a class="jxr_linenumber" name="L116" href="#L116">116</a> log.trace(<span class="jxr_string">"Attempting to retrieve session with key {}"</span>, key);
<a class="jxr_linenumber" name="L117" href="#L117">117</a>
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <a href="../../../../../org/apache/shiro/session/Session.html">Session</a> s = retrieveSession(key);
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">if</strong> (s != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L120" href="#L120">120</a> validate(s, key);
<a class="jxr_linenumber" name="L121" href="#L121">121</a> }
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">return</strong> s;
<a class="jxr_linenumber" name="L123" href="#L123">123</a> }
<a class="jxr_linenumber" name="L124" href="#L124">124</a>
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * Looks up a session from the underlying data store based on the specified session key.</em>
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * @param key the session key to use to look up the target session.</em>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * @return the session identified by {@code sessionId}.</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * @throws UnknownSessionException if there is no session identified by {@code sessionId}.</em>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <a href="../../../../../org/apache/shiro/session/Session.html">Session</a> retrieveSession(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key) <strong class="jxr_keyword">throws</strong> UnknownSessionException;
<a class="jxr_linenumber" name="L133" href="#L133">133</a>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/session/Session.html">Session</a> createSession(<a href="../../../../../org/apache/shiro/session/mgt/SessionContext.html">SessionContext</a> context) <strong class="jxr_keyword">throws</strong> AuthorizationException {
<a class="jxr_linenumber" name="L135" href="#L135">135</a> enableSessionValidationIfNecessary();
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">return</strong> doCreateSession(context);
<a class="jxr_linenumber" name="L137" href="#L137">137</a> }
<a class="jxr_linenumber" name="L138" href="#L138">138</a>
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <a href="../../../../../org/apache/shiro/session/Session.html">Session</a> doCreateSession(<a href="../../../../../org/apache/shiro/session/mgt/SessionContext.html">SessionContext</a> initData) <strong class="jxr_keyword">throws</strong> AuthorizationException;
<a class="jxr_linenumber" name="L140" href="#L140">140</a>
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> validate(<a href="../../../../../org/apache/shiro/session/Session.html">Session</a> session, <a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key) <strong class="jxr_keyword">throws</strong> InvalidSessionException {
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L143" href="#L143">143</a> doValidate(session);
<a class="jxr_linenumber" name="L144" href="#L144">144</a> } <strong class="jxr_keyword">catch</strong> (ExpiredSessionException ese) {
<a class="jxr_linenumber" name="L145" href="#L145">145</a> onExpiration(session, ese, key);
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">throw</strong> ese;
<a class="jxr_linenumber" name="L147" href="#L147">147</a> } <strong class="jxr_keyword">catch</strong> (InvalidSessionException ise) {
<a class="jxr_linenumber" name="L148" href="#L148">148</a> onInvalidation(session, ise, key);
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">throw</strong> ise;
<a class="jxr_linenumber" name="L150" href="#L150">150</a> }
<a class="jxr_linenumber" name="L151" href="#L151">151</a> }
<a class="jxr_linenumber" name="L152" href="#L152">152</a>
<a class="jxr_linenumber" name="L153" href="#L153">153</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 class="jxr_linenumber" name="L154" href="#L154">154</a> log.trace(<span class="jxr_string">"Session with id [{}] has expired."</span>, s.getId());
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L156" href="#L156">156</a> onExpiration(s);
<a class="jxr_linenumber" name="L157" href="#L157">157</a> notifyExpiration(s);
<a class="jxr_linenumber" name="L158" href="#L158">158</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L159" href="#L159">159</a> afterExpired(s);
<a class="jxr_linenumber" name="L160" href="#L160">160</a> }
<a class="jxr_linenumber" name="L161" href="#L161">161</a> }
<a class="jxr_linenumber" name="L162" href="#L162">162</a>
<a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> onExpiration(<a href="../../../../../org/apache/shiro/session/Session.html">Session</a> session) {
<a class="jxr_linenumber" name="L164" href="#L164">164</a> onChange(session);
<a class="jxr_linenumber" name="L165" href="#L165">165</a> }
<a class="jxr_linenumber" name="L166" href="#L166">166</a>
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> afterExpired(<a href="../../../../../org/apache/shiro/session/Session.html">Session</a> session) {
<a class="jxr_linenumber" name="L168" href="#L168">168</a> }
<a class="jxr_linenumber" name="L169" href="#L169">169</a>
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> onInvalidation(<a href="../../../../../org/apache/shiro/session/Session.html">Session</a> s, <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html">InvalidSessionException</a> ise, <a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key) {
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">if</strong> (ise instanceof ExpiredSessionException) {
<a class="jxr_linenumber" name="L172" href="#L172">172</a> onExpiration(s, (ExpiredSessionException) ise, key);
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="L174" href="#L174">174</a> }
<a class="jxr_linenumber" name="L175" href="#L175">175</a> log.trace(<span class="jxr_string">"Session with id [{}] is invalid."</span>, s.getId());
<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L177" href="#L177">177</a> onStop(s);
<a class="jxr_linenumber" name="L178" href="#L178">178</a> notifyStop(s);
<a class="jxr_linenumber" name="L179" href="#L179">179</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L180" href="#L180">180</a> afterStopped(s);
<a class="jxr_linenumber" name="L181" href="#L181">181</a> }
<a class="jxr_linenumber" name="L182" href="#L182">182</a> }
<a class="jxr_linenumber" name="L183" href="#L183">183</a>
<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> doValidate(<a href="../../../../../org/apache/shiro/session/Session.html">Session</a> session) <strong class="jxr_keyword">throws</strong> InvalidSessionException {
<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">if</strong> (session instanceof ValidatingSession) {
<a class="jxr_linenumber" name="L186" href="#L186">186</a> ((<a href="../../../../../org/apache/shiro/session/mgt/ValidatingSession.html">ValidatingSession</a>) session).validate();
<a class="jxr_linenumber" name="L187" href="#L187">187</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L188" href="#L188">188</a> String msg = <span class="jxr_string">"The "</span> + getClass().getName() + <span class="jxr_string">" implementation only supports validating "</span> +
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <span class="jxr_string">"Session implementations of the "</span> + ValidatingSession.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">" interface. "</span> +
<a class="jxr_linenumber" name="L190" href="#L190">190</a> <span class="jxr_string">"Please either implement this interface in your session implementation or override the "</span> +
<a class="jxr_linenumber" name="L191" href="#L191">191</a> AbstractValidatingSessionManager.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">".doValidate(Session) method to perform validation."</span>;
<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(msg);
<a class="jxr_linenumber" name="L193" href="#L193">193</a> }
<a class="jxr_linenumber" name="L194" href="#L194">194</a> }
<a class="jxr_linenumber" name="L195" href="#L195">195</a>
<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> * Subclass template hook in case per-session timeout is not based on</em>
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.session.Session#getTimeout()}.</em>
<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * &lt;p&gt;This implementation merely returns {@link org.apache.shiro.session.Session#getTimeout()}&lt;/p&gt;</em>
<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * @param session the session for which to determine session timeout.</em>
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * @return the time in milliseconds the specified session may remain idle before expiring.</em>
<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">long</strong> getTimeout(<a href="../../../../../org/apache/shiro/session/Session.html">Session</a> session) {
<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">return</strong> session.getTimeout();
<a class="jxr_linenumber" name="L207" href="#L207">207</a> }
<a class="jxr_linenumber" name="L208" href="#L208">208</a>
<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html">SessionValidationScheduler</a> createSessionValidationScheduler() {
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <a href="../../../../../org/apache/shiro/session/mgt/ExecutorServiceSessionValidationScheduler.html">ExecutorServiceSessionValidationScheduler</a> scheduler;
<a class="jxr_linenumber" name="L211" href="#L211">211</a>
<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a class="jxr_linenumber" name="L213" href="#L213">213</a> log.debug(<span class="jxr_string">"No sessionValidationScheduler set. Attempting to create default instance."</span>);
<a class="jxr_linenumber" name="L214" href="#L214">214</a> }
<a class="jxr_linenumber" name="L215" href="#L215">215</a> scheduler = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/session/mgt/ExecutorServiceSessionValidationScheduler.html">ExecutorServiceSessionValidationScheduler</a>(<strong class="jxr_keyword">this</strong>);
<a class="jxr_linenumber" name="L216" href="#L216">216</a> scheduler.setInterval(getSessionValidationInterval());
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) {
<a class="jxr_linenumber" name="L218" href="#L218">218</a> log.trace(<span class="jxr_string">"Created default SessionValidationScheduler instance of type ["</span> + scheduler.getClass().getName() + <span class="jxr_string">"]."</span>);
<a class="jxr_linenumber" name="L219" href="#L219">219</a> }
<a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong class="jxr_keyword">return</strong> scheduler;
<a class="jxr_linenumber" name="L221" href="#L221">221</a> }
<a class="jxr_linenumber" name="L222" href="#L222">222</a>
<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> enableSessionValidation() {
<a class="jxr_linenumber" name="L224" href="#L224">224</a> <a href="../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html">SessionValidationScheduler</a> scheduler = getSessionValidationScheduler();
<a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">if</strong> (scheduler == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L226" href="#L226">226</a> scheduler = createSessionValidationScheduler();
<a class="jxr_linenumber" name="L227" href="#L227">227</a> setSessionValidationScheduler(scheduler);
<a class="jxr_linenumber" name="L228" href="#L228">228</a> }
<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_comment">// it is possible that that a scheduler was already created and set via 'setSessionValidationScheduler()'</em>
<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_comment">// but would not have been enabled/started yet</em>
<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">if</strong> (!scheduler.isEnabled()) {
<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">if</strong> (log.isInfoEnabled()) {
<a class="jxr_linenumber" name="L233" href="#L233">233</a> log.info(<span class="jxr_string">"Enabling session validation scheduler..."</span>);
<a class="jxr_linenumber" name="L234" href="#L234">234</a> }
<a class="jxr_linenumber" name="L235" href="#L235">235</a> scheduler.enableSessionValidation();
<a class="jxr_linenumber" name="L236" href="#L236">236</a> afterSessionValidationEnabled();
<a class="jxr_linenumber" name="L237" href="#L237">237</a> }
<a class="jxr_linenumber" name="L238" href="#L238">238</a> }
<a class="jxr_linenumber" name="L239" href="#L239">239</a>
<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> afterSessionValidationEnabled() {
<a class="jxr_linenumber" name="L241" href="#L241">241</a> }
<a class="jxr_linenumber" name="L242" href="#L242">242</a>
<a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> disableSessionValidation() {
<a class="jxr_linenumber" name="L244" href="#L244">244</a> beforeSessionValidationDisabled();
<a class="jxr_linenumber" name="L245" href="#L245">245</a> <a href="../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html">SessionValidationScheduler</a> scheduler = getSessionValidationScheduler();
<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">if</strong> (scheduler != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L248" href="#L248">248</a> scheduler.disableSessionValidation();
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">if</strong> (log.isInfoEnabled()) {
<a class="jxr_linenumber" name="L250" href="#L250">250</a> log.info(<span class="jxr_string">"Disabled session validation scheduler."</span>);
<a class="jxr_linenumber" name="L251" href="#L251">251</a> }
<a class="jxr_linenumber" name="L252" href="#L252">252</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a class="jxr_linenumber" name="L254" href="#L254">254</a> String msg = <span class="jxr_string">"Unable to disable SessionValidationScheduler. Ignoring (shutting down)..."</span>;
<a class="jxr_linenumber" name="L255" href="#L255">255</a> log.debug(msg, e);
<a class="jxr_linenumber" name="L256" href="#L256">256</a> }
<a class="jxr_linenumber" name="L257" href="#L257">257</a> }
<a class="jxr_linenumber" name="L258" href="#L258">258</a> LifecycleUtils.destroy(scheduler);
<a class="jxr_linenumber" name="L259" href="#L259">259</a> setSessionValidationScheduler(<strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L260" href="#L260">260</a> }
<a class="jxr_linenumber" name="L261" href="#L261">261</a> }
<a class="jxr_linenumber" name="L262" href="#L262">262</a>
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> beforeSessionValidationDisabled() {
<a class="jxr_linenumber" name="L264" href="#L264">264</a> }
<a class="jxr_linenumber" name="L265" href="#L265">265</a>
<a class="jxr_linenumber" name="L266" href="#L266">266</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> destroy() {
<a class="jxr_linenumber" name="L267" href="#L267">267</a> disableSessionValidation();
<a class="jxr_linenumber" name="L268" href="#L268">268</a> }
<a class="jxr_linenumber" name="L269" href="#L269">269</a>
<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> * @see ValidatingSessionManager#validateSessions()</em>
<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> validateSessions() {
<a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong class="jxr_keyword">if</strong> (log.isInfoEnabled()) {
<a class="jxr_linenumber" name="L275" href="#L275">275</a> log.info(<span class="jxr_string">"Validating all active sessions..."</span>);
<a class="jxr_linenumber" name="L276" href="#L276">276</a> }
<a class="jxr_linenumber" name="L277" href="#L277">277</a>
<a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">int</strong> invalidCount = 0;
<a class="jxr_linenumber" name="L279" href="#L279">279</a>
<a class="jxr_linenumber" name="L280" href="#L280">280</a> Collection&lt;Session&gt; activeSessions = getActiveSessions();
<a class="jxr_linenumber" name="L281" href="#L281">281</a>
<a class="jxr_linenumber" name="L282" href="#L282">282</a> <strong class="jxr_keyword">if</strong> (activeSessions != <strong class="jxr_keyword">null</strong> &amp;&amp; !activeSessions.isEmpty()) {
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">for</strong> (Session s : activeSessions) {
<a class="jxr_linenumber" name="L284" href="#L284">284</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_comment">//simulate a lookup key to satisfy the method signature.</em>
<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_comment">//this could probably stand to be cleaned up in future versions:</em>
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/session/mgt/DefaultSessionKey.html">DefaultSessionKey</a>(s.getId());
<a class="jxr_linenumber" name="L288" href="#L288">288</a> validate(s, key);
<a class="jxr_linenumber" name="L289" href="#L289">289</a> } <strong class="jxr_keyword">catch</strong> (InvalidSessionException e) {
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">boolean</strong> expired = (e instanceof ExpiredSessionException);
<a class="jxr_linenumber" name="L292" href="#L292">292</a> String msg = <span class="jxr_string">"Invalidated session with id ["</span> + s.getId() + <span class="jxr_string">"]"</span> +
<a class="jxr_linenumber" name="L293" href="#L293">293</a> (expired ? <span class="jxr_string">" (expired)"</span> : <span class="jxr_string">" (stopped)"</span>);
<a class="jxr_linenumber" name="L294" href="#L294">294</a> log.debug(msg);
<a class="jxr_linenumber" name="L295" href="#L295">295</a> }
<a class="jxr_linenumber" name="L296" href="#L296">296</a> invalidCount++;
<a class="jxr_linenumber" name="L297" href="#L297">297</a> }
<a class="jxr_linenumber" name="L298" href="#L298">298</a> }
<a class="jxr_linenumber" name="L299" href="#L299">299</a> }
<a class="jxr_linenumber" name="L300" href="#L300">300</a>
<a class="jxr_linenumber" name="L301" href="#L301">301</a> <strong class="jxr_keyword">if</strong> (log.isInfoEnabled()) {
<a class="jxr_linenumber" name="L302" href="#L302">302</a> String msg = <span class="jxr_string">"Finished session validation."</span>;
<a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong class="jxr_keyword">if</strong> (invalidCount &gt; 0) {
<a class="jxr_linenumber" name="L304" href="#L304">304</a> msg += <span class="jxr_string">" ["</span> + invalidCount + <span class="jxr_string">"] sessions were stopped."</span>;
<a class="jxr_linenumber" name="L305" href="#L305">305</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L306" href="#L306">306</a> msg += <span class="jxr_string">" No sessions were stopped."</span>;
<a class="jxr_linenumber" name="L307" href="#L307">307</a> }
<a class="jxr_linenumber" name="L308" href="#L308">308</a> log.info(msg);
<a class="jxr_linenumber" name="L309" href="#L309">309</a> }
<a class="jxr_linenumber" name="L310" href="#L310">310</a> }
<a class="jxr_linenumber" name="L311" href="#L311">311</a>
<a class="jxr_linenumber" name="L312" href="#L312">312</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> Collection&lt;Session&gt; getActiveSessions();
<a class="jxr_linenumber" name="L313" href="#L313">313</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>