| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> |
| <title>ValidatingSessionManager xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/session/mgt/ValidatingSessionManager.html">View Javadoc</a></div><pre> |
| |
| <a name="1" href="#1">1</a> <em class="jxr_comment">/*</em> |
| <a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a name="9" href="#9">9</a> <em class="jxr_comment"> *</em> |
| <a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> |
| <a name="11" href="#11">11</a> <em class="jxr_comment"> *</em> |
| <a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a name="18" href="#18">18</a> <em class="jxr_comment"> */</em> |
| <a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.session.mgt; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="22" href="#22">22</a> <em class="jxr_javadoccomment"> * A ValidatingSessionManager is a SessionManager that can proactively validate any or all sessions</em> |
| <a name="23" href="#23">23</a> <em class="jxr_javadoccomment"> * that may be expired.</em> |
| <a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * @since 0.1</em> |
| <a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../org/apache/shiro/session/mgt/ValidatingSessionManager.html">ValidatingSessionManager</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/session/mgt/SessionManager.html">SessionManager</a> { |
| <a name="28" href="#28">28</a> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * Performs session validation for all open/active sessions in the system (those that</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * have not been stopped or expired), and validates each one. If a session is</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * found to be invalid (e.g. it has expired), it is updated and saved to the EIS.</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * This method is necessary in order to handle orphaned sessions and is expected to be run at</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * a regular interval, such as once an hour, once a day or once a week, etc.</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * The &quot;best&quot; frequency to run this method is entirely dependent upon the application</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * and would be based on factors such as performance, average number of active users, hours of</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * least activity, and other things.</em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * Most enterprise applications use a request/response programming model.</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * This is obvious in the case of web applications due to the HTTP protocol, but it is</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * equally true of remote client applications making remote method invocations. The server</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * essentially sits idle and only &quot;works&quot; when responding to client requests and/or</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * method invocations. This type of model is particularly efficent since it means the</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * security system only has to validate a session during those cases. Such</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * &quot;lazy&quot; behavior enables the system to lie stateless and/or idle and only incur</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * overhead for session validation when necessary.</em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * However, if a client forgets to log-out, or in the event of a server failure, it is</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * possible for sessions to be orphaned since no further requests would utilize that session.</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * Because of these lower-probability cases, it might be required to regularly clean-up the sessions</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * maintained by the system, especially if sessions are backed by a persistent data store.</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * Even in applications that aren't primarily based on a request/response model,</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * such as those that use enterprise asynchronous messaging (where data is pushed to</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * a client without first receiving a client request), it is almost always acceptable to</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * utilize this lazy approach and run this method at defined interval.</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * Systems that want to proactively validate individual sessions may simply call the</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * {@link #getSession(SessionKey) getSession(SessionKey)} method on any</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * {@code ValidatingSessionManager} instance as that method is expected to</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * validate the session before retrieving it. Note that even with proactive calls to {@code getSession},</em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * this {@code validateSessions()} method should be invoked regularly anyway to <em>guarantee</em> no</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * orphans exist.</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * <b>Note:</b> Shiro supports automatic execution of this method at a regular interval</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * by using {@link SessionValidationScheduler}s. The Shiro default SecurityManager implementations</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * needing session validation will create and use one by default if one is not provided by the</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * application configuration.</em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="71" href="#71">71</a> <strong class="jxr_keyword">void</strong> validateSessions(); |
| <a name="72" href="#72">72</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
