blob: 9d22a154d69031fd4390dc860a9318cca453efc5 [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.session.mgt;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.authz.AuthorizationException;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.session.ExpiredSessionException;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.session.InvalidSessionException;</a>
<span class="sourceLineNo">024</span><a id="line.24">import org.apache.shiro.session.Session;</a>
<span class="sourceLineNo">025</span><a id="line.25">import org.apache.shiro.session.UnknownSessionException;</a>
<span class="sourceLineNo">026</span><a id="line.26">import org.apache.shiro.util.Destroyable;</a>
<span class="sourceLineNo">027</span><a id="line.27">import org.apache.shiro.util.LifecycleUtils;</a>
<span class="sourceLineNo">028</span><a id="line.28">import org.slf4j.Logger;</a>
<span class="sourceLineNo">029</span><a id="line.29">import org.slf4j.LoggerFactory;</a>
<span class="sourceLineNo">030</span><a id="line.30"></a>
<span class="sourceLineNo">031</span><a id="line.31">import java.util.Collection;</a>
<span class="sourceLineNo">032</span><a id="line.32"></a>
<span class="sourceLineNo">033</span><a id="line.33"></a>
<span class="sourceLineNo">034</span><a id="line.34">/**</a>
<span class="sourceLineNo">035</span><a id="line.35"> * Default business-tier implementation of the {@link ValidatingSessionManager} interface.</a>
<span class="sourceLineNo">036</span><a id="line.36"> *</a>
<span class="sourceLineNo">037</span><a id="line.37"> * @since 0.1</a>
<span class="sourceLineNo">038</span><a id="line.38"> */</a>
<span class="sourceLineNo">039</span><a id="line.39">public abstract class AbstractValidatingSessionManager extends AbstractNativeSessionManager</a>
<span class="sourceLineNo">040</span><a id="line.40"> implements ValidatingSessionManager, Destroyable {</a>
<span class="sourceLineNo">041</span><a id="line.41"></a>
<span class="sourceLineNo">042</span><a id="line.42"> //TODO - complete JavaDoc</a>
<span class="sourceLineNo">043</span><a id="line.43"></a>
<span class="sourceLineNo">044</span><a id="line.44"> private static final Logger log = LoggerFactory.getLogger(AbstractValidatingSessionManager.class);</a>
<span class="sourceLineNo">045</span><a id="line.45"></a>
<span class="sourceLineNo">046</span><a id="line.46"> /**</a>
<span class="sourceLineNo">047</span><a id="line.47"> * The default interval at which sessions will be validated (1 hour);</a>
<span class="sourceLineNo">048</span><a id="line.48"> * This can be overridden by calling {@link #setSessionValidationInterval(long)}</a>
<span class="sourceLineNo">049</span><a id="line.49"> */</a>
<span class="sourceLineNo">050</span><a id="line.50"> public static final long DEFAULT_SESSION_VALIDATION_INTERVAL = MILLIS_PER_HOUR;</a>
<span class="sourceLineNo">051</span><a id="line.51"></a>
<span class="sourceLineNo">052</span><a id="line.52"> protected boolean sessionValidationSchedulerEnabled;</a>
<span class="sourceLineNo">053</span><a id="line.53"></a>
<span class="sourceLineNo">054</span><a id="line.54"> /**</a>
<span class="sourceLineNo">055</span><a id="line.55"> * Scheduler used to validate sessions on a regular basis.</a>
<span class="sourceLineNo">056</span><a id="line.56"> */</a>
<span class="sourceLineNo">057</span><a id="line.57"> protected SessionValidationScheduler sessionValidationScheduler;</a>
<span class="sourceLineNo">058</span><a id="line.58"></a>
<span class="sourceLineNo">059</span><a id="line.59"> protected long sessionValidationInterval;</a>
<span class="sourceLineNo">060</span><a id="line.60"></a>
<span class="sourceLineNo">061</span><a id="line.61"> public AbstractValidatingSessionManager() {</a>
<span class="sourceLineNo">062</span><a id="line.62"> this.sessionValidationSchedulerEnabled = true;</a>
<span class="sourceLineNo">063</span><a id="line.63"> this.sessionValidationInterval = DEFAULT_SESSION_VALIDATION_INTERVAL;</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"> public boolean isSessionValidationSchedulerEnabled() {</a>
<span class="sourceLineNo">067</span><a id="line.67"> return sessionValidationSchedulerEnabled;</a>
<span class="sourceLineNo">068</span><a id="line.68"> }</a>
<span class="sourceLineNo">069</span><a id="line.69"></a>
<span class="sourceLineNo">070</span><a id="line.70"> @SuppressWarnings({"UnusedDeclaration"})</a>
<span class="sourceLineNo">071</span><a id="line.71"> public void setSessionValidationSchedulerEnabled(boolean sessionValidationSchedulerEnabled) {</a>
<span class="sourceLineNo">072</span><a id="line.72"> this.sessionValidationSchedulerEnabled = sessionValidationSchedulerEnabled;</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"> public void setSessionValidationScheduler(SessionValidationScheduler sessionValidationScheduler) {</a>
<span class="sourceLineNo">076</span><a id="line.76"> this.sessionValidationScheduler = sessionValidationScheduler;</a>
<span class="sourceLineNo">077</span><a id="line.77"> }</a>
<span class="sourceLineNo">078</span><a id="line.78"></a>
<span class="sourceLineNo">079</span><a id="line.79"> public SessionValidationScheduler getSessionValidationScheduler() {</a>
<span class="sourceLineNo">080</span><a id="line.80"> return sessionValidationScheduler;</a>
<span class="sourceLineNo">081</span><a id="line.81"> }</a>
<span class="sourceLineNo">082</span><a id="line.82"></a>
<span class="sourceLineNo">083</span><a id="line.83"> private void enableSessionValidationIfNecessary() {</a>
<span class="sourceLineNo">084</span><a id="line.84"> SessionValidationScheduler scheduler = getSessionValidationScheduler();</a>
<span class="sourceLineNo">085</span><a id="line.85"> if (isSessionValidationSchedulerEnabled() &amp;&amp; (scheduler == null || !scheduler.isEnabled())) {</a>
<span class="sourceLineNo">086</span><a id="line.86"> enableSessionValidation();</a>
<span class="sourceLineNo">087</span><a id="line.87"> }</a>
<span class="sourceLineNo">088</span><a id="line.88"> }</a>
<span class="sourceLineNo">089</span><a id="line.89"></a>
<span class="sourceLineNo">090</span><a id="line.90"> /**</a>
<span class="sourceLineNo">091</span><a id="line.91"> * If using the underlying default &lt;tt&gt;SessionValidationScheduler&lt;/tt&gt; (that is, the</a>
<span class="sourceLineNo">092</span><a id="line.92"> * {@link #setSessionValidationScheduler(SessionValidationScheduler) setSessionValidationScheduler} method is</a>
<span class="sourceLineNo">093</span><a id="line.93"> * never called) , this method allows one to specify how</a>
<span class="sourceLineNo">094</span><a id="line.94"> * frequently session should be validated (to check for orphans). The default value is</a>
<span class="sourceLineNo">095</span><a id="line.95"> * {@link #DEFAULT_SESSION_VALIDATION_INTERVAL}.</a>
<span class="sourceLineNo">096</span><a id="line.96"> * &lt;p/&gt;</a>
<span class="sourceLineNo">097</span><a id="line.97"> * If you override the default scheduler, it is assumed that overriding instance 'knows' how often to</a>
<span class="sourceLineNo">098</span><a id="line.98"> * validate sessions, and this attribute will be ignored.</a>
<span class="sourceLineNo">099</span><a id="line.99"> * &lt;p/&gt;</a>
<span class="sourceLineNo">100</span><a id="line.100"> * Unless this method is called, the default value is {@link #DEFAULT_SESSION_VALIDATION_INTERVAL}.</a>
<span class="sourceLineNo">101</span><a id="line.101"> *</a>
<span class="sourceLineNo">102</span><a id="line.102"> * @param sessionValidationInterval the time in milliseconds between checking for valid sessions to reap orphans.</a>
<span class="sourceLineNo">103</span><a id="line.103"> */</a>
<span class="sourceLineNo">104</span><a id="line.104"> public void setSessionValidationInterval(long sessionValidationInterval) {</a>
<span class="sourceLineNo">105</span><a id="line.105"> this.sessionValidationInterval = sessionValidationInterval;</a>
<span class="sourceLineNo">106</span><a id="line.106"> }</a>
<span class="sourceLineNo">107</span><a id="line.107"></a>
<span class="sourceLineNo">108</span><a id="line.108"> public long getSessionValidationInterval() {</a>
<span class="sourceLineNo">109</span><a id="line.109"> return sessionValidationInterval;</a>
<span class="sourceLineNo">110</span><a id="line.110"> }</a>
<span class="sourceLineNo">111</span><a id="line.111"></a>
<span class="sourceLineNo">112</span><a id="line.112"> @Override</a>
<span class="sourceLineNo">113</span><a id="line.113"> protected final Session doGetSession(final SessionKey key) throws InvalidSessionException {</a>
<span class="sourceLineNo">114</span><a id="line.114"> enableSessionValidationIfNecessary();</a>
<span class="sourceLineNo">115</span><a id="line.115"></a>
<span class="sourceLineNo">116</span><a id="line.116"> log.trace("Attempting to retrieve session with key {}", key);</a>
<span class="sourceLineNo">117</span><a id="line.117"></a>
<span class="sourceLineNo">118</span><a id="line.118"> Session s = retrieveSession(key);</a>
<span class="sourceLineNo">119</span><a id="line.119"> if (s != null) {</a>
<span class="sourceLineNo">120</span><a id="line.120"> validate(s, key);</a>
<span class="sourceLineNo">121</span><a id="line.121"> }</a>
<span class="sourceLineNo">122</span><a id="line.122"> return s;</a>
<span class="sourceLineNo">123</span><a id="line.123"> }</a>
<span class="sourceLineNo">124</span><a id="line.124"></a>
<span class="sourceLineNo">125</span><a id="line.125"> /**</a>
<span class="sourceLineNo">126</span><a id="line.126"> * Looks up a session from the underlying data store based on the specified session key.</a>
<span class="sourceLineNo">127</span><a id="line.127"> *</a>
<span class="sourceLineNo">128</span><a id="line.128"> * @param key the session key to use to look up the target session.</a>
<span class="sourceLineNo">129</span><a id="line.129"> * @return the session identified by {@code sessionId}.</a>
<span class="sourceLineNo">130</span><a id="line.130"> * @throws UnknownSessionException if there is no session identified by {@code sessionId}.</a>
<span class="sourceLineNo">131</span><a id="line.131"> */</a>
<span class="sourceLineNo">132</span><a id="line.132"> protected abstract Session retrieveSession(SessionKey key) throws UnknownSessionException;</a>
<span class="sourceLineNo">133</span><a id="line.133"></a>
<span class="sourceLineNo">134</span><a id="line.134"> protected Session createSession(SessionContext context) throws AuthorizationException {</a>
<span class="sourceLineNo">135</span><a id="line.135"> enableSessionValidationIfNecessary();</a>
<span class="sourceLineNo">136</span><a id="line.136"> return doCreateSession(context);</a>
<span class="sourceLineNo">137</span><a id="line.137"> }</a>
<span class="sourceLineNo">138</span><a id="line.138"></a>
<span class="sourceLineNo">139</span><a id="line.139"> protected abstract Session doCreateSession(SessionContext initData) throws AuthorizationException;</a>
<span class="sourceLineNo">140</span><a id="line.140"></a>
<span class="sourceLineNo">141</span><a id="line.141"> protected void validate(Session session, SessionKey key) throws InvalidSessionException {</a>
<span class="sourceLineNo">142</span><a id="line.142"> try {</a>
<span class="sourceLineNo">143</span><a id="line.143"> doValidate(session);</a>
<span class="sourceLineNo">144</span><a id="line.144"> } catch (ExpiredSessionException ese) {</a>
<span class="sourceLineNo">145</span><a id="line.145"> onExpiration(session, ese, key);</a>
<span class="sourceLineNo">146</span><a id="line.146"> throw ese;</a>
<span class="sourceLineNo">147</span><a id="line.147"> } catch (InvalidSessionException ise) {</a>
<span class="sourceLineNo">148</span><a id="line.148"> onInvalidation(session, ise, key);</a>
<span class="sourceLineNo">149</span><a id="line.149"> throw ise;</a>
<span class="sourceLineNo">150</span><a id="line.150"> }</a>
<span class="sourceLineNo">151</span><a id="line.151"> }</a>
<span class="sourceLineNo">152</span><a id="line.152"></a>
<span class="sourceLineNo">153</span><a id="line.153"> protected void onExpiration(Session s, ExpiredSessionException ese, SessionKey key) {</a>
<span class="sourceLineNo">154</span><a id="line.154"> log.trace("Session with id [{}] has expired.", s.getId());</a>
<span class="sourceLineNo">155</span><a id="line.155"> try {</a>
<span class="sourceLineNo">156</span><a id="line.156"> onExpiration(s);</a>
<span class="sourceLineNo">157</span><a id="line.157"> notifyExpiration(s);</a>
<span class="sourceLineNo">158</span><a id="line.158"> } finally {</a>
<span class="sourceLineNo">159</span><a id="line.159"> afterExpired(s);</a>
<span class="sourceLineNo">160</span><a id="line.160"> }</a>
<span class="sourceLineNo">161</span><a id="line.161"> }</a>
<span class="sourceLineNo">162</span><a id="line.162"></a>
<span class="sourceLineNo">163</span><a id="line.163"> protected void onExpiration(Session session) {</a>
<span class="sourceLineNo">164</span><a id="line.164"> onChange(session);</a>
<span class="sourceLineNo">165</span><a id="line.165"> }</a>
<span class="sourceLineNo">166</span><a id="line.166"></a>
<span class="sourceLineNo">167</span><a id="line.167"> protected void afterExpired(Session session) {</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"> protected void onInvalidation(Session s, InvalidSessionException ise, SessionKey key) {</a>
<span class="sourceLineNo">171</span><a id="line.171"> if (ise instanceof ExpiredSessionException) {</a>
<span class="sourceLineNo">172</span><a id="line.172"> onExpiration(s, (ExpiredSessionException) ise, key);</a>
<span class="sourceLineNo">173</span><a id="line.173"> return;</a>
<span class="sourceLineNo">174</span><a id="line.174"> }</a>
<span class="sourceLineNo">175</span><a id="line.175"> log.trace("Session with id [{}] is invalid.", s.getId());</a>
<span class="sourceLineNo">176</span><a id="line.176"> try {</a>
<span class="sourceLineNo">177</span><a id="line.177"> onStop(s);</a>
<span class="sourceLineNo">178</span><a id="line.178"> notifyStop(s);</a>
<span class="sourceLineNo">179</span><a id="line.179"> } finally {</a>
<span class="sourceLineNo">180</span><a id="line.180"> afterStopped(s);</a>
<span class="sourceLineNo">181</span><a id="line.181"> }</a>
<span class="sourceLineNo">182</span><a id="line.182"> }</a>
<span class="sourceLineNo">183</span><a id="line.183"></a>
<span class="sourceLineNo">184</span><a id="line.184"> protected void doValidate(Session session) throws InvalidSessionException {</a>
<span class="sourceLineNo">185</span><a id="line.185"> if (session instanceof ValidatingSession) {</a>
<span class="sourceLineNo">186</span><a id="line.186"> ((ValidatingSession) session).validate();</a>
<span class="sourceLineNo">187</span><a id="line.187"> } else {</a>
<span class="sourceLineNo">188</span><a id="line.188"> String msg = "The " + getClass().getName() + " implementation only supports validating " +</a>
<span class="sourceLineNo">189</span><a id="line.189"> "Session implementations of the " + ValidatingSession.class.getName() + " interface. " +</a>
<span class="sourceLineNo">190</span><a id="line.190"> "Please either implement this interface in your session implementation or override the " +</a>
<span class="sourceLineNo">191</span><a id="line.191"> AbstractValidatingSessionManager.class.getName() + ".doValidate(Session) method to perform validation.";</a>
<span class="sourceLineNo">192</span><a id="line.192"> throw new IllegalStateException(msg);</a>
<span class="sourceLineNo">193</span><a id="line.193"> }</a>
<span class="sourceLineNo">194</span><a id="line.194"> }</a>
<span class="sourceLineNo">195</span><a id="line.195"></a>
<span class="sourceLineNo">196</span><a id="line.196"> /**</a>
<span class="sourceLineNo">197</span><a id="line.197"> * Subclass template hook in case per-session timeout is not based on</a>
<span class="sourceLineNo">198</span><a id="line.198"> * {@link org.apache.shiro.session.Session#getTimeout()}.</a>
<span class="sourceLineNo">199</span><a id="line.199"> * &lt;p/&gt;</a>
<span class="sourceLineNo">200</span><a id="line.200"> * &lt;p&gt;This implementation merely returns {@link org.apache.shiro.session.Session#getTimeout()}&lt;/p&gt;</a>
<span class="sourceLineNo">201</span><a id="line.201"> *</a>
<span class="sourceLineNo">202</span><a id="line.202"> * @param session the session for which to determine session timeout.</a>
<span class="sourceLineNo">203</span><a id="line.203"> * @return the time in milliseconds the specified session may remain idle before expiring.</a>
<span class="sourceLineNo">204</span><a id="line.204"> */</a>
<span class="sourceLineNo">205</span><a id="line.205"> protected long getTimeout(Session session) {</a>
<span class="sourceLineNo">206</span><a id="line.206"> return session.getTimeout();</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"> protected SessionValidationScheduler createSessionValidationScheduler() {</a>
<span class="sourceLineNo">210</span><a id="line.210"> ExecutorServiceSessionValidationScheduler scheduler;</a>
<span class="sourceLineNo">211</span><a id="line.211"></a>
<span class="sourceLineNo">212</span><a id="line.212"> if (log.isDebugEnabled()) {</a>
<span class="sourceLineNo">213</span><a id="line.213"> log.debug("No sessionValidationScheduler set. Attempting to create default instance.");</a>
<span class="sourceLineNo">214</span><a id="line.214"> }</a>
<span class="sourceLineNo">215</span><a id="line.215"> scheduler = new ExecutorServiceSessionValidationScheduler(this);</a>
<span class="sourceLineNo">216</span><a id="line.216"> scheduler.setInterval(getSessionValidationInterval());</a>
<span class="sourceLineNo">217</span><a id="line.217"> if (log.isTraceEnabled()) {</a>
<span class="sourceLineNo">218</span><a id="line.218"> log.trace("Created default SessionValidationScheduler instance of type [" + scheduler.getClass().getName() + "].");</a>
<span class="sourceLineNo">219</span><a id="line.219"> }</a>
<span class="sourceLineNo">220</span><a id="line.220"> return scheduler;</a>
<span class="sourceLineNo">221</span><a id="line.221"> }</a>
<span class="sourceLineNo">222</span><a id="line.222"></a>
<span class="sourceLineNo">223</span><a id="line.223"> protected synchronized void enableSessionValidation() {</a>
<span class="sourceLineNo">224</span><a id="line.224"> SessionValidationScheduler scheduler = getSessionValidationScheduler();</a>
<span class="sourceLineNo">225</span><a id="line.225"> if (scheduler == null) {</a>
<span class="sourceLineNo">226</span><a id="line.226"> scheduler = createSessionValidationScheduler();</a>
<span class="sourceLineNo">227</span><a id="line.227"> setSessionValidationScheduler(scheduler);</a>
<span class="sourceLineNo">228</span><a id="line.228"> }</a>
<span class="sourceLineNo">229</span><a id="line.229"> // it is possible that that a scheduler was already created and set via 'setSessionValidationScheduler()'</a>
<span class="sourceLineNo">230</span><a id="line.230"> // but would not have been enabled/started yet</a>
<span class="sourceLineNo">231</span><a id="line.231"> if (!scheduler.isEnabled()) {</a>
<span class="sourceLineNo">232</span><a id="line.232"> if (log.isInfoEnabled()) {</a>
<span class="sourceLineNo">233</span><a id="line.233"> log.info("Enabling session validation scheduler...");</a>
<span class="sourceLineNo">234</span><a id="line.234"> }</a>
<span class="sourceLineNo">235</span><a id="line.235"> scheduler.enableSessionValidation();</a>
<span class="sourceLineNo">236</span><a id="line.236"> afterSessionValidationEnabled();</a>
<span class="sourceLineNo">237</span><a id="line.237"> }</a>
<span class="sourceLineNo">238</span><a id="line.238"> }</a>
<span class="sourceLineNo">239</span><a id="line.239"></a>
<span class="sourceLineNo">240</span><a id="line.240"> protected void afterSessionValidationEnabled() {</a>
<span class="sourceLineNo">241</span><a id="line.241"> }</a>
<span class="sourceLineNo">242</span><a id="line.242"></a>
<span class="sourceLineNo">243</span><a id="line.243"> protected synchronized void disableSessionValidation() {</a>
<span class="sourceLineNo">244</span><a id="line.244"> beforeSessionValidationDisabled();</a>
<span class="sourceLineNo">245</span><a id="line.245"> SessionValidationScheduler scheduler = getSessionValidationScheduler();</a>
<span class="sourceLineNo">246</span><a id="line.246"> if (scheduler != null) {</a>
<span class="sourceLineNo">247</span><a id="line.247"> try {</a>
<span class="sourceLineNo">248</span><a id="line.248"> scheduler.disableSessionValidation();</a>
<span class="sourceLineNo">249</span><a id="line.249"> if (log.isInfoEnabled()) {</a>
<span class="sourceLineNo">250</span><a id="line.250"> log.info("Disabled session validation scheduler.");</a>
<span class="sourceLineNo">251</span><a id="line.251"> }</a>
<span class="sourceLineNo">252</span><a id="line.252"> } catch (Exception e) {</a>
<span class="sourceLineNo">253</span><a id="line.253"> if (log.isDebugEnabled()) {</a>
<span class="sourceLineNo">254</span><a id="line.254"> String msg = "Unable to disable SessionValidationScheduler. Ignoring (shutting down)...";</a>
<span class="sourceLineNo">255</span><a id="line.255"> log.debug(msg, e);</a>
<span class="sourceLineNo">256</span><a id="line.256"> }</a>
<span class="sourceLineNo">257</span><a id="line.257"> }</a>
<span class="sourceLineNo">258</span><a id="line.258"> LifecycleUtils.destroy(scheduler);</a>
<span class="sourceLineNo">259</span><a id="line.259"> setSessionValidationScheduler(null);</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"></a>
<span class="sourceLineNo">263</span><a id="line.263"> protected void beforeSessionValidationDisabled() {</a>
<span class="sourceLineNo">264</span><a id="line.264"> }</a>
<span class="sourceLineNo">265</span><a id="line.265"></a>
<span class="sourceLineNo">266</span><a id="line.266"> public void destroy() {</a>
<span class="sourceLineNo">267</span><a id="line.267"> disableSessionValidation();</a>
<span class="sourceLineNo">268</span><a id="line.268"> }</a>
<span class="sourceLineNo">269</span><a id="line.269"></a>
<span class="sourceLineNo">270</span><a id="line.270"> /**</a>
<span class="sourceLineNo">271</span><a id="line.271"> * @see ValidatingSessionManager#validateSessions()</a>
<span class="sourceLineNo">272</span><a id="line.272"> */</a>
<span class="sourceLineNo">273</span><a id="line.273"> public void validateSessions() {</a>
<span class="sourceLineNo">274</span><a id="line.274"> if (log.isInfoEnabled()) {</a>
<span class="sourceLineNo">275</span><a id="line.275"> log.info("Validating all active sessions...");</a>
<span class="sourceLineNo">276</span><a id="line.276"> }</a>
<span class="sourceLineNo">277</span><a id="line.277"></a>
<span class="sourceLineNo">278</span><a id="line.278"> int invalidCount = 0;</a>
<span class="sourceLineNo">279</span><a id="line.279"></a>
<span class="sourceLineNo">280</span><a id="line.280"> Collection&lt;Session&gt; activeSessions = getActiveSessions();</a>
<span class="sourceLineNo">281</span><a id="line.281"></a>
<span class="sourceLineNo">282</span><a id="line.282"> if (activeSessions != null &amp;&amp; !activeSessions.isEmpty()) {</a>
<span class="sourceLineNo">283</span><a id="line.283"> for (Session s : activeSessions) {</a>
<span class="sourceLineNo">284</span><a id="line.284"> try {</a>
<span class="sourceLineNo">285</span><a id="line.285"> //simulate a lookup key to satisfy the method signature.</a>
<span class="sourceLineNo">286</span><a id="line.286"> //this could probably stand to be cleaned up in future versions:</a>
<span class="sourceLineNo">287</span><a id="line.287"> SessionKey key = new DefaultSessionKey(s.getId());</a>
<span class="sourceLineNo">288</span><a id="line.288"> validate(s, key);</a>
<span class="sourceLineNo">289</span><a id="line.289"> } catch (InvalidSessionException e) {</a>
<span class="sourceLineNo">290</span><a id="line.290"> if (log.isDebugEnabled()) {</a>
<span class="sourceLineNo">291</span><a id="line.291"> boolean expired = (e instanceof ExpiredSessionException);</a>
<span class="sourceLineNo">292</span><a id="line.292"> String msg = "Invalidated session with id [" + s.getId() + "]" +</a>
<span class="sourceLineNo">293</span><a id="line.293"> (expired ? " (expired)" : " (stopped)");</a>
<span class="sourceLineNo">294</span><a id="line.294"> log.debug(msg);</a>
<span class="sourceLineNo">295</span><a id="line.295"> }</a>
<span class="sourceLineNo">296</span><a id="line.296"> invalidCount++;</a>
<span class="sourceLineNo">297</span><a id="line.297"> }</a>
<span class="sourceLineNo">298</span><a id="line.298"> }</a>
<span class="sourceLineNo">299</span><a id="line.299"> }</a>
<span class="sourceLineNo">300</span><a id="line.300"></a>
<span class="sourceLineNo">301</span><a id="line.301"> if (log.isInfoEnabled()) {</a>
<span class="sourceLineNo">302</span><a id="line.302"> String msg = "Finished session validation.";</a>
<span class="sourceLineNo">303</span><a id="line.303"> if (invalidCount &gt; 0) {</a>
<span class="sourceLineNo">304</span><a id="line.304"> msg += " [" + invalidCount + "] sessions were stopped.";</a>
<span class="sourceLineNo">305</span><a id="line.305"> } else {</a>
<span class="sourceLineNo">306</span><a id="line.306"> msg += " No sessions were stopped.";</a>
<span class="sourceLineNo">307</span><a id="line.307"> }</a>
<span class="sourceLineNo">308</span><a id="line.308"> log.info(msg);</a>
<span class="sourceLineNo">309</span><a id="line.309"> }</a>
<span class="sourceLineNo">310</span><a id="line.310"> }</a>
<span class="sourceLineNo">311</span><a id="line.311"></a>
<span class="sourceLineNo">312</span><a id="line.312"> protected abstract Collection&lt;Session&gt; getActiveSessions();</a>
<span class="sourceLineNo">313</span><a id="line.313">}</a>
</pre>
</div>
</main>
</body>
</html>