| <!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;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import java.util.concurrent.Executors;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import java.util.concurrent.ScheduledExecutorService;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import java.util.concurrent.ThreadFactory;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import java.util.concurrent.TimeUnit;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import java.util.concurrent.atomic.AtomicInteger;</a> |
| <span class="sourceLineNo">026</span><a id="line.26"></a> |
| <span class="sourceLineNo">027</span><a id="line.27">import org.slf4j.Logger;</a> |
| <span class="sourceLineNo">028</span><a id="line.28">import org.slf4j.LoggerFactory;</a> |
| <span class="sourceLineNo">029</span><a id="line.29"></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"> * SessionValidationScheduler implementation that uses a</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * {@link ScheduledExecutorService} to call {@link ValidatingSessionManager#validateSessions()} every</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * <em>{@link #getInterval interval}</em> milliseconds.</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> *</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * @since 0.9</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> */</a> |
| <span class="sourceLineNo">038</span><a id="line.38">public class ExecutorServiceSessionValidationScheduler implements SessionValidationScheduler, Runnable {</a> |
| <span class="sourceLineNo">039</span><a id="line.39"></a> |
| <span class="sourceLineNo">040</span><a id="line.40"> //TODO - complete JavaDoc</a> |
| <span class="sourceLineNo">041</span><a id="line.41"></a> |
| <span class="sourceLineNo">042</span><a id="line.42"> /** Private internal log instance. */</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> private static final Logger log = LoggerFactory.getLogger(ExecutorServiceSessionValidationScheduler.class);</a> |
| <span class="sourceLineNo">044</span><a id="line.44"></a> |
| <span class="sourceLineNo">045</span><a id="line.45"> ValidatingSessionManager sessionManager;</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> private ScheduledExecutorService service;</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> private long interval = DefaultSessionManager.DEFAULT_SESSION_VALIDATION_INTERVAL;</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> private boolean enabled = false;</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> private String threadNamePrefix = "SessionValidationThread-";</a> |
| <span class="sourceLineNo">050</span><a id="line.50"></a> |
| <span class="sourceLineNo">051</span><a id="line.51"> public ExecutorServiceSessionValidationScheduler() {</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> super();</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"> public ExecutorServiceSessionValidationScheduler(ValidatingSessionManager sessionManager) {</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> this.sessionManager = sessionManager;</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> }</a> |
| <span class="sourceLineNo">058</span><a id="line.58"></a> |
| <span class="sourceLineNo">059</span><a id="line.59"> public ValidatingSessionManager getSessionManager() {</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> return sessionManager;</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> }</a> |
| <span class="sourceLineNo">062</span><a id="line.62"></a> |
| <span class="sourceLineNo">063</span><a id="line.63"> public void setSessionManager(ValidatingSessionManager sessionManager) {</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> this.sessionManager = sessionManager;</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> }</a> |
| <span class="sourceLineNo">066</span><a id="line.66"></a> |
| <span class="sourceLineNo">067</span><a id="line.67"> public long getInterval() {</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> return interval;</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"> public void setInterval(long interval) {</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> this.interval = interval;</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> }</a> |
| <span class="sourceLineNo">074</span><a id="line.74"></a> |
| <span class="sourceLineNo">075</span><a id="line.75"> public boolean isEnabled() {</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> return this.enabled;</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> }</a> |
| <span class="sourceLineNo">078</span><a id="line.78"></a> |
| <span class="sourceLineNo">079</span><a id="line.79"> public void setThreadNamePrefix(String threadNamePrefix) {</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> this.threadNamePrefix = threadNamePrefix;</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> }</a> |
| <span class="sourceLineNo">082</span><a id="line.82"></a> |
| <span class="sourceLineNo">083</span><a id="line.83"> public String getThreadNamePrefix() {</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> return this.threadNamePrefix;</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> }</a> |
| <span class="sourceLineNo">086</span><a id="line.86"></a> |
| <span class="sourceLineNo">087</span><a id="line.87"> /**</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> * Creates a single thread {@link ScheduledExecutorService} to validate sessions at fixed intervals </a> |
| <span class="sourceLineNo">089</span><a id="line.89"> * and enables this scheduler. The executor is created as a daemon thread to allow JVM to shut down</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> */</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> //TODO Implement an integration test to test for jvm exit as part of the standalone example</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> // (so we don't have to change the unit test execution model for the core module)</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> public void enableSessionValidation() {</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> if (this.interval > 0l) {</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> this.service = Executors.newSingleThreadScheduledExecutor(new ThreadFactory() { </a> |
| <span class="sourceLineNo">096</span><a id="line.96"> private final AtomicInteger count = new AtomicInteger(1);</a> |
| <span class="sourceLineNo">097</span><a id="line.97"></a> |
| <span class="sourceLineNo">098</span><a id="line.98"> public Thread newThread(Runnable r) { </a> |
| <span class="sourceLineNo">099</span><a id="line.99"> Thread thread = new Thread(r); </a> |
| <span class="sourceLineNo">100</span><a id="line.100"> thread.setDaemon(true); </a> |
| <span class="sourceLineNo">101</span><a id="line.101"> thread.setName(threadNamePrefix + count.getAndIncrement());</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> return thread; </a> |
| <span class="sourceLineNo">103</span><a id="line.103"> } </a> |
| <span class="sourceLineNo">104</span><a id="line.104"> }); </a> |
| <span class="sourceLineNo">105</span><a id="line.105"> this.service.scheduleAtFixedRate(this, interval, interval, TimeUnit.MILLISECONDS);</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> }</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> this.enabled = true;</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"> public void run() {</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> if (log.isDebugEnabled()) {</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> log.debug("Executing session validation...");</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> }</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> Thread.currentThread().setUncaughtExceptionHandler((t, e) -> {</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> log.error("Error while validating the session, the thread will be stopped and session validation disabled", e);</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> this.disableSessionValidation();</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> });</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> long startTime = System.currentTimeMillis();</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> try {</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> this.sessionManager.validateSessions();</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> } catch (RuntimeException e) {</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> log.error("Error while validating the session", e);</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> //we don't stop the thread</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> }</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> long stopTime = System.currentTimeMillis();</a> |
| <span class="sourceLineNo">126</span><a id="line.126"> if (log.isDebugEnabled()) {</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> log.debug("Session validation completed successfully in " + (stopTime - startTime) + " milliseconds.");</a> |
| <span class="sourceLineNo">128</span><a id="line.128"> }</a> |
| <span class="sourceLineNo">129</span><a id="line.129"> }</a> |
| <span class="sourceLineNo">130</span><a id="line.130"></a> |
| <span class="sourceLineNo">131</span><a id="line.131"> public void disableSessionValidation() {</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> if (this.service != null) {</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> this.service.shutdownNow();</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> }</a> |
| <span class="sourceLineNo">135</span><a id="line.135"> this.enabled = false;</a> |
| <span class="sourceLineNo">136</span><a id="line.136"> }</a> |
| <span class="sourceLineNo">137</span><a id="line.137">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
