| <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.eis;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.shiro.cache.Cache;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.cache.CacheManager;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.shiro.cache.CacheManagerAware;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.apache.shiro.session.Session;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.apache.shiro.session.UnknownSessionException;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import org.apache.shiro.session.mgt.ValidatingSession;<a name="line.26"></a> |
| <FONT color="green">027</FONT> <a name="line.27"></a> |
| <FONT color="green">028</FONT> import java.io.Serializable;<a name="line.28"></a> |
| <FONT color="green">029</FONT> import java.util.Collection;<a name="line.29"></a> |
| <FONT color="green">030</FONT> import java.util.Collections;<a name="line.30"></a> |
| <FONT color="green">031</FONT> <a name="line.31"></a> |
| <FONT color="green">032</FONT> /**<a name="line.32"></a> |
| <FONT color="green">033</FONT> * An CachingSessionDAO is a SessionDAO that provides a transparent caching layer between the components that<a name="line.33"></a> |
| <FONT color="green">034</FONT> * use it and the underlying EIS (Enterprise Information System) session backing store (for example, filesystem,<a name="line.34"></a> |
| <FONT color="green">035</FONT> * database, enterprise grid/cloud, etc).<a name="line.35"></a> |
| <FONT color="green">036</FONT> * <p/><a name="line.36"></a> |
| <FONT color="green">037</FONT> * This implementation caches all active sessions in a configured<a name="line.37"></a> |
| <FONT color="green">038</FONT> * {@link #getActiveSessionsCache() activeSessionsCache}. This property is {@code null} by default and if one is<a name="line.38"></a> |
| <FONT color="green">039</FONT> * not explicitly set, a {@link #setCacheManager cacheManager} is expected to be configured which will in turn be used<a name="line.39"></a> |
| <FONT color="green">040</FONT> * to acquire the {@code Cache} instance to use for the {@code activeSessionsCache}.<a name="line.40"></a> |
| <FONT color="green">041</FONT> * <p/><a name="line.41"></a> |
| <FONT color="green">042</FONT> * All {@code SessionDAO} methods are implemented by this class to employ<a name="line.42"></a> |
| <FONT color="green">043</FONT> * caching behavior and delegates the actual EIS operations to respective do* methods to be implemented by<a name="line.43"></a> |
| <FONT color="green">044</FONT> * subclasses (doCreate, doRead, etc).<a name="line.44"></a> |
| <FONT color="green">045</FONT> *<a name="line.45"></a> |
| <FONT color="green">046</FONT> * @since 0.2<a name="line.46"></a> |
| <FONT color="green">047</FONT> */<a name="line.47"></a> |
| <FONT color="green">048</FONT> public abstract class CachingSessionDAO extends AbstractSessionDAO implements CacheManagerAware {<a name="line.48"></a> |
| <FONT color="green">049</FONT> <a name="line.49"></a> |
| <FONT color="green">050</FONT> /**<a name="line.50"></a> |
| <FONT color="green">051</FONT> * The default active sessions cache name, equal to {@code shiro-activeSessionCache}.<a name="line.51"></a> |
| <FONT color="green">052</FONT> */<a name="line.52"></a> |
| <FONT color="green">053</FONT> public static final String ACTIVE_SESSION_CACHE_NAME = "shiro-activeSessionCache";<a name="line.53"></a> |
| <FONT color="green">054</FONT> <a name="line.54"></a> |
| <FONT color="green">055</FONT> /**<a name="line.55"></a> |
| <FONT color="green">056</FONT> * The CacheManager to use to acquire the Session cache.<a name="line.56"></a> |
| <FONT color="green">057</FONT> */<a name="line.57"></a> |
| <FONT color="green">058</FONT> private CacheManager cacheManager;<a name="line.58"></a> |
| <FONT color="green">059</FONT> <a name="line.59"></a> |
| <FONT color="green">060</FONT> /**<a name="line.60"></a> |
| <FONT color="green">061</FONT> * The Cache instance responsible for caching Sessions.<a name="line.61"></a> |
| <FONT color="green">062</FONT> */<a name="line.62"></a> |
| <FONT color="green">063</FONT> private Cache<Serializable, Session> activeSessions;<a name="line.63"></a> |
| <FONT color="green">064</FONT> <a name="line.64"></a> |
| <FONT color="green">065</FONT> /**<a name="line.65"></a> |
| <FONT color="green">066</FONT> * The name of the session cache, defaults to {@link #ACTIVE_SESSION_CACHE_NAME}.<a name="line.66"></a> |
| <FONT color="green">067</FONT> */<a name="line.67"></a> |
| <FONT color="green">068</FONT> private String activeSessionsCacheName = ACTIVE_SESSION_CACHE_NAME;<a name="line.68"></a> |
| <FONT color="green">069</FONT> <a name="line.69"></a> |
| <FONT color="green">070</FONT> /**<a name="line.70"></a> |
| <FONT color="green">071</FONT> * Default no-arg constructor.<a name="line.71"></a> |
| <FONT color="green">072</FONT> */<a name="line.72"></a> |
| <FONT color="green">073</FONT> public CachingSessionDAO() {<a name="line.73"></a> |
| <FONT color="green">074</FONT> }<a name="line.74"></a> |
| <FONT color="green">075</FONT> <a name="line.75"></a> |
| <FONT color="green">076</FONT> /**<a name="line.76"></a> |
| <FONT color="green">077</FONT> * Sets the cacheManager to use for acquiring the {@link #getActiveSessionsCache() activeSessionsCache} if<a name="line.77"></a> |
| <FONT color="green">078</FONT> * one is not configured.<a name="line.78"></a> |
| <FONT color="green">079</FONT> *<a name="line.79"></a> |
| <FONT color="green">080</FONT> * @param cacheManager the manager to use for constructing the session cache.<a name="line.80"></a> |
| <FONT color="green">081</FONT> */<a name="line.81"></a> |
| <FONT color="green">082</FONT> public void setCacheManager(CacheManager cacheManager) {<a name="line.82"></a> |
| <FONT color="green">083</FONT> this.cacheManager = cacheManager;<a name="line.83"></a> |
| <FONT color="green">084</FONT> }<a name="line.84"></a> |
| <FONT color="green">085</FONT> <a name="line.85"></a> |
| <FONT color="green">086</FONT> /**<a name="line.86"></a> |
| <FONT color="green">087</FONT> * Returns the CacheManager to use for acquiring the {@link #getActiveSessionsCache() activeSessionsCache} if<a name="line.87"></a> |
| <FONT color="green">088</FONT> * one is not configured. That is, the {@code CacheManager} will only be used if the<a name="line.88"></a> |
| <FONT color="green">089</FONT> * {@link #getActiveSessionsCache() activeSessionsCache} property is {@code null}.<a name="line.89"></a> |
| <FONT color="green">090</FONT> *<a name="line.90"></a> |
| <FONT color="green">091</FONT> * @return the CacheManager used by the implementation that creates the activeSessions Cache.<a name="line.91"></a> |
| <FONT color="green">092</FONT> */<a name="line.92"></a> |
| <FONT color="green">093</FONT> public CacheManager getCacheManager() {<a name="line.93"></a> |
| <FONT color="green">094</FONT> return cacheManager;<a name="line.94"></a> |
| <FONT color="green">095</FONT> }<a name="line.95"></a> |
| <FONT color="green">096</FONT> <a name="line.96"></a> |
| <FONT color="green">097</FONT> /**<a name="line.97"></a> |
| <FONT color="green">098</FONT> * Returns the name of the actives sessions cache to be returned by the {@code CacheManager}. Unless<a name="line.98"></a> |
| <FONT color="green">099</FONT> * overridden by {@link #setActiveSessionsCacheName(String)}, defaults to {@link #ACTIVE_SESSION_CACHE_NAME}.<a name="line.99"></a> |
| <FONT color="green">100</FONT> *<a name="line.100"></a> |
| <FONT color="green">101</FONT> * @return the name of the active sessions cache.<a name="line.101"></a> |
| <FONT color="green">102</FONT> */<a name="line.102"></a> |
| <FONT color="green">103</FONT> public String getActiveSessionsCacheName() {<a name="line.103"></a> |
| <FONT color="green">104</FONT> return activeSessionsCacheName;<a name="line.104"></a> |
| <FONT color="green">105</FONT> }<a name="line.105"></a> |
| <FONT color="green">106</FONT> <a name="line.106"></a> |
| <FONT color="green">107</FONT> /**<a name="line.107"></a> |
| <FONT color="green">108</FONT> * Sets the name of the active sessions cache to be returned by the {@code CacheManager}. Defaults to<a name="line.108"></a> |
| <FONT color="green">109</FONT> * {@link #ACTIVE_SESSION_CACHE_NAME}.<a name="line.109"></a> |
| <FONT color="green">110</FONT> *<a name="line.110"></a> |
| <FONT color="green">111</FONT> * @param activeSessionsCacheName the name of the active sessions cache to be returned by the {@code CacheManager}.<a name="line.111"></a> |
| <FONT color="green">112</FONT> */<a name="line.112"></a> |
| <FONT color="green">113</FONT> public void setActiveSessionsCacheName(String activeSessionsCacheName) {<a name="line.113"></a> |
| <FONT color="green">114</FONT> this.activeSessionsCacheName = activeSessionsCacheName;<a name="line.114"></a> |
| <FONT color="green">115</FONT> }<a name="line.115"></a> |
| <FONT color="green">116</FONT> <a name="line.116"></a> |
| <FONT color="green">117</FONT> /**<a name="line.117"></a> |
| <FONT color="green">118</FONT> * Returns the cache instance to use for storing active sessions. If one is not available (it is {@code null}),<a name="line.118"></a> |
| <FONT color="green">119</FONT> * it will be {@link CacheManager#getCache(String) acquired} from the {@link #setCacheManager configured}<a name="line.119"></a> |
| <FONT color="green">120</FONT> * {@code CacheManager} using the {@link #getActiveSessionsCacheName() activeSessionsCacheName}.<a name="line.120"></a> |
| <FONT color="green">121</FONT> *<a name="line.121"></a> |
| <FONT color="green">122</FONT> * @return the cache instance to use for storing active sessions or {@code null} if the {@code Cache} instance<a name="line.122"></a> |
| <FONT color="green">123</FONT> * should be retrieved from the<a name="line.123"></a> |
| <FONT color="green">124</FONT> */<a name="line.124"></a> |
| <FONT color="green">125</FONT> public Cache<Serializable, Session> getActiveSessionsCache() {<a name="line.125"></a> |
| <FONT color="green">126</FONT> return this.activeSessions;<a name="line.126"></a> |
| <FONT color="green">127</FONT> }<a name="line.127"></a> |
| <FONT color="green">128</FONT> <a name="line.128"></a> |
| <FONT color="green">129</FONT> /**<a name="line.129"></a> |
| <FONT color="green">130</FONT> * Sets the cache instance to use for storing active sessions. If one is not set (it remains {@code null}),<a name="line.130"></a> |
| <FONT color="green">131</FONT> * it will be {@link CacheManager#getCache(String) acquired} from the {@link #setCacheManager configured}<a name="line.131"></a> |
| <FONT color="green">132</FONT> * {@code CacheManager} using the {@link #getActiveSessionsCacheName() activeSessionsCacheName}.<a name="line.132"></a> |
| <FONT color="green">133</FONT> *<a name="line.133"></a> |
| <FONT color="green">134</FONT> * @param cache the cache instance to use for storing active sessions or {@code null} if the cache is to be<a name="line.134"></a> |
| <FONT color="green">135</FONT> * acquired from the {@link #setCacheManager configured} {@code CacheManager}.<a name="line.135"></a> |
| <FONT color="green">136</FONT> */<a name="line.136"></a> |
| <FONT color="green">137</FONT> public void setActiveSessionsCache(Cache<Serializable, Session> cache) {<a name="line.137"></a> |
| <FONT color="green">138</FONT> this.activeSessions = cache;<a name="line.138"></a> |
| <FONT color="green">139</FONT> }<a name="line.139"></a> |
| <FONT color="green">140</FONT> <a name="line.140"></a> |
| <FONT color="green">141</FONT> /**<a name="line.141"></a> |
| <FONT color="green">142</FONT> * Returns the active sessions cache, but if that cache instance is null, first lazily creates the cache instance<a name="line.142"></a> |
| <FONT color="green">143</FONT> * via the {@link #createActiveSessionsCache()} method and then returns the instance.<a name="line.143"></a> |
| <FONT color="green">144</FONT> * <p/><a name="line.144"></a> |
| <FONT color="green">145</FONT> * Note that this method will only return a non-null value code if the {@code CacheManager} has been set. If<a name="line.145"></a> |
| <FONT color="green">146</FONT> * not set, there will be no cache.<a name="line.146"></a> |
| <FONT color="green">147</FONT> *<a name="line.147"></a> |
| <FONT color="green">148</FONT> * @return the active sessions cache instance.<a name="line.148"></a> |
| <FONT color="green">149</FONT> */<a name="line.149"></a> |
| <FONT color="green">150</FONT> private Cache<Serializable, Session> getActiveSessionsCacheLazy() {<a name="line.150"></a> |
| <FONT color="green">151</FONT> if (this.activeSessions == null) {<a name="line.151"></a> |
| <FONT color="green">152</FONT> this.activeSessions = createActiveSessionsCache();<a name="line.152"></a> |
| <FONT color="green">153</FONT> }<a name="line.153"></a> |
| <FONT color="green">154</FONT> return activeSessions;<a name="line.154"></a> |
| <FONT color="green">155</FONT> }<a name="line.155"></a> |
| <FONT color="green">156</FONT> <a name="line.156"></a> |
| <FONT color="green">157</FONT> /**<a name="line.157"></a> |
| <FONT color="green">158</FONT> * Creates a cache instance used to store active sessions. Creation is done by first<a name="line.158"></a> |
| <FONT color="green">159</FONT> * {@link #getCacheManager() acquiring} the {@code CacheManager}. If the cache manager is not null, the<a name="line.159"></a> |
| <FONT color="green">160</FONT> * cache returned is that resulting from the following call:<a name="line.160"></a> |
| <FONT color="green">161</FONT> * <pre> String name = {@link #getActiveSessionsCacheName() getActiveSessionsCacheName()};<a name="line.161"></a> |
| <FONT color="green">162</FONT> * cacheManager.getCache(name);</pre><a name="line.162"></a> |
| <FONT color="green">163</FONT> *<a name="line.163"></a> |
| <FONT color="green">164</FONT> * @return a cache instance used to store active sessions, or {@code null} if the {@code CacheManager} has<a name="line.164"></a> |
| <FONT color="green">165</FONT> * not been set.<a name="line.165"></a> |
| <FONT color="green">166</FONT> */<a name="line.166"></a> |
| <FONT color="green">167</FONT> protected Cache<Serializable, Session> createActiveSessionsCache() {<a name="line.167"></a> |
| <FONT color="green">168</FONT> Cache<Serializable, Session> cache = null;<a name="line.168"></a> |
| <FONT color="green">169</FONT> CacheManager mgr = getCacheManager();<a name="line.169"></a> |
| <FONT color="green">170</FONT> if (mgr != null) {<a name="line.170"></a> |
| <FONT color="green">171</FONT> String name = getActiveSessionsCacheName();<a name="line.171"></a> |
| <FONT color="green">172</FONT> cache = mgr.getCache(name);<a name="line.172"></a> |
| <FONT color="green">173</FONT> }<a name="line.173"></a> |
| <FONT color="green">174</FONT> return cache;<a name="line.174"></a> |
| <FONT color="green">175</FONT> }<a name="line.175"></a> |
| <FONT color="green">176</FONT> <a name="line.176"></a> |
| <FONT color="green">177</FONT> /**<a name="line.177"></a> |
| <FONT color="green">178</FONT> * Calls {@code super.create(session)}, then caches the session keyed by the returned {@code sessionId}, and then<a name="line.178"></a> |
| <FONT color="green">179</FONT> * returns this {@code sessionId}.<a name="line.179"></a> |
| <FONT color="green">180</FONT> *<a name="line.180"></a> |
| <FONT color="green">181</FONT> * @param session Session object to create in the EIS and then cache.<a name="line.181"></a> |
| <FONT color="green">182</FONT> */<a name="line.182"></a> |
| <FONT color="green">183</FONT> public Serializable create(Session session) {<a name="line.183"></a> |
| <FONT color="green">184</FONT> Serializable sessionId = super.create(session);<a name="line.184"></a> |
| <FONT color="green">185</FONT> cache(session, sessionId);<a name="line.185"></a> |
| <FONT color="green">186</FONT> return sessionId;<a name="line.186"></a> |
| <FONT color="green">187</FONT> }<a name="line.187"></a> |
| <FONT color="green">188</FONT> <a name="line.188"></a> |
| <FONT color="green">189</FONT> /**<a name="line.189"></a> |
| <FONT color="green">190</FONT> * Returns the cached session with the corresponding {@code sessionId} or {@code null} if there is<a name="line.190"></a> |
| <FONT color="green">191</FONT> * no session cached under that id (or if there is no Cache).<a name="line.191"></a> |
| <FONT color="green">192</FONT> *<a name="line.192"></a> |
| <FONT color="green">193</FONT> * @param sessionId the id of the cached session to acquire.<a name="line.193"></a> |
| <FONT color="green">194</FONT> * @return the cached session with the corresponding {@code sessionId}, or {@code null} if the session<a name="line.194"></a> |
| <FONT color="green">195</FONT> * does not exist or is not cached.<a name="line.195"></a> |
| <FONT color="green">196</FONT> */<a name="line.196"></a> |
| <FONT color="green">197</FONT> protected Session getCachedSession(Serializable sessionId) {<a name="line.197"></a> |
| <FONT color="green">198</FONT> Session cached = null;<a name="line.198"></a> |
| <FONT color="green">199</FONT> if (sessionId != null) {<a name="line.199"></a> |
| <FONT color="green">200</FONT> Cache<Serializable, Session> cache = getActiveSessionsCacheLazy();<a name="line.200"></a> |
| <FONT color="green">201</FONT> if (cache != null) {<a name="line.201"></a> |
| <FONT color="green">202</FONT> cached = getCachedSession(sessionId, cache);<a name="line.202"></a> |
| <FONT color="green">203</FONT> }<a name="line.203"></a> |
| <FONT color="green">204</FONT> }<a name="line.204"></a> |
| <FONT color="green">205</FONT> return cached;<a name="line.205"></a> |
| <FONT color="green">206</FONT> }<a name="line.206"></a> |
| <FONT color="green">207</FONT> <a name="line.207"></a> |
| <FONT color="green">208</FONT> /**<a name="line.208"></a> |
| <FONT color="green">209</FONT> * Returns the Session with the specified id from the specified cache. This method simply calls<a name="line.209"></a> |
| <FONT color="green">210</FONT> * {@code cache.get(sessionId)} and can be overridden by subclasses for custom acquisition behavior.<a name="line.210"></a> |
| <FONT color="green">211</FONT> *<a name="line.211"></a> |
| <FONT color="green">212</FONT> * @param sessionId the id of the session to acquire.<a name="line.212"></a> |
| <FONT color="green">213</FONT> * @param cache the cache to acquire the session from<a name="line.213"></a> |
| <FONT color="green">214</FONT> * @return the cached session, or {@code null} if the session wasn't in the cache.<a name="line.214"></a> |
| <FONT color="green">215</FONT> */<a name="line.215"></a> |
| <FONT color="green">216</FONT> protected Session getCachedSession(Serializable sessionId, Cache<Serializable, Session> cache) {<a name="line.216"></a> |
| <FONT color="green">217</FONT> return cache.get(sessionId);<a name="line.217"></a> |
| <FONT color="green">218</FONT> }<a name="line.218"></a> |
| <FONT color="green">219</FONT> <a name="line.219"></a> |
| <FONT color="green">220</FONT> /**<a name="line.220"></a> |
| <FONT color="green">221</FONT> * Caches the specified session under the cache entry key of {@code sessionId}.<a name="line.221"></a> |
| <FONT color="green">222</FONT> *<a name="line.222"></a> |
| <FONT color="green">223</FONT> * @param session the session to cache<a name="line.223"></a> |
| <FONT color="green">224</FONT> * @param sessionId the session id, to be used as the cache entry key.<a name="line.224"></a> |
| <FONT color="green">225</FONT> * @since 1.0<a name="line.225"></a> |
| <FONT color="green">226</FONT> */<a name="line.226"></a> |
| <FONT color="green">227</FONT> protected void cache(Session session, Serializable sessionId) {<a name="line.227"></a> |
| <FONT color="green">228</FONT> if (session == null || sessionId == null) {<a name="line.228"></a> |
| <FONT color="green">229</FONT> return;<a name="line.229"></a> |
| <FONT color="green">230</FONT> }<a name="line.230"></a> |
| <FONT color="green">231</FONT> Cache<Serializable, Session> cache = getActiveSessionsCacheLazy();<a name="line.231"></a> |
| <FONT color="green">232</FONT> if (cache == null) {<a name="line.232"></a> |
| <FONT color="green">233</FONT> return;<a name="line.233"></a> |
| <FONT color="green">234</FONT> }<a name="line.234"></a> |
| <FONT color="green">235</FONT> cache(session, sessionId, cache);<a name="line.235"></a> |
| <FONT color="green">236</FONT> }<a name="line.236"></a> |
| <FONT color="green">237</FONT> <a name="line.237"></a> |
| <FONT color="green">238</FONT> /**<a name="line.238"></a> |
| <FONT color="green">239</FONT> * Caches the specified session in the given cache under the key of {@code sessionId}. This implementation<a name="line.239"></a> |
| <FONT color="green">240</FONT> * simply calls {@code cache.put(sessionId,session)} and can be overridden for custom behavior.<a name="line.240"></a> |
| <FONT color="green">241</FONT> *<a name="line.241"></a> |
| <FONT color="green">242</FONT> * @param session the session to cache<a name="line.242"></a> |
| <FONT color="green">243</FONT> * @param sessionId the id of the session, expected to be the cache key.<a name="line.243"></a> |
| <FONT color="green">244</FONT> * @param cache the cache to store the session<a name="line.244"></a> |
| <FONT color="green">245</FONT> */<a name="line.245"></a> |
| <FONT color="green">246</FONT> protected void cache(Session session, Serializable sessionId, Cache<Serializable, Session> cache) {<a name="line.246"></a> |
| <FONT color="green">247</FONT> cache.put(sessionId, session);<a name="line.247"></a> |
| <FONT color="green">248</FONT> }<a name="line.248"></a> |
| <FONT color="green">249</FONT> <a name="line.249"></a> |
| <FONT color="green">250</FONT> /**<a name="line.250"></a> |
| <FONT color="green">251</FONT> * Attempts to acquire the Session from the cache first using the session ID as the cache key. If no session<a name="line.251"></a> |
| <FONT color="green">252</FONT> * is found, {@code super.readSession(sessionId)} is called to perform the actual retrieval.<a name="line.252"></a> |
| <FONT color="green">253</FONT> *<a name="line.253"></a> |
| <FONT color="green">254</FONT> * @param sessionId the id of the session to retrieve from the EIS.<a name="line.254"></a> |
| <FONT color="green">255</FONT> * @return the session identified by {@code sessionId} in the EIS.<a name="line.255"></a> |
| <FONT color="green">256</FONT> * @throws UnknownSessionException if the id specified does not correspond to any session in the cache or EIS.<a name="line.256"></a> |
| <FONT color="green">257</FONT> */<a name="line.257"></a> |
| <FONT color="green">258</FONT> public Session readSession(Serializable sessionId) throws UnknownSessionException {<a name="line.258"></a> |
| <FONT color="green">259</FONT> Session s = getCachedSession(sessionId);<a name="line.259"></a> |
| <FONT color="green">260</FONT> if (s == null) {<a name="line.260"></a> |
| <FONT color="green">261</FONT> s = super.readSession(sessionId);<a name="line.261"></a> |
| <FONT color="green">262</FONT> }<a name="line.262"></a> |
| <FONT color="green">263</FONT> return s;<a name="line.263"></a> |
| <FONT color="green">264</FONT> }<a name="line.264"></a> |
| <FONT color="green">265</FONT> <a name="line.265"></a> |
| <FONT color="green">266</FONT> /**<a name="line.266"></a> |
| <FONT color="green">267</FONT> * Updates the state of the given session to the EIS by first delegating to<a name="line.267"></a> |
| <FONT color="green">268</FONT> * {@link #doUpdate(org.apache.shiro.session.Session)}. If the session is a {@link ValidatingSession}, it will<a name="line.268"></a> |
| <FONT color="green">269</FONT> * be added to the cache only if it is {@link ValidatingSession#isValid()} and if invalid, will be removed from the<a name="line.269"></a> |
| <FONT color="green">270</FONT> * cache. If it is not a {@code ValidatingSession} instance, it will be added to the cache in any event.<a name="line.270"></a> |
| <FONT color="green">271</FONT> *<a name="line.271"></a> |
| <FONT color="green">272</FONT> * @param session the session object to update in the EIS.<a name="line.272"></a> |
| <FONT color="green">273</FONT> * @throws UnknownSessionException if no existing EIS session record exists with the<a name="line.273"></a> |
| <FONT color="green">274</FONT> * identifier of {@link Session#getId() session.getId()}<a name="line.274"></a> |
| <FONT color="green">275</FONT> */<a name="line.275"></a> |
| <FONT color="green">276</FONT> public void update(Session session) throws UnknownSessionException {<a name="line.276"></a> |
| <FONT color="green">277</FONT> doUpdate(session);<a name="line.277"></a> |
| <FONT color="green">278</FONT> if (session instanceof ValidatingSession) {<a name="line.278"></a> |
| <FONT color="green">279</FONT> if (((ValidatingSession) session).isValid()) {<a name="line.279"></a> |
| <FONT color="green">280</FONT> cache(session, session.getId());<a name="line.280"></a> |
| <FONT color="green">281</FONT> } else {<a name="line.281"></a> |
| <FONT color="green">282</FONT> uncache(session);<a name="line.282"></a> |
| <FONT color="green">283</FONT> }<a name="line.283"></a> |
| <FONT color="green">284</FONT> } else {<a name="line.284"></a> |
| <FONT color="green">285</FONT> cache(session, session.getId());<a name="line.285"></a> |
| <FONT color="green">286</FONT> }<a name="line.286"></a> |
| <FONT color="green">287</FONT> }<a name="line.287"></a> |
| <FONT color="green">288</FONT> <a name="line.288"></a> |
| <FONT color="green">289</FONT> /**<a name="line.289"></a> |
| <FONT color="green">290</FONT> * Subclass implementation hook to actually persist the {@code Session}'s state to the underlying EIS.<a name="line.290"></a> |
| <FONT color="green">291</FONT> *<a name="line.291"></a> |
| <FONT color="green">292</FONT> * @param session the session object whose state will be propagated to the EIS.<a name="line.292"></a> |
| <FONT color="green">293</FONT> */<a name="line.293"></a> |
| <FONT color="green">294</FONT> protected abstract void doUpdate(Session session);<a name="line.294"></a> |
| <FONT color="green">295</FONT> <a name="line.295"></a> |
| <FONT color="green">296</FONT> /**<a name="line.296"></a> |
| <FONT color="green">297</FONT> * Removes the specified session from any cache and then permanently deletes the session from the EIS by<a name="line.297"></a> |
| <FONT color="green">298</FONT> * delegating to {@link #doDelete}.<a name="line.298"></a> |
| <FONT color="green">299</FONT> *<a name="line.299"></a> |
| <FONT color="green">300</FONT> * @param session the session to remove from caches and permanently delete from the EIS.<a name="line.300"></a> |
| <FONT color="green">301</FONT> */<a name="line.301"></a> |
| <FONT color="green">302</FONT> public void delete(Session session) {<a name="line.302"></a> |
| <FONT color="green">303</FONT> uncache(session);<a name="line.303"></a> |
| <FONT color="green">304</FONT> doDelete(session);<a name="line.304"></a> |
| <FONT color="green">305</FONT> }<a name="line.305"></a> |
| <FONT color="green">306</FONT> <a name="line.306"></a> |
| <FONT color="green">307</FONT> /**<a name="line.307"></a> |
| <FONT color="green">308</FONT> * Subclass implementation hook to permanently delete the given Session from the underlying EIS.<a name="line.308"></a> |
| <FONT color="green">309</FONT> *<a name="line.309"></a> |
| <FONT color="green">310</FONT> * @param session the session instance to permanently delete from the EIS.<a name="line.310"></a> |
| <FONT color="green">311</FONT> */<a name="line.311"></a> |
| <FONT color="green">312</FONT> protected abstract void doDelete(Session session);<a name="line.312"></a> |
| <FONT color="green">313</FONT> <a name="line.313"></a> |
| <FONT color="green">314</FONT> /**<a name="line.314"></a> |
| <FONT color="green">315</FONT> * Removes the specified Session from the cache.<a name="line.315"></a> |
| <FONT color="green">316</FONT> *<a name="line.316"></a> |
| <FONT color="green">317</FONT> * @param session the session to remove from the cache.<a name="line.317"></a> |
| <FONT color="green">318</FONT> */<a name="line.318"></a> |
| <FONT color="green">319</FONT> protected void uncache(Session session) {<a name="line.319"></a> |
| <FONT color="green">320</FONT> if (session == null) {<a name="line.320"></a> |
| <FONT color="green">321</FONT> return;<a name="line.321"></a> |
| <FONT color="green">322</FONT> }<a name="line.322"></a> |
| <FONT color="green">323</FONT> Serializable id = session.getId();<a name="line.323"></a> |
| <FONT color="green">324</FONT> if (id == null) {<a name="line.324"></a> |
| <FONT color="green">325</FONT> return;<a name="line.325"></a> |
| <FONT color="green">326</FONT> }<a name="line.326"></a> |
| <FONT color="green">327</FONT> Cache<Serializable, Session> cache = getActiveSessionsCacheLazy();<a name="line.327"></a> |
| <FONT color="green">328</FONT> if (cache != null) {<a name="line.328"></a> |
| <FONT color="green">329</FONT> cache.remove(id);<a name="line.329"></a> |
| <FONT color="green">330</FONT> }<a name="line.330"></a> |
| <FONT color="green">331</FONT> }<a name="line.331"></a> |
| <FONT color="green">332</FONT> <a name="line.332"></a> |
| <FONT color="green">333</FONT> /**<a name="line.333"></a> |
| <FONT color="green">334</FONT> * Returns all active sessions in the system.<a name="line.334"></a> |
| <FONT color="green">335</FONT> * <p/><a name="line.335"></a> |
| <FONT color="green">336</FONT> * <p>This implementation merely returns the sessions found in the activeSessions cache. Subclass implementations<a name="line.336"></a> |
| <FONT color="green">337</FONT> * may wish to override this method to retrieve them in a different way, perhaps by an RDBMS query or by other<a name="line.337"></a> |
| <FONT color="green">338</FONT> * means.<a name="line.338"></a> |
| <FONT color="green">339</FONT> *<a name="line.339"></a> |
| <FONT color="green">340</FONT> * @return the sessions found in the activeSessions cache.<a name="line.340"></a> |
| <FONT color="green">341</FONT> */<a name="line.341"></a> |
| <FONT color="green">342</FONT> public Collection<Session> getActiveSessions() {<a name="line.342"></a> |
| <FONT color="green">343</FONT> Cache<Serializable, Session> cache = getActiveSessionsCacheLazy();<a name="line.343"></a> |
| <FONT color="green">344</FONT> if (cache != null) {<a name="line.344"></a> |
| <FONT color="green">345</FONT> return cache.values();<a name="line.345"></a> |
| <FONT color="green">346</FONT> } else {<a name="line.346"></a> |
| <FONT color="green">347</FONT> return Collections.emptySet();<a name="line.347"></a> |
| <FONT color="green">348</FONT> }<a name="line.348"></a> |
| <FONT color="green">349</FONT> }<a name="line.349"></a> |
| <FONT color="green">350</FONT> }<a name="line.350"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
