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