blob: c9aa4d0df8bc338349d5f96a69c1c7e92ee1f5bf [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="fr">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.shiro.session.mgt.quartz;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.quartz.JobBuilder;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.quartz.JobDetail;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.quartz.Scheduler;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.quartz.SchedulerException;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.quartz.SimpleTrigger;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.quartz.TriggerBuilder;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.quartz.TriggerKey;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.quartz.impl.StdSchedulerFactory;<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.slf4j.Logger;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.slf4j.LoggerFactory;<a name="line.31"></a>
<span class="sourceLineNo">032</span><a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.shiro.session.mgt.DefaultSessionManager;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.shiro.session.mgt.SessionValidationScheduler;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.shiro.session.mgt.ValidatingSessionManager;<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span>import static org.quartz.SimpleScheduleBuilder.simpleSchedule;<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span>/**<a name="line.40"></a>
<span class="sourceLineNo">041</span> * An implementation of the {@link org.apache.shiro.session.mgt.SessionValidationScheduler SessionValidationScheduler} that uses Quartz to schedule a<a name="line.41"></a>
<span class="sourceLineNo">042</span> * job to call {@link org.apache.shiro.session.mgt.ValidatingSessionManager#validateSessions()} on<a name="line.42"></a>
<span class="sourceLineNo">043</span> * a regular basis.<a name="line.43"></a>
<span class="sourceLineNo">044</span> *<a name="line.44"></a>
<span class="sourceLineNo">045</span> * @since 0.1<a name="line.45"></a>
<span class="sourceLineNo">046</span> */<a name="line.46"></a>
<span class="sourceLineNo">047</span>public class QuartzSessionValidationScheduler implements SessionValidationScheduler {<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> //TODO - complete JavaDoc<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> /*--------------------------------------------<a name="line.51"></a>
<span class="sourceLineNo">052</span> | C O N S T A N T S |<a name="line.52"></a>
<span class="sourceLineNo">053</span> ============================================*/<a name="line.53"></a>
<span class="sourceLineNo">054</span> /**<a name="line.54"></a>
<span class="sourceLineNo">055</span> * The default interval at which sessions will be validated (1 hour);<a name="line.55"></a>
<span class="sourceLineNo">056</span> * This can be overridden by calling {@link #setSessionValidationInterval(long)}<a name="line.56"></a>
<span class="sourceLineNo">057</span> */<a name="line.57"></a>
<span class="sourceLineNo">058</span> public static final long DEFAULT_SESSION_VALIDATION_INTERVAL = DefaultSessionManager.DEFAULT_SESSION_VALIDATION_INTERVAL;<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> /**<a name="line.60"></a>
<span class="sourceLineNo">061</span> * The name assigned to the quartz job.<a name="line.61"></a>
<span class="sourceLineNo">062</span> */<a name="line.62"></a>
<span class="sourceLineNo">063</span> private static final String JOB_NAME = "SessionValidationJob";<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> /*--------------------------------------------<a name="line.65"></a>
<span class="sourceLineNo">066</span> | I N S T A N C E V A R I A B L E S |<a name="line.66"></a>
<span class="sourceLineNo">067</span> ============================================*/<a name="line.67"></a>
<span class="sourceLineNo">068</span> private static final Logger log = LoggerFactory.getLogger(QuartzSessionValidationScheduler.class);<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> /**<a name="line.70"></a>
<span class="sourceLineNo">071</span> * The configured Quartz scheduler to use to schedule the Quartz job. If no scheduler is<a name="line.71"></a>
<span class="sourceLineNo">072</span> * configured, the scheduler will be retrieved by calling {@link StdSchedulerFactory#getDefaultScheduler()}<a name="line.72"></a>
<span class="sourceLineNo">073</span> */<a name="line.73"></a>
<span class="sourceLineNo">074</span> private Scheduler scheduler;<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> private boolean schedulerImplicitlyCreated = false;<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span> private boolean enabled = false;<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span> /**<a name="line.80"></a>
<span class="sourceLineNo">081</span> * The session manager used to validate sessions.<a name="line.81"></a>
<span class="sourceLineNo">082</span> */<a name="line.82"></a>
<span class="sourceLineNo">083</span> private ValidatingSessionManager sessionManager;<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> /**<a name="line.85"></a>
<span class="sourceLineNo">086</span> * The session validation interval in milliseconds.<a name="line.86"></a>
<span class="sourceLineNo">087</span> */<a name="line.87"></a>
<span class="sourceLineNo">088</span> private long sessionValidationInterval = DEFAULT_SESSION_VALIDATION_INTERVAL;<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> /*--------------------------------------------<a name="line.90"></a>
<span class="sourceLineNo">091</span> | C O N S T R U C T O R S |<a name="line.91"></a>
<span class="sourceLineNo">092</span> ============================================*/<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span> /**<a name="line.94"></a>
<span class="sourceLineNo">095</span> * Default constructor.<a name="line.95"></a>
<span class="sourceLineNo">096</span> */<a name="line.96"></a>
<span class="sourceLineNo">097</span> public QuartzSessionValidationScheduler() {<a name="line.97"></a>
<span class="sourceLineNo">098</span> }<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span> /**<a name="line.100"></a>
<span class="sourceLineNo">101</span> * Constructor that specifies the session manager that should be used for validating sessions.<a name="line.101"></a>
<span class="sourceLineNo">102</span> *<a name="line.102"></a>
<span class="sourceLineNo">103</span> * @param sessionManager the &lt;tt&gt;SessionManager&lt;/tt&gt; that should be used to validate sessions.<a name="line.103"></a>
<span class="sourceLineNo">104</span> */<a name="line.104"></a>
<span class="sourceLineNo">105</span> public QuartzSessionValidationScheduler(ValidatingSessionManager sessionManager) {<a name="line.105"></a>
<span class="sourceLineNo">106</span> this.sessionManager = sessionManager;<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span> /*--------------------------------------------<a name="line.109"></a>
<span class="sourceLineNo">110</span> | A C C E S S O R S / M O D I F I E R S |<a name="line.110"></a>
<span class="sourceLineNo">111</span> ============================================*/<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> protected Scheduler getScheduler() throws SchedulerException {<a name="line.113"></a>
<span class="sourceLineNo">114</span> if (scheduler == null) {<a name="line.114"></a>
<span class="sourceLineNo">115</span> scheduler = StdSchedulerFactory.getDefaultScheduler();<a name="line.115"></a>
<span class="sourceLineNo">116</span> schedulerImplicitlyCreated = true;<a name="line.116"></a>
<span class="sourceLineNo">117</span> }<a name="line.117"></a>
<span class="sourceLineNo">118</span> return scheduler;<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span> public void setScheduler(Scheduler scheduler) {<a name="line.121"></a>
<span class="sourceLineNo">122</span> this.scheduler = scheduler;<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span> public void setSessionManager(ValidatingSessionManager sessionManager) {<a name="line.125"></a>
<span class="sourceLineNo">126</span> this.sessionManager = sessionManager;<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> public boolean isEnabled() {<a name="line.129"></a>
<span class="sourceLineNo">130</span> return this.enabled;<a name="line.130"></a>
<span class="sourceLineNo">131</span> }<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span> /**<a name="line.133"></a>
<span class="sourceLineNo">134</span> * Specifies how frequently (in milliseconds) this Scheduler will call the<a name="line.134"></a>
<span class="sourceLineNo">135</span> * {@link org.apache.shiro.session.mgt.ValidatingSessionManager#validateSessions() ValidatingSessionManager#validateSessions()} method.<a name="line.135"></a>
<span class="sourceLineNo">136</span> *<a name="line.136"></a>
<span class="sourceLineNo">137</span> * &lt;p&gt;Unless this method is called, the default value is {@link #DEFAULT_SESSION_VALIDATION_INTERVAL}.<a name="line.137"></a>
<span class="sourceLineNo">138</span> *<a name="line.138"></a>
<span class="sourceLineNo">139</span> * @param sessionValidationInterval<a name="line.139"></a>
<span class="sourceLineNo">140</span> */<a name="line.140"></a>
<span class="sourceLineNo">141</span> public void setSessionValidationInterval(long sessionValidationInterval) {<a name="line.141"></a>
<span class="sourceLineNo">142</span> this.sessionValidationInterval = sessionValidationInterval;<a name="line.142"></a>
<span class="sourceLineNo">143</span> }<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span> /*--------------------------------------------<a name="line.145"></a>
<span class="sourceLineNo">146</span> | M E T H O D S |<a name="line.146"></a>
<span class="sourceLineNo">147</span> ============================================*/<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span> /**<a name="line.149"></a>
<span class="sourceLineNo">150</span> * Starts session validation by creating a Quartz simple trigger, linking it to<a name="line.150"></a>
<span class="sourceLineNo">151</span> * the {@link QuartzSessionValidationJob}, and scheduling it with the Quartz scheduler.<a name="line.151"></a>
<span class="sourceLineNo">152</span> */<a name="line.152"></a>
<span class="sourceLineNo">153</span> public void enableSessionValidation() {<a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span> if (log.isDebugEnabled()) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> log.debug("Scheduling session validation job using Quartz with " +<a name="line.156"></a>
<span class="sourceLineNo">157</span> "session validation interval of [" + sessionValidationInterval + "]ms...");<a name="line.157"></a>
<span class="sourceLineNo">158</span> }<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
<span class="sourceLineNo">160</span> try {<a name="line.160"></a>
<span class="sourceLineNo">161</span> TriggerBuilder&lt;SimpleTrigger&gt; triggerBuilder =<a name="line.161"></a>
<span class="sourceLineNo">162</span> TriggerBuilder.newTrigger()<a name="line.162"></a>
<span class="sourceLineNo">163</span> .withIdentity(getClass().getName(), Scheduler.DEFAULT_GROUP)<a name="line.163"></a>
<span class="sourceLineNo">164</span> .withSchedule(simpleSchedule()<a name="line.164"></a>
<span class="sourceLineNo">165</span> .withIntervalInMilliseconds(sessionValidationInterval)<a name="line.165"></a>
<span class="sourceLineNo">166</span> .withRepeatCount(SimpleTrigger.REPEAT_INDEFINITELY));<a name="line.166"></a>
<span class="sourceLineNo">167</span> SimpleTrigger trigger = triggerBuilder.build();<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span> JobDetail detail = JobBuilder.newJob(QuartzSessionValidationJob.class)<a name="line.169"></a>
<span class="sourceLineNo">170</span> .withIdentity(JOB_NAME, Scheduler.DEFAULT_GROUP).build();<a name="line.170"></a>
<span class="sourceLineNo">171</span> detail.getJobDataMap().put(QuartzSessionValidationJob.SESSION_MANAGER_KEY, sessionManager);<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span> Scheduler scheduler = getScheduler();<a name="line.173"></a>
<span class="sourceLineNo">174</span><a name="line.174"></a>
<span class="sourceLineNo">175</span> scheduler.scheduleJob(detail, trigger);<a name="line.175"></a>
<span class="sourceLineNo">176</span> if (schedulerImplicitlyCreated) {<a name="line.176"></a>
<span class="sourceLineNo">177</span> scheduler.start();<a name="line.177"></a>
<span class="sourceLineNo">178</span> if (log.isDebugEnabled()) {<a name="line.178"></a>
<span class="sourceLineNo">179</span> log.debug("Successfully started implicitly created Quartz Scheduler instance.");<a name="line.179"></a>
<span class="sourceLineNo">180</span> }<a name="line.180"></a>
<span class="sourceLineNo">181</span> }<a name="line.181"></a>
<span class="sourceLineNo">182</span> this.enabled = true;<a name="line.182"></a>
<span class="sourceLineNo">183</span><a name="line.183"></a>
<span class="sourceLineNo">184</span> if (log.isDebugEnabled()) {<a name="line.184"></a>
<span class="sourceLineNo">185</span> log.debug("Session validation job successfully scheduled with Quartz.");<a name="line.185"></a>
<span class="sourceLineNo">186</span> }<a name="line.186"></a>
<span class="sourceLineNo">187</span><a name="line.187"></a>
<span class="sourceLineNo">188</span> } catch (SchedulerException e) {<a name="line.188"></a>
<span class="sourceLineNo">189</span> if (log.isErrorEnabled()) {<a name="line.189"></a>
<span class="sourceLineNo">190</span> log.error("Error starting the Quartz session validation job. Session validation may not occur.", e);<a name="line.190"></a>
<span class="sourceLineNo">191</span> }<a name="line.191"></a>
<span class="sourceLineNo">192</span> }<a name="line.192"></a>
<span class="sourceLineNo">193</span> }<a name="line.193"></a>
<span class="sourceLineNo">194</span><a name="line.194"></a>
<span class="sourceLineNo">195</span> public void disableSessionValidation() {<a name="line.195"></a>
<span class="sourceLineNo">196</span> if (log.isDebugEnabled()) {<a name="line.196"></a>
<span class="sourceLineNo">197</span> log.debug("Stopping Quartz session validation job...");<a name="line.197"></a>
<span class="sourceLineNo">198</span> }<a name="line.198"></a>
<span class="sourceLineNo">199</span><a name="line.199"></a>
<span class="sourceLineNo">200</span> Scheduler scheduler;<a name="line.200"></a>
<span class="sourceLineNo">201</span> try {<a name="line.201"></a>
<span class="sourceLineNo">202</span> scheduler = getScheduler();<a name="line.202"></a>
<span class="sourceLineNo">203</span> if (scheduler == null) {<a name="line.203"></a>
<span class="sourceLineNo">204</span> if (log.isWarnEnabled()) {<a name="line.204"></a>
<span class="sourceLineNo">205</span> log.warn("getScheduler() method returned a null Quartz scheduler, which is unexpected. Please " +<a name="line.205"></a>
<span class="sourceLineNo">206</span> "check your configuration and/or implementation. Returning quietly since there is no " +<a name="line.206"></a>
<span class="sourceLineNo">207</span> "validation job to remove (scheduler does not exist).");<a name="line.207"></a>
<span class="sourceLineNo">208</span> }<a name="line.208"></a>
<span class="sourceLineNo">209</span> return;<a name="line.209"></a>
<span class="sourceLineNo">210</span> }<a name="line.210"></a>
<span class="sourceLineNo">211</span> } catch (SchedulerException e) {<a name="line.211"></a>
<span class="sourceLineNo">212</span> if (log.isWarnEnabled()) {<a name="line.212"></a>
<span class="sourceLineNo">213</span> log.warn("Unable to acquire Quartz Scheduler. Ignoring and returning (already stopped?)", e);<a name="line.213"></a>
<span class="sourceLineNo">214</span> }<a name="line.214"></a>
<span class="sourceLineNo">215</span> return;<a name="line.215"></a>
<span class="sourceLineNo">216</span> }<a name="line.216"></a>
<span class="sourceLineNo">217</span><a name="line.217"></a>
<span class="sourceLineNo">218</span> try {<a name="line.218"></a>
<span class="sourceLineNo">219</span> scheduler.unscheduleJob(TriggerKey.triggerKey(JOB_NAME, Scheduler.DEFAULT_GROUP));<a name="line.219"></a>
<span class="sourceLineNo">220</span> if (log.isDebugEnabled()) {<a name="line.220"></a>
<span class="sourceLineNo">221</span> log.debug("Quartz session validation job stopped successfully.");<a name="line.221"></a>
<span class="sourceLineNo">222</span> }<a name="line.222"></a>
<span class="sourceLineNo">223</span> } catch (SchedulerException e) {<a name="line.223"></a>
<span class="sourceLineNo">224</span> if (log.isDebugEnabled()) {<a name="line.224"></a>
<span class="sourceLineNo">225</span> log.debug("Could not cleanly remove SessionValidationJob from Quartz scheduler. " +<a name="line.225"></a>
<span class="sourceLineNo">226</span> "Ignoring and stopping.", e);<a name="line.226"></a>
<span class="sourceLineNo">227</span> }<a name="line.227"></a>
<span class="sourceLineNo">228</span> }<a name="line.228"></a>
<span class="sourceLineNo">229</span><a name="line.229"></a>
<span class="sourceLineNo">230</span> this.enabled = false;<a name="line.230"></a>
<span class="sourceLineNo">231</span><a name="line.231"></a>
<span class="sourceLineNo">232</span> if (schedulerImplicitlyCreated) {<a name="line.232"></a>
<span class="sourceLineNo">233</span> try {<a name="line.233"></a>
<span class="sourceLineNo">234</span> scheduler.shutdown();<a name="line.234"></a>
<span class="sourceLineNo">235</span> } catch (SchedulerException e) {<a name="line.235"></a>
<span class="sourceLineNo">236</span> if (log.isWarnEnabled()) {<a name="line.236"></a>
<span class="sourceLineNo">237</span> log.warn("Unable to cleanly shutdown implicitly created Quartz Scheduler instance.", e);<a name="line.237"></a>
<span class="sourceLineNo">238</span> }<a name="line.238"></a>
<span class="sourceLineNo">239</span> } finally {<a name="line.239"></a>
<span class="sourceLineNo">240</span> setScheduler(null);<a name="line.240"></a>
<span class="sourceLineNo">241</span> schedulerImplicitlyCreated = false;<a name="line.241"></a>
<span class="sourceLineNo">242</span> }<a name="line.242"></a>
<span class="sourceLineNo">243</span> }<a name="line.243"></a>
<span class="sourceLineNo">244</span><a name="line.244"></a>
<span class="sourceLineNo">245</span><a name="line.245"></a>
<span class="sourceLineNo">246</span> }<a name="line.246"></a>
<span class="sourceLineNo">247</span>}<a name="line.247"></a>
</pre>
</div>
</body>
</html>