blob: ad51efdf835f43e202a071f2ac486554746b8579 [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.quartz;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.quartz.JobBuilder;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.quartz.JobDetail;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.quartz.Scheduler;</a>
<span class="sourceLineNo">024</span><a id="line.24">import org.quartz.SchedulerException;</a>
<span class="sourceLineNo">025</span><a id="line.25">import org.quartz.SimpleTrigger;</a>
<span class="sourceLineNo">026</span><a id="line.26">import org.quartz.TriggerBuilder;</a>
<span class="sourceLineNo">027</span><a id="line.27">import org.quartz.TriggerKey;</a>
<span class="sourceLineNo">028</span><a id="line.28">import org.quartz.impl.StdSchedulerFactory;</a>
<span class="sourceLineNo">029</span><a id="line.29"></a>
<span class="sourceLineNo">030</span><a id="line.30">import org.slf4j.Logger;</a>
<span class="sourceLineNo">031</span><a id="line.31">import org.slf4j.LoggerFactory;</a>
<span class="sourceLineNo">032</span><a id="line.32"></a>
<span class="sourceLineNo">033</span><a id="line.33">import org.apache.shiro.session.mgt.DefaultSessionManager;</a>
<span class="sourceLineNo">034</span><a id="line.34">import org.apache.shiro.session.mgt.SessionValidationScheduler;</a>
<span class="sourceLineNo">035</span><a id="line.35">import org.apache.shiro.session.mgt.ValidatingSessionManager;</a>
<span class="sourceLineNo">036</span><a id="line.36"></a>
<span class="sourceLineNo">037</span><a id="line.37">import static org.quartz.SimpleScheduleBuilder.simpleSchedule;</a>
<span class="sourceLineNo">038</span><a id="line.38"></a>
<span class="sourceLineNo">039</span><a id="line.39"></a>
<span class="sourceLineNo">040</span><a id="line.40">/**</a>
<span class="sourceLineNo">041</span><a id="line.41"> * An implementation of the {@link org.apache.shiro.session.mgt.SessionValidationScheduler SessionValidationScheduler} that uses Quartz to schedule a</a>
<span class="sourceLineNo">042</span><a id="line.42"> * job to call {@link org.apache.shiro.session.mgt.ValidatingSessionManager#validateSessions()} on</a>
<span class="sourceLineNo">043</span><a id="line.43"> * a regular basis.</a>
<span class="sourceLineNo">044</span><a id="line.44"> *</a>
<span class="sourceLineNo">045</span><a id="line.45"> * @since 0.1</a>
<span class="sourceLineNo">046</span><a id="line.46"> */</a>
<span class="sourceLineNo">047</span><a id="line.47">public class QuartzSessionValidationScheduler implements SessionValidationScheduler {</a>
<span class="sourceLineNo">048</span><a id="line.48"></a>
<span class="sourceLineNo">049</span><a id="line.49"> //TODO - complete JavaDoc</a>
<span class="sourceLineNo">050</span><a id="line.50"></a>
<span class="sourceLineNo">051</span><a id="line.51"> /*--------------------------------------------</a>
<span class="sourceLineNo">052</span><a id="line.52"> | C O N S T A N T S |</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"> * The default interval at which sessions will be validated (1 hour);</a>
<span class="sourceLineNo">056</span><a id="line.56"> * This can be overridden by calling {@link #setSessionValidationInterval(long)}</a>
<span class="sourceLineNo">057</span><a id="line.57"> */</a>
<span class="sourceLineNo">058</span><a id="line.58"> public static final long DEFAULT_SESSION_VALIDATION_INTERVAL = DefaultSessionManager.DEFAULT_SESSION_VALIDATION_INTERVAL;</a>
<span class="sourceLineNo">059</span><a id="line.59"></a>
<span class="sourceLineNo">060</span><a id="line.60"> /**</a>
<span class="sourceLineNo">061</span><a id="line.61"> * The name assigned to the quartz job.</a>
<span class="sourceLineNo">062</span><a id="line.62"> */</a>
<span class="sourceLineNo">063</span><a id="line.63"> private static final String JOB_NAME = "SessionValidationJob";</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"> | I N S T A N C E V A R I A B L E S |</a>
<span class="sourceLineNo">067</span><a id="line.67"> ============================================*/</a>
<span class="sourceLineNo">068</span><a id="line.68"> private static final Logger log = LoggerFactory.getLogger(QuartzSessionValidationScheduler.class);</a>
<span class="sourceLineNo">069</span><a id="line.69"></a>
<span class="sourceLineNo">070</span><a id="line.70"> /**</a>
<span class="sourceLineNo">071</span><a id="line.71"> * The configured Quartz scheduler to use to schedule the Quartz job. If no scheduler is</a>
<span class="sourceLineNo">072</span><a id="line.72"> * configured, the scheduler will be retrieved by calling {@link StdSchedulerFactory#getDefaultScheduler()}</a>
<span class="sourceLineNo">073</span><a id="line.73"> */</a>
<span class="sourceLineNo">074</span><a id="line.74"> private Scheduler scheduler;</a>
<span class="sourceLineNo">075</span><a id="line.75"></a>
<span class="sourceLineNo">076</span><a id="line.76"> private boolean schedulerImplicitlyCreated = false;</a>
<span class="sourceLineNo">077</span><a id="line.77"></a>
<span class="sourceLineNo">078</span><a id="line.78"> private boolean enabled = false;</a>
<span class="sourceLineNo">079</span><a id="line.79"></a>
<span class="sourceLineNo">080</span><a id="line.80"> /**</a>
<span class="sourceLineNo">081</span><a id="line.81"> * The session manager used to validate sessions.</a>
<span class="sourceLineNo">082</span><a id="line.82"> */</a>
<span class="sourceLineNo">083</span><a id="line.83"> private ValidatingSessionManager sessionManager;</a>
<span class="sourceLineNo">084</span><a id="line.84"></a>
<span class="sourceLineNo">085</span><a id="line.85"> /**</a>
<span class="sourceLineNo">086</span><a id="line.86"> * The session validation interval in milliseconds.</a>
<span class="sourceLineNo">087</span><a id="line.87"> */</a>
<span class="sourceLineNo">088</span><a id="line.88"> private long sessionValidationInterval = DEFAULT_SESSION_VALIDATION_INTERVAL;</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"> | C O N S T R U C T O R S |</a>
<span class="sourceLineNo">092</span><a id="line.92"> ============================================*/</a>
<span class="sourceLineNo">093</span><a id="line.93"></a>
<span class="sourceLineNo">094</span><a id="line.94"> /**</a>
<span class="sourceLineNo">095</span><a id="line.95"> * Default constructor.</a>
<span class="sourceLineNo">096</span><a id="line.96"> */</a>
<span class="sourceLineNo">097</span><a id="line.97"> public QuartzSessionValidationScheduler() {</a>
<span class="sourceLineNo">098</span><a id="line.98"> }</a>
<span class="sourceLineNo">099</span><a id="line.99"></a>
<span class="sourceLineNo">100</span><a id="line.100"> /**</a>
<span class="sourceLineNo">101</span><a id="line.101"> * Constructor that specifies the session manager that should be used for validating sessions.</a>
<span class="sourceLineNo">102</span><a id="line.102"> *</a>
<span class="sourceLineNo">103</span><a id="line.103"> * @param sessionManager the &lt;tt&gt;SessionManager&lt;/tt&gt; that should be used to validate sessions.</a>
<span class="sourceLineNo">104</span><a id="line.104"> */</a>
<span class="sourceLineNo">105</span><a id="line.105"> public QuartzSessionValidationScheduler(ValidatingSessionManager sessionManager) {</a>
<span class="sourceLineNo">106</span><a id="line.106"> this.sessionManager = sessionManager;</a>
<span class="sourceLineNo">107</span><a id="line.107"> }</a>
<span class="sourceLineNo">108</span><a id="line.108"></a>
<span class="sourceLineNo">109</span><a id="line.109"> /*--------------------------------------------</a>
<span class="sourceLineNo">110</span><a id="line.110"> | A C C E S S O R S / M O D I F I E R S |</a>
<span class="sourceLineNo">111</span><a id="line.111"> ============================================*/</a>
<span class="sourceLineNo">112</span><a id="line.112"></a>
<span class="sourceLineNo">113</span><a id="line.113"> protected Scheduler getScheduler() throws SchedulerException {</a>
<span class="sourceLineNo">114</span><a id="line.114"> if (scheduler == null) {</a>
<span class="sourceLineNo">115</span><a id="line.115"> scheduler = StdSchedulerFactory.getDefaultScheduler();</a>
<span class="sourceLineNo">116</span><a id="line.116"> schedulerImplicitlyCreated = true;</a>
<span class="sourceLineNo">117</span><a id="line.117"> }</a>
<span class="sourceLineNo">118</span><a id="line.118"> return scheduler;</a>
<span class="sourceLineNo">119</span><a id="line.119"> }</a>
<span class="sourceLineNo">120</span><a id="line.120"></a>
<span class="sourceLineNo">121</span><a id="line.121"> public void setScheduler(Scheduler scheduler) {</a>
<span class="sourceLineNo">122</span><a id="line.122"> this.scheduler = scheduler;</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"> public void setSessionManager(ValidatingSessionManager sessionManager) {</a>
<span class="sourceLineNo">126</span><a id="line.126"> this.sessionManager = sessionManager;</a>
<span class="sourceLineNo">127</span><a id="line.127"> }</a>
<span class="sourceLineNo">128</span><a id="line.128"></a>
<span class="sourceLineNo">129</span><a id="line.129"> public boolean isEnabled() {</a>
<span class="sourceLineNo">130</span><a id="line.130"> return this.enabled;</a>
<span class="sourceLineNo">131</span><a id="line.131"> }</a>
<span class="sourceLineNo">132</span><a id="line.132"></a>
<span class="sourceLineNo">133</span><a id="line.133"> /**</a>
<span class="sourceLineNo">134</span><a id="line.134"> * Specifies how frequently (in milliseconds) this Scheduler will call the</a>
<span class="sourceLineNo">135</span><a id="line.135"> * {@link org.apache.shiro.session.mgt.ValidatingSessionManager#validateSessions() ValidatingSessionManager#validateSessions()} method.</a>
<span class="sourceLineNo">136</span><a id="line.136"> *</a>
<span class="sourceLineNo">137</span><a id="line.137"> * &lt;p&gt;Unless this method is called, the default value is {@link #DEFAULT_SESSION_VALIDATION_INTERVAL}.</a>
<span class="sourceLineNo">138</span><a id="line.138"> *</a>
<span class="sourceLineNo">139</span><a id="line.139"> * @param sessionValidationInterval</a>
<span class="sourceLineNo">140</span><a id="line.140"> */</a>
<span class="sourceLineNo">141</span><a id="line.141"> public void setSessionValidationInterval(long sessionValidationInterval) {</a>
<span class="sourceLineNo">142</span><a id="line.142"> this.sessionValidationInterval = sessionValidationInterval;</a>
<span class="sourceLineNo">143</span><a id="line.143"> }</a>
<span class="sourceLineNo">144</span><a id="line.144"></a>
<span class="sourceLineNo">145</span><a id="line.145"> /*--------------------------------------------</a>
<span class="sourceLineNo">146</span><a id="line.146"> | M E T H O D S |</a>
<span class="sourceLineNo">147</span><a id="line.147"> ============================================*/</a>
<span class="sourceLineNo">148</span><a id="line.148"></a>
<span class="sourceLineNo">149</span><a id="line.149"> /**</a>
<span class="sourceLineNo">150</span><a id="line.150"> * Starts session validation by creating a Quartz simple trigger, linking it to</a>
<span class="sourceLineNo">151</span><a id="line.151"> * the {@link QuartzSessionValidationJob}, and scheduling it with the Quartz scheduler.</a>
<span class="sourceLineNo">152</span><a id="line.152"> */</a>
<span class="sourceLineNo">153</span><a id="line.153"> public void enableSessionValidation() {</a>
<span class="sourceLineNo">154</span><a id="line.154"></a>
<span class="sourceLineNo">155</span><a id="line.155"> if (log.isDebugEnabled()) {</a>
<span class="sourceLineNo">156</span><a id="line.156"> log.debug("Scheduling session validation job using Quartz with " +</a>
<span class="sourceLineNo">157</span><a id="line.157"> "session validation interval of [" + sessionValidationInterval + "]ms...");</a>
<span class="sourceLineNo">158</span><a id="line.158"> }</a>
<span class="sourceLineNo">159</span><a id="line.159"></a>
<span class="sourceLineNo">160</span><a id="line.160"> try {</a>
<span class="sourceLineNo">161</span><a id="line.161"> TriggerBuilder&lt;SimpleTrigger&gt; triggerBuilder =</a>
<span class="sourceLineNo">162</span><a id="line.162"> TriggerBuilder.newTrigger()</a>
<span class="sourceLineNo">163</span><a id="line.163"> .withIdentity(getClass().getName(), Scheduler.DEFAULT_GROUP)</a>
<span class="sourceLineNo">164</span><a id="line.164"> .withSchedule(simpleSchedule()</a>
<span class="sourceLineNo">165</span><a id="line.165"> .withIntervalInMilliseconds(sessionValidationInterval)</a>
<span class="sourceLineNo">166</span><a id="line.166"> .withRepeatCount(SimpleTrigger.REPEAT_INDEFINITELY));</a>
<span class="sourceLineNo">167</span><a id="line.167"> SimpleTrigger trigger = triggerBuilder.build();</a>
<span class="sourceLineNo">168</span><a id="line.168"></a>
<span class="sourceLineNo">169</span><a id="line.169"> JobDetail detail = JobBuilder.newJob(QuartzSessionValidationJob.class)</a>
<span class="sourceLineNo">170</span><a id="line.170"> .withIdentity(JOB_NAME, Scheduler.DEFAULT_GROUP).build();</a>
<span class="sourceLineNo">171</span><a id="line.171"> detail.getJobDataMap().put(QuartzSessionValidationJob.SESSION_MANAGER_KEY, sessionManager);</a>
<span class="sourceLineNo">172</span><a id="line.172"></a>
<span class="sourceLineNo">173</span><a id="line.173"> Scheduler scheduler = getScheduler();</a>
<span class="sourceLineNo">174</span><a id="line.174"></a>
<span class="sourceLineNo">175</span><a id="line.175"> scheduler.scheduleJob(detail, trigger);</a>
<span class="sourceLineNo">176</span><a id="line.176"> if (schedulerImplicitlyCreated) {</a>
<span class="sourceLineNo">177</span><a id="line.177"> scheduler.start();</a>
<span class="sourceLineNo">178</span><a id="line.178"> if (log.isDebugEnabled()) {</a>
<span class="sourceLineNo">179</span><a id="line.179"> log.debug("Successfully started implicitly created Quartz Scheduler instance.");</a>
<span class="sourceLineNo">180</span><a id="line.180"> }</a>
<span class="sourceLineNo">181</span><a id="line.181"> }</a>
<span class="sourceLineNo">182</span><a id="line.182"> this.enabled = true;</a>
<span class="sourceLineNo">183</span><a id="line.183"></a>
<span class="sourceLineNo">184</span><a id="line.184"> if (log.isDebugEnabled()) {</a>
<span class="sourceLineNo">185</span><a id="line.185"> log.debug("Session validation job successfully scheduled with Quartz.");</a>
<span class="sourceLineNo">186</span><a id="line.186"> }</a>
<span class="sourceLineNo">187</span><a id="line.187"></a>
<span class="sourceLineNo">188</span><a id="line.188"> } catch (SchedulerException e) {</a>
<span class="sourceLineNo">189</span><a id="line.189"> if (log.isErrorEnabled()) {</a>
<span class="sourceLineNo">190</span><a id="line.190"> log.error("Error starting the Quartz session validation job. Session validation may not occur.", e);</a>
<span class="sourceLineNo">191</span><a id="line.191"> }</a>
<span class="sourceLineNo">192</span><a id="line.192"> }</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"> public void disableSessionValidation() {</a>
<span class="sourceLineNo">196</span><a id="line.196"> if (log.isDebugEnabled()) {</a>
<span class="sourceLineNo">197</span><a id="line.197"> log.debug("Stopping Quartz session validation job...");</a>
<span class="sourceLineNo">198</span><a id="line.198"> }</a>
<span class="sourceLineNo">199</span><a id="line.199"></a>
<span class="sourceLineNo">200</span><a id="line.200"> Scheduler scheduler;</a>
<span class="sourceLineNo">201</span><a id="line.201"> try {</a>
<span class="sourceLineNo">202</span><a id="line.202"> scheduler = getScheduler();</a>
<span class="sourceLineNo">203</span><a id="line.203"> if (scheduler == null) {</a>
<span class="sourceLineNo">204</span><a id="line.204"> if (log.isWarnEnabled()) {</a>
<span class="sourceLineNo">205</span><a id="line.205"> log.warn("getScheduler() method returned a null Quartz scheduler, which is unexpected. Please " +</a>
<span class="sourceLineNo">206</span><a id="line.206"> "check your configuration and/or implementation. Returning quietly since there is no " +</a>
<span class="sourceLineNo">207</span><a id="line.207"> "validation job to remove (scheduler does not exist).");</a>
<span class="sourceLineNo">208</span><a id="line.208"> }</a>
<span class="sourceLineNo">209</span><a id="line.209"> return;</a>
<span class="sourceLineNo">210</span><a id="line.210"> }</a>
<span class="sourceLineNo">211</span><a id="line.211"> } catch (SchedulerException e) {</a>
<span class="sourceLineNo">212</span><a id="line.212"> if (log.isWarnEnabled()) {</a>
<span class="sourceLineNo">213</span><a id="line.213"> log.warn("Unable to acquire Quartz Scheduler. Ignoring and returning (already stopped?)", e);</a>
<span class="sourceLineNo">214</span><a id="line.214"> }</a>
<span class="sourceLineNo">215</span><a id="line.215"> return;</a>
<span class="sourceLineNo">216</span><a id="line.216"> }</a>
<span class="sourceLineNo">217</span><a id="line.217"></a>
<span class="sourceLineNo">218</span><a id="line.218"> try {</a>
<span class="sourceLineNo">219</span><a id="line.219"> scheduler.unscheduleJob(TriggerKey.triggerKey(JOB_NAME, Scheduler.DEFAULT_GROUP));</a>
<span class="sourceLineNo">220</span><a id="line.220"> if (log.isDebugEnabled()) {</a>
<span class="sourceLineNo">221</span><a id="line.221"> log.debug("Quartz session validation job stopped successfully.");</a>
<span class="sourceLineNo">222</span><a id="line.222"> }</a>
<span class="sourceLineNo">223</span><a id="line.223"> } catch (SchedulerException e) {</a>
<span class="sourceLineNo">224</span><a id="line.224"> if (log.isDebugEnabled()) {</a>
<span class="sourceLineNo">225</span><a id="line.225"> log.debug("Could not cleanly remove SessionValidationJob from Quartz scheduler. " +</a>
<span class="sourceLineNo">226</span><a id="line.226"> "Ignoring and stopping.", e);</a>
<span class="sourceLineNo">227</span><a id="line.227"> }</a>
<span class="sourceLineNo">228</span><a id="line.228"> }</a>
<span class="sourceLineNo">229</span><a id="line.229"></a>
<span class="sourceLineNo">230</span><a id="line.230"> this.enabled = false;</a>
<span class="sourceLineNo">231</span><a id="line.231"></a>
<span class="sourceLineNo">232</span><a id="line.232"> if (schedulerImplicitlyCreated) {</a>
<span class="sourceLineNo">233</span><a id="line.233"> try {</a>
<span class="sourceLineNo">234</span><a id="line.234"> scheduler.shutdown();</a>
<span class="sourceLineNo">235</span><a id="line.235"> } catch (SchedulerException e) {</a>
<span class="sourceLineNo">236</span><a id="line.236"> if (log.isWarnEnabled()) {</a>
<span class="sourceLineNo">237</span><a id="line.237"> log.warn("Unable to cleanly shutdown implicitly created Quartz Scheduler instance.", e);</a>
<span class="sourceLineNo">238</span><a id="line.238"> }</a>
<span class="sourceLineNo">239</span><a id="line.239"> } finally {</a>
<span class="sourceLineNo">240</span><a id="line.240"> setScheduler(null);</a>
<span class="sourceLineNo">241</span><a id="line.241"> schedulerImplicitlyCreated = false;</a>
<span class="sourceLineNo">242</span><a id="line.242"> }</a>
<span class="sourceLineNo">243</span><a id="line.243"> }</a>
<span class="sourceLineNo">244</span><a id="line.244"></a>
<span class="sourceLineNo">245</span><a id="line.245"></a>
<span class="sourceLineNo">246</span><a id="line.246"> }</a>
<span class="sourceLineNo">247</span><a id="line.247">}</a>
</pre>
</div>
</main>
</body>
</html>