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