| <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> /**<a name="line.21"></a> |
| <FONT color="green">022</FONT> * A ValidatingSessionManager is a SessionManager that can proactively validate any or all sessions<a name="line.22"></a> |
| <FONT color="green">023</FONT> * that may be expired.<a name="line.23"></a> |
| <FONT color="green">024</FONT> *<a name="line.24"></a> |
| <FONT color="green">025</FONT> * @since 0.1<a name="line.25"></a> |
| <FONT color="green">026</FONT> */<a name="line.26"></a> |
| <FONT color="green">027</FONT> public interface ValidatingSessionManager extends SessionManager {<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> * Performs session validation for all open/active sessions in the system (those that<a name="line.30"></a> |
| <FONT color="green">031</FONT> * have not been stopped or expired), and validates each one. If a session is<a name="line.31"></a> |
| <FONT color="green">032</FONT> * found to be invalid (e.g. it has expired), it is updated and saved to the EIS.<a name="line.32"></a> |
| <FONT color="green">033</FONT> * <p/><a name="line.33"></a> |
| <FONT color="green">034</FONT> * This method is necessary in order to handle orphaned sessions and is expected to be run at<a name="line.34"></a> |
| <FONT color="green">035</FONT> * a regular interval, such as once an hour, once a day or once a week, etc.<a name="line.35"></a> |
| <FONT color="green">036</FONT> * The &quot;best&quot; frequency to run this method is entirely dependent upon the application<a name="line.36"></a> |
| <FONT color="green">037</FONT> * and would be based on factors such as performance, average number of active users, hours of<a name="line.37"></a> |
| <FONT color="green">038</FONT> * least activity, and other things.<a name="line.38"></a> |
| <FONT color="green">039</FONT> * <p/><a name="line.39"></a> |
| <FONT color="green">040</FONT> * Most enterprise applications use a request/response programming model.<a name="line.40"></a> |
| <FONT color="green">041</FONT> * This is obvious in the case of web applications due to the HTTP protocol, but it is<a name="line.41"></a> |
| <FONT color="green">042</FONT> * equally true of remote client applications making remote method invocations. The server<a name="line.42"></a> |
| <FONT color="green">043</FONT> * essentially sits idle and only &quot;works&quot; when responding to client requests and/or<a name="line.43"></a> |
| <FONT color="green">044</FONT> * method invocations. This type of model is particularly efficent since it means the<a name="line.44"></a> |
| <FONT color="green">045</FONT> * security system only has to validate a session during those cases. Such<a name="line.45"></a> |
| <FONT color="green">046</FONT> * &quot;lazy&quot; behavior enables the system to lie stateless and/or idle and only incur<a name="line.46"></a> |
| <FONT color="green">047</FONT> * overhead for session validation when necessary.<a name="line.47"></a> |
| <FONT color="green">048</FONT> * <p/><a name="line.48"></a> |
| <FONT color="green">049</FONT> * However, if a client forgets to log-out, or in the event of a server failure, it is<a name="line.49"></a> |
| <FONT color="green">050</FONT> * possible for sessions to be orphaned since no further requests would utilize that session.<a name="line.50"></a> |
| <FONT color="green">051</FONT> * Because of these lower-probability cases, it might be required to regularly clean-up the sessions<a name="line.51"></a> |
| <FONT color="green">052</FONT> * maintained by the system, especially if sessions are backed by a persistent data store.<a name="line.52"></a> |
| <FONT color="green">053</FONT> * <p/><a name="line.53"></a> |
| <FONT color="green">054</FONT> * Even in applications that aren't primarily based on a request/response model,<a name="line.54"></a> |
| <FONT color="green">055</FONT> * such as those that use enterprise asynchronous messaging (where data is pushed to<a name="line.55"></a> |
| <FONT color="green">056</FONT> * a client without first receiving a client request), it is almost always acceptable to<a name="line.56"></a> |
| <FONT color="green">057</FONT> * utilize this lazy approach and run this method at defined interval.<a name="line.57"></a> |
| <FONT color="green">058</FONT> * <p/><a name="line.58"></a> |
| <FONT color="green">059</FONT> * Systems that want to proactively validate individual sessions may simply call the<a name="line.59"></a> |
| <FONT color="green">060</FONT> * {@link #getSession(SessionKey) getSession(SessionKey)} method on any<a name="line.60"></a> |
| <FONT color="green">061</FONT> * {@code ValidatingSessionManager} instance as that method is expected to<a name="line.61"></a> |
| <FONT color="green">062</FONT> * validate the session before retrieving it. Note that even with proactive calls to {@code getSession},<a name="line.62"></a> |
| <FONT color="green">063</FONT> * this {@code validateSessions()} method should be invoked regularly anyway to <em>guarantee</em> no<a name="line.63"></a> |
| <FONT color="green">064</FONT> * orphans exist.<a name="line.64"></a> |
| <FONT color="green">065</FONT> * <p/><a name="line.65"></a> |
| <FONT color="green">066</FONT> * <b>Note:</b> Shiro supports automatic execution of this method at a regular interval<a name="line.66"></a> |
| <FONT color="green">067</FONT> * by using {@link SessionValidationScheduler}s. The Shiro default SecurityManager implementations<a name="line.67"></a> |
| <FONT color="green">068</FONT> * needing session validation will create and use one by default if one is not provided by the<a name="line.68"></a> |
| <FONT color="green">069</FONT> * application configuration.<a name="line.69"></a> |
| <FONT color="green">070</FONT> */<a name="line.70"></a> |
| <FONT color="green">071</FONT> void validateSessions();<a name="line.71"></a> |
| <FONT color="green">072</FONT> }<a name="line.72"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
