blob: 48333e3ea8d8d66e3534a9b026a2525344fe2822 [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;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import java.util.concurrent.Executors;<a name="line.21"></a>
<FONT color="green">022</FONT> import java.util.concurrent.ScheduledExecutorService;<a name="line.22"></a>
<FONT color="green">023</FONT> import java.util.concurrent.ThreadFactory;<a name="line.23"></a>
<FONT color="green">024</FONT> import java.util.concurrent.TimeUnit;<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> <a name="line.29"></a>
<FONT color="green">030</FONT> /**<a name="line.30"></a>
<FONT color="green">031</FONT> * SessionValidationScheduler implementation that uses a<a name="line.31"></a>
<FONT color="green">032</FONT> * {@link ScheduledExecutorService} to call {@link ValidatingSessionManager#validateSessions()} every<a name="line.32"></a>
<FONT color="green">033</FONT> * &lt;em&gt;{@link #getInterval interval}&lt;/em&gt; milliseconds.<a name="line.33"></a>
<FONT color="green">034</FONT> *<a name="line.34"></a>
<FONT color="green">035</FONT> * @since 0.9<a name="line.35"></a>
<FONT color="green">036</FONT> */<a name="line.36"></a>
<FONT color="green">037</FONT> public class ExecutorServiceSessionValidationScheduler implements SessionValidationScheduler, Runnable {<a name="line.37"></a>
<FONT color="green">038</FONT> <a name="line.38"></a>
<FONT color="green">039</FONT> //TODO - complete JavaDoc<a name="line.39"></a>
<FONT color="green">040</FONT> <a name="line.40"></a>
<FONT color="green">041</FONT> /** Private internal log instance. */<a name="line.41"></a>
<FONT color="green">042</FONT> private static final Logger log = LoggerFactory.getLogger(ExecutorServiceSessionValidationScheduler.class);<a name="line.42"></a>
<FONT color="green">043</FONT> <a name="line.43"></a>
<FONT color="green">044</FONT> ValidatingSessionManager sessionManager;<a name="line.44"></a>
<FONT color="green">045</FONT> private ScheduledExecutorService service;<a name="line.45"></a>
<FONT color="green">046</FONT> private long interval = DefaultSessionManager.DEFAULT_SESSION_VALIDATION_INTERVAL;<a name="line.46"></a>
<FONT color="green">047</FONT> private boolean enabled = false;<a name="line.47"></a>
<FONT color="green">048</FONT> <a name="line.48"></a>
<FONT color="green">049</FONT> public ExecutorServiceSessionValidationScheduler() {<a name="line.49"></a>
<FONT color="green">050</FONT> super();<a name="line.50"></a>
<FONT color="green">051</FONT> }<a name="line.51"></a>
<FONT color="green">052</FONT> <a name="line.52"></a>
<FONT color="green">053</FONT> public ExecutorServiceSessionValidationScheduler(ValidatingSessionManager sessionManager) {<a name="line.53"></a>
<FONT color="green">054</FONT> this.sessionManager = sessionManager;<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> public ValidatingSessionManager getSessionManager() {<a name="line.57"></a>
<FONT color="green">058</FONT> return sessionManager;<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> public void setSessionManager(ValidatingSessionManager sessionManager) {<a name="line.61"></a>
<FONT color="green">062</FONT> this.sessionManager = sessionManager;<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> public long getInterval() {<a name="line.65"></a>
<FONT color="green">066</FONT> return interval;<a name="line.66"></a>
<FONT color="green">067</FONT> }<a name="line.67"></a>
<FONT color="green">068</FONT> <a name="line.68"></a>
<FONT color="green">069</FONT> public void setInterval(long interval) {<a name="line.69"></a>
<FONT color="green">070</FONT> this.interval = interval;<a name="line.70"></a>
<FONT color="green">071</FONT> }<a name="line.71"></a>
<FONT color="green">072</FONT> <a name="line.72"></a>
<FONT color="green">073</FONT> public boolean isEnabled() {<a name="line.73"></a>
<FONT color="green">074</FONT> return this.enabled;<a name="line.74"></a>
<FONT color="green">075</FONT> }<a name="line.75"></a>
<FONT color="green">076</FONT> <a name="line.76"></a>
<FONT color="green">077</FONT> /**<a name="line.77"></a>
<FONT color="green">078</FONT> * Creates a single thread {@link ScheduledExecutorService} to validate sessions at fixed intervals <a name="line.78"></a>
<FONT color="green">079</FONT> * and enables this scheduler. The executor is created as a daemon thread to allow JVM to shut down<a name="line.79"></a>
<FONT color="green">080</FONT> */<a name="line.80"></a>
<FONT color="green">081</FONT> //TODO Implement an integration test to test for jvm exit as part of the standalone example<a name="line.81"></a>
<FONT color="green">082</FONT> // (so we don't have to change the unit test execution model for the core module)<a name="line.82"></a>
<FONT color="green">083</FONT> public void enableSessionValidation() {<a name="line.83"></a>
<FONT color="green">084</FONT> if (this.interval &gt; 0l) {<a name="line.84"></a>
<FONT color="green">085</FONT> this.service = Executors.newSingleThreadScheduledExecutor(new ThreadFactory() { <a name="line.85"></a>
<FONT color="green">086</FONT> public Thread newThread(Runnable r) { <a name="line.86"></a>
<FONT color="green">087</FONT> Thread thread = new Thread(r); <a name="line.87"></a>
<FONT color="green">088</FONT> thread.setDaemon(true); <a name="line.88"></a>
<FONT color="green">089</FONT> return thread; <a name="line.89"></a>
<FONT color="green">090</FONT> } <a name="line.90"></a>
<FONT color="green">091</FONT> }); <a name="line.91"></a>
<FONT color="green">092</FONT> this.service.scheduleAtFixedRate(this, interval, interval, TimeUnit.MILLISECONDS);<a name="line.92"></a>
<FONT color="green">093</FONT> this.enabled = true;<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> <a name="line.96"></a>
<FONT color="green">097</FONT> public void run() {<a name="line.97"></a>
<FONT color="green">098</FONT> if (log.isDebugEnabled()) {<a name="line.98"></a>
<FONT color="green">099</FONT> log.debug("Executing session validation...");<a name="line.99"></a>
<FONT color="green">100</FONT> }<a name="line.100"></a>
<FONT color="green">101</FONT> long startTime = System.currentTimeMillis();<a name="line.101"></a>
<FONT color="green">102</FONT> this.sessionManager.validateSessions();<a name="line.102"></a>
<FONT color="green">103</FONT> long stopTime = System.currentTimeMillis();<a name="line.103"></a>
<FONT color="green">104</FONT> if (log.isDebugEnabled()) {<a name="line.104"></a>
<FONT color="green">105</FONT> log.debug("Session validation completed successfully in " + (stopTime - startTime) + " milliseconds.");<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> <a name="line.108"></a>
<FONT color="green">109</FONT> public void disableSessionValidation() {<a name="line.109"></a>
<FONT color="green">110</FONT> this.service.shutdownNow();<a name="line.110"></a>
<FONT color="green">111</FONT> this.enabled = false;<a name="line.111"></a>
<FONT color="green">112</FONT> }<a name="line.112"></a>
<FONT color="green">113</FONT> }<a name="line.113"></a>
</PRE>
</BODY>
</HTML>