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