blob: e5a7ca921efe22f49eff47ae6d41a518ddfa0d4a [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.Job;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.quartz.JobDataMap;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.quartz.JobExecutionContext;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.quartz.JobExecutionException;<a name="line.24"></a>
<FONT color="green">025</FONT> <a name="line.25"></a>
<FONT color="green">026</FONT> import org.slf4j.Logger;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.slf4j.LoggerFactory;<a name="line.27"></a>
<FONT color="green">028</FONT> <a name="line.28"></a>
<FONT color="green">029</FONT> import org.apache.shiro.session.mgt.ValidatingSessionManager;<a name="line.29"></a>
<FONT color="green">030</FONT> <a name="line.30"></a>
<FONT color="green">031</FONT> /**<a name="line.31"></a>
<FONT color="green">032</FONT> * A quartz job that basically just calls the {@link org.apache.shiro.session.mgt.ValidatingSessionManager#validateSessions()}<a name="line.32"></a>
<FONT color="green">033</FONT> * method on a configured session manager. The session manager will automatically be injected by the<a name="line.33"></a>
<FONT color="green">034</FONT> * superclass if it is in the job data map or the scheduler map.<a name="line.34"></a>
<FONT color="green">035</FONT> *<a name="line.35"></a>
<FONT color="green">036</FONT> * @since 0.1<a name="line.36"></a>
<FONT color="green">037</FONT> */<a name="line.37"></a>
<FONT color="green">038</FONT> public class QuartzSessionValidationJob implements Job {<a name="line.38"></a>
<FONT color="green">039</FONT> <a name="line.39"></a>
<FONT color="green">040</FONT> /*--------------------------------------------<a name="line.40"></a>
<FONT color="green">041</FONT> | C O N S T A N T S |<a name="line.41"></a>
<FONT color="green">042</FONT> ============================================*/<a name="line.42"></a>
<FONT color="green">043</FONT> /**<a name="line.43"></a>
<FONT color="green">044</FONT> * Key used to store the session manager in the job data map for this job.<a name="line.44"></a>
<FONT color="green">045</FONT> */<a name="line.45"></a>
<FONT color="green">046</FONT> static final String SESSION_MANAGER_KEY = "sessionManager";<a name="line.46"></a>
<FONT color="green">047</FONT> <a name="line.47"></a>
<FONT color="green">048</FONT> /*--------------------------------------------<a name="line.48"></a>
<FONT color="green">049</FONT> | I N S T A N C E V A R I A B L E S |<a name="line.49"></a>
<FONT color="green">050</FONT> ============================================*/<a name="line.50"></a>
<FONT color="green">051</FONT> private static final Logger log = LoggerFactory.getLogger(QuartzSessionValidationJob.class);<a name="line.51"></a>
<FONT color="green">052</FONT> <a name="line.52"></a>
<FONT color="green">053</FONT> /*--------------------------------------------<a name="line.53"></a>
<FONT color="green">054</FONT> | C O N S T R U C T O R S |<a name="line.54"></a>
<FONT color="green">055</FONT> ============================================*/<a name="line.55"></a>
<FONT color="green">056</FONT> <a name="line.56"></a>
<FONT color="green">057</FONT> /*--------------------------------------------<a name="line.57"></a>
<FONT color="green">058</FONT> | A C C E S S O R S / M O D I F I E R S |<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> /*--------------------------------------------<a name="line.61"></a>
<FONT color="green">062</FONT> | M E T H O D S |<a name="line.62"></a>
<FONT color="green">063</FONT> ============================================*/<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> * Called when the job is executed by quartz. This method delegates to the<a name="line.66"></a>
<FONT color="green">067</FONT> * &lt;tt&gt;validateSessions()&lt;/tt&gt; method on the associated session manager.<a name="line.67"></a>
<FONT color="green">068</FONT> *<a name="line.68"></a>
<FONT color="green">069</FONT> * @param context the Quartz job execution context for this execution.<a name="line.69"></a>
<FONT color="green">070</FONT> */<a name="line.70"></a>
<FONT color="green">071</FONT> public void execute(JobExecutionContext context) throws JobExecutionException {<a name="line.71"></a>
<FONT color="green">072</FONT> <a name="line.72"></a>
<FONT color="green">073</FONT> JobDataMap jobDataMap = context.getMergedJobDataMap();<a name="line.73"></a>
<FONT color="green">074</FONT> ValidatingSessionManager sessionManager = (ValidatingSessionManager) jobDataMap.get(SESSION_MANAGER_KEY);<a name="line.74"></a>
<FONT color="green">075</FONT> <a name="line.75"></a>
<FONT color="green">076</FONT> if (log.isDebugEnabled()) {<a name="line.76"></a>
<FONT color="green">077</FONT> log.debug("Executing session validation Quartz job...");<a name="line.77"></a>
<FONT color="green">078</FONT> }<a name="line.78"></a>
<FONT color="green">079</FONT> <a name="line.79"></a>
<FONT color="green">080</FONT> sessionManager.validateSessions();<a name="line.80"></a>
<FONT color="green">081</FONT> <a name="line.81"></a>
<FONT color="green">082</FONT> if (log.isDebugEnabled()) {<a name="line.82"></a>
<FONT color="green">083</FONT> log.debug("Session validation Quartz job complete.");<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> }<a name="line.86"></a>
</PRE>
</BODY>
</HTML>