| <!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">import org.apache.shiro.session.Session;</a> |
| <span class="sourceLineNo">022</span><a id="line.22"></a> |
| <span class="sourceLineNo">023</span><a id="line.23">/**</a> |
| <span class="sourceLineNo">024</span><a id="line.24"> * Base abstract class of the {@link SessionManager SessionManager} interface, enabling configuration of an</a> |
| <span class="sourceLineNo">025</span><a id="line.25"> * application-wide {@link #getGlobalSessionTimeout() globalSessionTimeout}. Default global session timeout is</a> |
| <span class="sourceLineNo">026</span><a id="line.26"> * {@code 30} minutes.</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> *</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * @since 0.1</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> */</a> |
| <span class="sourceLineNo">030</span><a id="line.30">//TODO - deprecate this class (see SHIRO-240):</a> |
| <span class="sourceLineNo">031</span><a id="line.31">//This is only here to make available a common attribute 'globalSessionTimeout' to subclasses, particularly to make it</a> |
| <span class="sourceLineNo">032</span><a id="line.32">//available to both AbstractNativeSessionManager and ServletContainerSessionManager subclass trees. However, the</a> |
| <span class="sourceLineNo">033</span><a id="line.33">//ServletContainerSessionManager implementation does not use this value</a> |
| <span class="sourceLineNo">034</span><a id="line.34">//(see https://issues.apache.org/jira/browse/SHIRO-240 for why). That means that only the Native session managers</a> |
| <span class="sourceLineNo">035</span><a id="line.35">//need a globalSessionTimeout property, making this class unnecessary.</a> |
| <span class="sourceLineNo">036</span><a id="line.36">public abstract class AbstractSessionManager implements SessionManager {</a> |
| <span class="sourceLineNo">037</span><a id="line.37"></a> |
| <span class="sourceLineNo">038</span><a id="line.38"> protected static final long MILLIS_PER_SECOND = 1000;</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> protected static final long MILLIS_PER_MINUTE = 60 * MILLIS_PER_SECOND;</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> protected static final long MILLIS_PER_HOUR = 60 * MILLIS_PER_MINUTE;</a> |
| <span class="sourceLineNo">041</span><a id="line.41"></a> |
| <span class="sourceLineNo">042</span><a id="line.42"> /**</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * Default main session timeout value, equal to {@code 30} minutes.</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> */</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> public static final long DEFAULT_GLOBAL_SESSION_TIMEOUT = 30 * MILLIS_PER_MINUTE;</a> |
| <span class="sourceLineNo">046</span><a id="line.46"></a> |
| <span class="sourceLineNo">047</span><a id="line.47"> private long globalSessionTimeout = DEFAULT_GLOBAL_SESSION_TIMEOUT;</a> |
| <span class="sourceLineNo">048</span><a id="line.48"></a> |
| <span class="sourceLineNo">049</span><a id="line.49"> public AbstractSessionManager() {</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> }</a> |
| <span class="sourceLineNo">051</span><a id="line.51"></a> |
| <span class="sourceLineNo">052</span><a id="line.52"> /**</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * Returns the system-wide default time in milliseconds that any session may remain idle before expiring. This</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * value is the main default for all sessions and may be overridden on a <em>per-session</em> basis by calling</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * {@code Subject.getSession().}{@link Session#setTimeout setTimeout(long)} if so desired.</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * <ul></a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * <li>A negative return value means sessions never expire.</li></a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * <li>A non-negative return value (0 or greater) means session timeout will occur as expected.</li></a> |
| <span class="sourceLineNo">059</span><a id="line.59"> * </ul></a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * <p/></a> |
| <span class="sourceLineNo">061</span><a id="line.61"> * Unless overridden via the {@link #setGlobalSessionTimeout} method, the default value is</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * {@link #DEFAULT_GLOBAL_SESSION_TIMEOUT}.</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> *</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> * @return the time in milliseconds that any session may remain idle before expiring.</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> */</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> public long getGlobalSessionTimeout() {</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> return this.globalSessionTimeout;</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> }</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"> * Sets the system-wide default time in milliseconds that any session may remain idle before expiring. This</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> * value is the main default for all sessions and may be overridden on a <em>per-session</em> basis by calling</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> * {@code Subject.getSession().}{@link Session#setTimeout setTimeout(long)} if so desired.</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> * <p/></a> |
| <span class="sourceLineNo">075</span><a id="line.75"> * <ul></a> |
| <span class="sourceLineNo">076</span><a id="line.76"> * <li>A negative return value means sessions never expire.</li></a> |
| <span class="sourceLineNo">077</span><a id="line.77"> * <li>A non-negative return value (0 or greater) means session timeout will occur as expected.</li></a> |
| <span class="sourceLineNo">078</span><a id="line.78"> * </ul></a> |
| <span class="sourceLineNo">079</span><a id="line.79"> * <p/></a> |
| <span class="sourceLineNo">080</span><a id="line.80"> * Unless overridden by calling this method, the default value is {@link #DEFAULT_GLOBAL_SESSION_TIMEOUT}.</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> *</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> * @param globalSessionTimeout the time in milliseconds that any session may remain idle before expiring.</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> */</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> public void setGlobalSessionTimeout(long globalSessionTimeout) {</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> this.globalSessionTimeout = globalSessionTimeout;</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> }</a> |
| <span class="sourceLineNo">087</span><a id="line.87">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
