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