hunt.shiro.session.mgt.AbstractSessionManager source code

1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements.  See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership.  The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the
7  * "License"); you may not use this file except in compliance
8  * with the License.  You may obtain a copy of the License at
9  *
10  *     http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing,
13  * software distributed under the License is distributed on an
14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15  * KIND, either express or implied.  See the License for the
16  * specific language governing permissions and limitations
17  * under the License.
18  */
19 module hunt.shiro.session.mgt.AbstractSessionManager;
20 
21 import hunt.shiro.session.mgt.SessionManager;
22 import hunt.shiro.session.Session;
23 
24 /**
25  * Base abstract class of the {@link SessionManager SessionManager} interface, enabling configuration of an
26  * application-wide {@link #getGlobalSessionTimeout() globalSessionTimeout}.  Default global session timeout is
27  * {@code 30} minutes.
28  *
29  */
30 //TODO - deprecate this class (see SHIRO-240):
31 //This is only here to make available a common attribute 'globalSessionTimeout' to subclasses, particularly to make it
32 //available to both AbstractNativeSessionManager and ServletContainerSessionManager subclass trees.  However, the
33 //ServletContainerSessionManager implementation does not use this value
34 //(see https://issues.apache.org/jira/browse/SHIRO-240 for why).  That means that only the Native session managers
35 //need a globalSessionTimeout property, making this class unnecessary.
36 abstract class AbstractSessionManager : SessionManager {
37 
38     protected enum long MILLIS_PER_SECOND = 1000;
39     protected enum long MILLIS_PER_MINUTE = 60 * MILLIS_PER_SECOND;
40     protected enum long MILLIS_PER_HOUR = 60 * MILLIS_PER_MINUTE;
41 
42     /**
43      * Default main session timeout value, equal to {@code 30} minutes.
44      */
45     enum long DEFAULT_GLOBAL_SESSION_TIMEOUT =  30 * MILLIS_PER_MINUTE; // 60 * MILLIS_PER_SECOND; // 
46 
47     private long globalSessionTimeout = DEFAULT_GLOBAL_SESSION_TIMEOUT;
48 
49     this() {
50     }
51 
52     /**
53      * Returns the system-wide default time in milliseconds that any session may remain idle before expiring. This
54      * value is the main default for all sessions and may be overridden on a <em>per-session</em> basis by calling
55      * {@code Subject.getSession().}{@link Session#setTimeout setTimeout(long)} if so desired.
56      * <ul>
57      * <li>A negative return value means sessions never expire.</li>
58      * <li>A non-negative return value (0 or greater) means session timeout will occur as expected.</li>
59      * </ul>
60      * <p/>
61      * Unless overridden via the {@link #setGlobalSessionTimeout} method, the default value is
62      * {@link #DEFAULT_GLOBAL_SESSION_TIMEOUT}.
63      *
64      * @return the time in milliseconds that any session may remain idle before expiring.
65      */
66      long getGlobalSessionTimeout() {
67         return this.globalSessionTimeout;
68     }
69 
70     /**
71      * Sets the system-wide default time in milliseconds that any session may remain idle before expiring. This
72      * value is the main default for all sessions and may be overridden on a <em>per-session</em> basis by calling
73      * {@code Subject.getSession().}{@link Session#setTimeout setTimeout(long)} if so desired.
74      * <p/>
75      * <ul>
76      * <li>A negative return value means sessions never expire.</li>
77      * <li>A non-negative return value (0 or greater) means session timeout will occur as expected.</li>
78      * </ul>
79      * <p/>
80      * Unless overridden by calling this method, the default value is {@link #DEFAULT_GLOBAL_SESSION_TIMEOUT}.
81      *
82      * @param globalSessionTimeout the time in milliseconds that any session may remain idle before expiring.
83      */
84      void setGlobalSessionTimeout(long globalSessionTimeout) {
85         this.globalSessionTimeout = globalSessionTimeout;
86     }
87 }