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