blob: f9dc35e83df326cac9db899908b54331456cbafb [file] [log] [blame]
<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;<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.CacheManager;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.shiro.cache.CacheManagerAware;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.shiro.session.Session;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.shiro.session.UnknownSessionException;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.shiro.session.mgt.eis.MemorySessionDAO;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.shiro.session.mgt.eis.SessionDAO;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.slf4j.Logger;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.slf4j.LoggerFactory;<a name="line.28"></a>
<FONT color="green">029</FONT> <a name="line.29"></a>
<FONT color="green">030</FONT> import java.io.Serializable;<a name="line.30"></a>
<FONT color="green">031</FONT> import java.util.Collection;<a name="line.31"></a>
<FONT color="green">032</FONT> import java.util.Collections;<a name="line.32"></a>
<FONT color="green">033</FONT> import java.util.Date;<a name="line.33"></a>
<FONT color="green">034</FONT> <a name="line.34"></a>
<FONT color="green">035</FONT> /**<a name="line.35"></a>
<FONT color="green">036</FONT> * Default business-tier implementation of a {@link ValidatingSessionManager}. All session CRUD operations are<a name="line.36"></a>
<FONT color="green">037</FONT> * delegated to an internal {@link SessionDAO}.<a name="line.37"></a>
<FONT color="green">038</FONT> *<a name="line.38"></a>
<FONT color="green">039</FONT> * @since 0.1<a name="line.39"></a>
<FONT color="green">040</FONT> */<a name="line.40"></a>
<FONT color="green">041</FONT> public class DefaultSessionManager extends AbstractValidatingSessionManager implements CacheManagerAware {<a name="line.41"></a>
<FONT color="green">042</FONT> <a name="line.42"></a>
<FONT color="green">043</FONT> //TODO - complete JavaDoc<a name="line.43"></a>
<FONT color="green">044</FONT> <a name="line.44"></a>
<FONT color="green">045</FONT> private static final Logger log = LoggerFactory.getLogger(DefaultSessionManager.class);<a name="line.45"></a>
<FONT color="green">046</FONT> <a name="line.46"></a>
<FONT color="green">047</FONT> private SessionFactory sessionFactory;<a name="line.47"></a>
<FONT color="green">048</FONT> <a name="line.48"></a>
<FONT color="green">049</FONT> protected SessionDAO sessionDAO; //todo - move SessionDAO up to AbstractValidatingSessionManager?<a name="line.49"></a>
<FONT color="green">050</FONT> <a name="line.50"></a>
<FONT color="green">051</FONT> private CacheManager cacheManager;<a name="line.51"></a>
<FONT color="green">052</FONT> <a name="line.52"></a>
<FONT color="green">053</FONT> private boolean deleteInvalidSessions;<a name="line.53"></a>
<FONT color="green">054</FONT> <a name="line.54"></a>
<FONT color="green">055</FONT> public DefaultSessionManager() {<a name="line.55"></a>
<FONT color="green">056</FONT> this.deleteInvalidSessions = true;<a name="line.56"></a>
<FONT color="green">057</FONT> this.sessionFactory = new SimpleSessionFactory();<a name="line.57"></a>
<FONT color="green">058</FONT> this.sessionDAO = new MemorySessionDAO();<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> public void setSessionDAO(SessionDAO sessionDAO) {<a name="line.61"></a>
<FONT color="green">062</FONT> this.sessionDAO = sessionDAO;<a name="line.62"></a>
<FONT color="green">063</FONT> applyCacheManagerToSessionDAO();<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> public SessionDAO getSessionDAO() {<a name="line.66"></a>
<FONT color="green">067</FONT> return this.sessionDAO;<a name="line.67"></a>
<FONT color="green">068</FONT> }<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> * Returns the {@code SessionFactory} used to generate new {@link Session} instances. The default instance<a name="line.71"></a>
<FONT color="green">072</FONT> * is a {@link SimpleSessionFactory}.<a name="line.72"></a>
<FONT color="green">073</FONT> *<a name="line.73"></a>
<FONT color="green">074</FONT> * @return the {@code SessionFactory} used to generate new {@link Session} instances.<a name="line.74"></a>
<FONT color="green">075</FONT> * @since 1.0<a name="line.75"></a>
<FONT color="green">076</FONT> */<a name="line.76"></a>
<FONT color="green">077</FONT> public SessionFactory getSessionFactory() {<a name="line.77"></a>
<FONT color="green">078</FONT> return sessionFactory;<a name="line.78"></a>
<FONT color="green">079</FONT> }<a name="line.79"></a>
<FONT color="green">080</FONT> <a name="line.80"></a>
<FONT color="green">081</FONT> /**<a name="line.81"></a>
<FONT color="green">082</FONT> * Sets the {@code SessionFactory} used to generate new {@link Session} instances. The default instance<a name="line.82"></a>
<FONT color="green">083</FONT> * is a {@link SimpleSessionFactory}.<a name="line.83"></a>
<FONT color="green">084</FONT> *<a name="line.84"></a>
<FONT color="green">085</FONT> * @param sessionFactory the {@code SessionFactory} used to generate new {@link Session} instances.<a name="line.85"></a>
<FONT color="green">086</FONT> * @since 1.0<a name="line.86"></a>
<FONT color="green">087</FONT> */<a name="line.87"></a>
<FONT color="green">088</FONT> public void setSessionFactory(SessionFactory sessionFactory) {<a name="line.88"></a>
<FONT color="green">089</FONT> this.sessionFactory = sessionFactory;<a name="line.89"></a>
<FONT color="green">090</FONT> }<a name="line.90"></a>
<FONT color="green">091</FONT> <a name="line.91"></a>
<FONT color="green">092</FONT> /**<a name="line.92"></a>
<FONT color="green">093</FONT> * Returns {@code true} if sessions should be automatically deleted after they are discovered to be invalid,<a name="line.93"></a>
<FONT color="green">094</FONT> * {@code false} if invalid sessions will be manually deleted by some process external to Shiro's control. The<a name="line.94"></a>
<FONT color="green">095</FONT> * default is {@code true} to ensure no orphans exist in the underlying data store.<a name="line.95"></a>
<FONT color="green">096</FONT> * &lt;h4&gt;Usage&lt;/h4&gt;<a name="line.96"></a>
<FONT color="green">097</FONT> * It is ok to set this to {@code false} &lt;b&gt;&lt;em&gt;ONLY&lt;/em&gt;&lt;/b&gt; if you have some other process that you manage yourself<a name="line.97"></a>
<FONT color="green">098</FONT> * that periodically deletes invalid sessions from the backing data store over time, such as via a Quartz or Cron<a name="line.98"></a>
<FONT color="green">099</FONT> * job. If you do not do this, the invalid sessions will become 'orphans' and fill up the data store over time.<a name="line.99"></a>
<FONT color="green">100</FONT> * &lt;p/&gt;<a name="line.100"></a>
<FONT color="green">101</FONT> * This property is provided because some systems need the ability to perform querying/reporting against sessions in<a name="line.101"></a>
<FONT color="green">102</FONT> * the data store, even after they have stopped or expired. Setting this attribute to {@code false} will allow<a name="line.102"></a>
<FONT color="green">103</FONT> * such querying, but with the caveat that the application developer/configurer deletes the sessions themselves by<a name="line.103"></a>
<FONT color="green">104</FONT> * some other means (cron, quartz, etc).<a name="line.104"></a>
<FONT color="green">105</FONT> *<a name="line.105"></a>
<FONT color="green">106</FONT> * @return {@code true} if sessions should be automatically deleted after they are discovered to be invalid,<a name="line.106"></a>
<FONT color="green">107</FONT> * {@code false} if invalid sessions will be manually deleted by some process external to Shiro's control.<a name="line.107"></a>
<FONT color="green">108</FONT> * @since 1.0<a name="line.108"></a>
<FONT color="green">109</FONT> */<a name="line.109"></a>
<FONT color="green">110</FONT> public boolean isDeleteInvalidSessions() {<a name="line.110"></a>
<FONT color="green">111</FONT> return deleteInvalidSessions;<a name="line.111"></a>
<FONT color="green">112</FONT> }<a name="line.112"></a>
<FONT color="green">113</FONT> <a name="line.113"></a>
<FONT color="green">114</FONT> /**<a name="line.114"></a>
<FONT color="green">115</FONT> * Sets whether or not sessions should be automatically deleted after they are discovered to be invalid. Default<a name="line.115"></a>
<FONT color="green">116</FONT> * value is {@code true} to ensure no orphans will exist in the underlying data store.<a name="line.116"></a>
<FONT color="green">117</FONT> * &lt;h4&gt;WARNING&lt;/h4&gt;<a name="line.117"></a>
<FONT color="green">118</FONT> * Only set this value to {@code false} if you are manually going to delete sessions yourself by some process<a name="line.118"></a>
<FONT color="green">119</FONT> * (quartz, cron, etc) external to Shiro's control. See the<a name="line.119"></a>
<FONT color="green">120</FONT> * {@link #isDeleteInvalidSessions() isDeleteInvalidSessions()} JavaDoc for more.<a name="line.120"></a>
<FONT color="green">121</FONT> *<a name="line.121"></a>
<FONT color="green">122</FONT> * @param deleteInvalidSessions whether or not sessions should be automatically deleted after they are discovered<a name="line.122"></a>
<FONT color="green">123</FONT> * to be invalid.<a name="line.123"></a>
<FONT color="green">124</FONT> * @since 1.0<a name="line.124"></a>
<FONT color="green">125</FONT> */<a name="line.125"></a>
<FONT color="green">126</FONT> @SuppressWarnings({"UnusedDeclaration"})<a name="line.126"></a>
<FONT color="green">127</FONT> public void setDeleteInvalidSessions(boolean deleteInvalidSessions) {<a name="line.127"></a>
<FONT color="green">128</FONT> this.deleteInvalidSessions = deleteInvalidSessions;<a name="line.128"></a>
<FONT color="green">129</FONT> }<a name="line.129"></a>
<FONT color="green">130</FONT> <a name="line.130"></a>
<FONT color="green">131</FONT> public void setCacheManager(CacheManager cacheManager) {<a name="line.131"></a>
<FONT color="green">132</FONT> this.cacheManager = cacheManager;<a name="line.132"></a>
<FONT color="green">133</FONT> applyCacheManagerToSessionDAO();<a name="line.133"></a>
<FONT color="green">134</FONT> }<a name="line.134"></a>
<FONT color="green">135</FONT> <a name="line.135"></a>
<FONT color="green">136</FONT> /**<a name="line.136"></a>
<FONT color="green">137</FONT> * Sets the internal {@code CacheManager} on the {@code SessionDAO} if it implements the<a name="line.137"></a>
<FONT color="green">138</FONT> * {@link org.apache.shiro.cache.CacheManagerAware CacheManagerAware} interface.<a name="line.138"></a>
<FONT color="green">139</FONT> * &lt;p/&gt;<a name="line.139"></a>
<FONT color="green">140</FONT> * This method is called after setting a cacheManager via the<a name="line.140"></a>
<FONT color="green">141</FONT> * {@link #setCacheManager(org.apache.shiro.cache.CacheManager) setCacheManager} method &lt;em&gt;em&lt;/em&gt; when<a name="line.141"></a>
<FONT color="green">142</FONT> * setting a {@code SessionDAO} via the {@link #setSessionDAO} method to allow it to be propagated<a name="line.142"></a>
<FONT color="green">143</FONT> * in either case.<a name="line.143"></a>
<FONT color="green">144</FONT> *<a name="line.144"></a>
<FONT color="green">145</FONT> * @since 1.0<a name="line.145"></a>
<FONT color="green">146</FONT> */<a name="line.146"></a>
<FONT color="green">147</FONT> private void applyCacheManagerToSessionDAO() {<a name="line.147"></a>
<FONT color="green">148</FONT> if (this.cacheManager != null &amp;&amp; this.sessionDAO != null &amp;&amp; this.sessionDAO instanceof CacheManagerAware) {<a name="line.148"></a>
<FONT color="green">149</FONT> ((CacheManagerAware) this.sessionDAO).setCacheManager(this.cacheManager);<a name="line.149"></a>
<FONT color="green">150</FONT> }<a name="line.150"></a>
<FONT color="green">151</FONT> }<a name="line.151"></a>
<FONT color="green">152</FONT> <a name="line.152"></a>
<FONT color="green">153</FONT> protected Session doCreateSession(SessionContext context) {<a name="line.153"></a>
<FONT color="green">154</FONT> Session s = newSessionInstance(context);<a name="line.154"></a>
<FONT color="green">155</FONT> if (log.isTraceEnabled()) {<a name="line.155"></a>
<FONT color="green">156</FONT> log.trace("Creating session for host {}", s.getHost());<a name="line.156"></a>
<FONT color="green">157</FONT> }<a name="line.157"></a>
<FONT color="green">158</FONT> create(s);<a name="line.158"></a>
<FONT color="green">159</FONT> return s;<a name="line.159"></a>
<FONT color="green">160</FONT> }<a name="line.160"></a>
<FONT color="green">161</FONT> <a name="line.161"></a>
<FONT color="green">162</FONT> protected Session newSessionInstance(SessionContext context) {<a name="line.162"></a>
<FONT color="green">163</FONT> return getSessionFactory().createSession(context);<a name="line.163"></a>
<FONT color="green">164</FONT> }<a name="line.164"></a>
<FONT color="green">165</FONT> <a name="line.165"></a>
<FONT color="green">166</FONT> /**<a name="line.166"></a>
<FONT color="green">167</FONT> * Persists the given session instance to an underlying EIS (Enterprise Information System). This implementation<a name="line.167"></a>
<FONT color="green">168</FONT> * delegates and calls<a name="line.168"></a>
<FONT color="green">169</FONT> * &lt;code&gt;this.{@link SessionDAO sessionDAO}.{@link SessionDAO#create(org.apache.shiro.session.Session) create}(session);&lt;code&gt;<a name="line.169"></a>
<FONT color="green">170</FONT> *<a name="line.170"></a>
<FONT color="green">171</FONT> * @param session the Session instance to persist to the underlying EIS.<a name="line.171"></a>
<FONT color="green">172</FONT> */<a name="line.172"></a>
<FONT color="green">173</FONT> protected void create(Session session) {<a name="line.173"></a>
<FONT color="green">174</FONT> if (log.isDebugEnabled()) {<a name="line.174"></a>
<FONT color="green">175</FONT> log.debug("Creating new EIS record for new session instance [" + session + "]");<a name="line.175"></a>
<FONT color="green">176</FONT> }<a name="line.176"></a>
<FONT color="green">177</FONT> sessionDAO.create(session);<a name="line.177"></a>
<FONT color="green">178</FONT> }<a name="line.178"></a>
<FONT color="green">179</FONT> <a name="line.179"></a>
<FONT color="green">180</FONT> @Override<a name="line.180"></a>
<FONT color="green">181</FONT> protected void onStop(Session session) {<a name="line.181"></a>
<FONT color="green">182</FONT> if (session instanceof SimpleSession) {<a name="line.182"></a>
<FONT color="green">183</FONT> SimpleSession ss = (SimpleSession) session;<a name="line.183"></a>
<FONT color="green">184</FONT> Date stopTs = ss.getStopTimestamp();<a name="line.184"></a>
<FONT color="green">185</FONT> ss.setLastAccessTime(stopTs);<a name="line.185"></a>
<FONT color="green">186</FONT> }<a name="line.186"></a>
<FONT color="green">187</FONT> onChange(session);<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> @Override<a name="line.190"></a>
<FONT color="green">191</FONT> protected void afterStopped(Session session) {<a name="line.191"></a>
<FONT color="green">192</FONT> if (isDeleteInvalidSessions()) {<a name="line.192"></a>
<FONT color="green">193</FONT> delete(session);<a name="line.193"></a>
<FONT color="green">194</FONT> }<a name="line.194"></a>
<FONT color="green">195</FONT> }<a name="line.195"></a>
<FONT color="green">196</FONT> <a name="line.196"></a>
<FONT color="green">197</FONT> protected void onExpiration(Session session) {<a name="line.197"></a>
<FONT color="green">198</FONT> if (session instanceof SimpleSession) {<a name="line.198"></a>
<FONT color="green">199</FONT> ((SimpleSession) session).setExpired(true);<a name="line.199"></a>
<FONT color="green">200</FONT> }<a name="line.200"></a>
<FONT color="green">201</FONT> onChange(session);<a name="line.201"></a>
<FONT color="green">202</FONT> }<a name="line.202"></a>
<FONT color="green">203</FONT> <a name="line.203"></a>
<FONT color="green">204</FONT> @Override<a name="line.204"></a>
<FONT color="green">205</FONT> protected void afterExpired(Session session) {<a name="line.205"></a>
<FONT color="green">206</FONT> if (isDeleteInvalidSessions()) {<a name="line.206"></a>
<FONT color="green">207</FONT> delete(session);<a name="line.207"></a>
<FONT color="green">208</FONT> }<a name="line.208"></a>
<FONT color="green">209</FONT> }<a name="line.209"></a>
<FONT color="green">210</FONT> <a name="line.210"></a>
<FONT color="green">211</FONT> protected void onChange(Session session) {<a name="line.211"></a>
<FONT color="green">212</FONT> sessionDAO.update(session);<a name="line.212"></a>
<FONT color="green">213</FONT> }<a name="line.213"></a>
<FONT color="green">214</FONT> <a name="line.214"></a>
<FONT color="green">215</FONT> protected Session retrieveSession(SessionKey sessionKey) throws UnknownSessionException {<a name="line.215"></a>
<FONT color="green">216</FONT> Serializable sessionId = getSessionId(sessionKey);<a name="line.216"></a>
<FONT color="green">217</FONT> if (sessionId == null) {<a name="line.217"></a>
<FONT color="green">218</FONT> log.debug("Unable to resolve session ID from SessionKey [{}]. Returning null to indicate a " +<a name="line.218"></a>
<FONT color="green">219</FONT> "session could not be found.", sessionKey);<a name="line.219"></a>
<FONT color="green">220</FONT> return null;<a name="line.220"></a>
<FONT color="green">221</FONT> }<a name="line.221"></a>
<FONT color="green">222</FONT> Session s = retrieveSessionFromDataSource(sessionId);<a name="line.222"></a>
<FONT color="green">223</FONT> if (s == null) {<a name="line.223"></a>
<FONT color="green">224</FONT> //session ID was provided, meaning one is expected to be found, but we couldn't find one:<a name="line.224"></a>
<FONT color="green">225</FONT> String msg = "Could not find session with ID [" + sessionId + "]";<a name="line.225"></a>
<FONT color="green">226</FONT> throw new UnknownSessionException(msg);<a name="line.226"></a>
<FONT color="green">227</FONT> }<a name="line.227"></a>
<FONT color="green">228</FONT> return s;<a name="line.228"></a>
<FONT color="green">229</FONT> }<a name="line.229"></a>
<FONT color="green">230</FONT> <a name="line.230"></a>
<FONT color="green">231</FONT> protected Serializable getSessionId(SessionKey sessionKey) {<a name="line.231"></a>
<FONT color="green">232</FONT> return sessionKey.getSessionId();<a name="line.232"></a>
<FONT color="green">233</FONT> }<a name="line.233"></a>
<FONT color="green">234</FONT> <a name="line.234"></a>
<FONT color="green">235</FONT> protected Session retrieveSessionFromDataSource(Serializable sessionId) throws UnknownSessionException {<a name="line.235"></a>
<FONT color="green">236</FONT> return sessionDAO.readSession(sessionId);<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> protected void delete(Session session) {<a name="line.239"></a>
<FONT color="green">240</FONT> sessionDAO.delete(session);<a name="line.240"></a>
<FONT color="green">241</FONT> }<a name="line.241"></a>
<FONT color="green">242</FONT> <a name="line.242"></a>
<FONT color="green">243</FONT> protected Collection&lt;Session&gt; getActiveSessions() {<a name="line.243"></a>
<FONT color="green">244</FONT> Collection&lt;Session&gt; active = sessionDAO.getActiveSessions();<a name="line.244"></a>
<FONT color="green">245</FONT> return active != null ? active : Collections.&lt;Session&gt;emptySet();<a name="line.245"></a>
<FONT color="green">246</FONT> }<a name="line.246"></a>
<FONT color="green">247</FONT> <a name="line.247"></a>
<FONT color="green">248</FONT> }<a name="line.248"></a>
</PRE>
</BODY>
</HTML>