blob: 2e753718020d667492c81469916a14ebeecd252a [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.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.session.Session;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.shiro.session.UnknownSessionException;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.shiro.util.CollectionUtils;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.slf4j.Logger;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.slf4j.LoggerFactory;<a name="line.25"></a>
<FONT color="green">026</FONT> <a name="line.26"></a>
<FONT color="green">027</FONT> import java.io.Serializable;<a name="line.27"></a>
<FONT color="green">028</FONT> import java.util.Collection;<a name="line.28"></a>
<FONT color="green">029</FONT> import java.util.Collections;<a name="line.29"></a>
<FONT color="green">030</FONT> import java.util.concurrent.ConcurrentHashMap;<a name="line.30"></a>
<FONT color="green">031</FONT> import java.util.concurrent.ConcurrentMap;<a name="line.31"></a>
<FONT color="green">032</FONT> <a name="line.32"></a>
<FONT color="green">033</FONT> <a name="line.33"></a>
<FONT color="green">034</FONT> /**<a name="line.34"></a>
<FONT color="green">035</FONT> * Simple memory-based implementation of the SessionDAO that stores all of its sessions in an in-memory<a name="line.35"></a>
<FONT color="green">036</FONT> * {@link ConcurrentMap}. &lt;b&gt;This implementation does not page to disk and is therefore unsuitable for applications<a name="line.36"></a>
<FONT color="green">037</FONT> * that could experience a large amount of sessions&lt;/b&gt; and would therefore cause {@code OutOfMemoryException}s. It is<a name="line.37"></a>
<FONT color="green">038</FONT> * &lt;em&gt;not&lt;/em&gt; recommended for production use in most environments.<a name="line.38"></a>
<FONT color="green">039</FONT> * &lt;h2&gt;Memory Restrictions&lt;/h2&gt;<a name="line.39"></a>
<FONT color="green">040</FONT> * If your application is expected to host many sessions beyond what can be stored in the<a name="line.40"></a>
<FONT color="green">041</FONT> * memory available to the JVM, it is highly recommended to use a different {@code SessionDAO} implementation which<a name="line.41"></a>
<FONT color="green">042</FONT> * uses a more expansive or permanent backing data store.<a name="line.42"></a>
<FONT color="green">043</FONT> * &lt;p/&gt;<a name="line.43"></a>
<FONT color="green">044</FONT> * In this case, it is recommended to instead use a custom<a name="line.44"></a>
<FONT color="green">045</FONT> * {@link CachingSessionDAO} implementation that communicates with a higher-capacity data store of your choice<a name="line.45"></a>
<FONT color="green">046</FONT> * (file system, database, etc).<a name="line.46"></a>
<FONT color="green">047</FONT> * &lt;h2&gt;Changes in 1.0&lt;/h2&gt;<a name="line.47"></a>
<FONT color="green">048</FONT> * This implementation prior to 1.0 used to subclass the {@link CachingSessionDAO}, but this caused problems with many<a name="line.48"></a>
<FONT color="green">049</FONT> * cache implementations that would expunge entries due to TTL settings, resulting in Sessions that would be randomly<a name="line.49"></a>
<FONT color="green">050</FONT> * (and permanently) lost. The Shiro 1.0 release refactored this implementation to be 100% memory-based (without<a name="line.50"></a>
<FONT color="green">051</FONT> * {@code Cache} usage to avoid this problem.<a name="line.51"></a>
<FONT color="green">052</FONT> *<a name="line.52"></a>
<FONT color="green">053</FONT> * @see CachingSessionDAO<a name="line.53"></a>
<FONT color="green">054</FONT> * @since 0.1<a name="line.54"></a>
<FONT color="green">055</FONT> */<a name="line.55"></a>
<FONT color="green">056</FONT> public class MemorySessionDAO extends AbstractSessionDAO {<a name="line.56"></a>
<FONT color="green">057</FONT> <a name="line.57"></a>
<FONT color="green">058</FONT> private static final Logger log = LoggerFactory.getLogger(MemorySessionDAO.class);<a name="line.58"></a>
<FONT color="green">059</FONT> <a name="line.59"></a>
<FONT color="green">060</FONT> private ConcurrentMap&lt;Serializable, Session&gt; sessions;<a name="line.60"></a>
<FONT color="green">061</FONT> <a name="line.61"></a>
<FONT color="green">062</FONT> public MemorySessionDAO() {<a name="line.62"></a>
<FONT color="green">063</FONT> this.sessions = new ConcurrentHashMap&lt;Serializable, Session&gt;();<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> protected Serializable doCreate(Session session) {<a name="line.66"></a>
<FONT color="green">067</FONT> Serializable sessionId = generateSessionId(session);<a name="line.67"></a>
<FONT color="green">068</FONT> assignSessionId(session, sessionId);<a name="line.68"></a>
<FONT color="green">069</FONT> storeSession(sessionId, session);<a name="line.69"></a>
<FONT color="green">070</FONT> return sessionId;<a name="line.70"></a>
<FONT color="green">071</FONT> }<a name="line.71"></a>
<FONT color="green">072</FONT> <a name="line.72"></a>
<FONT color="green">073</FONT> protected Session storeSession(Serializable id, Session session) {<a name="line.73"></a>
<FONT color="green">074</FONT> if (id == null) {<a name="line.74"></a>
<FONT color="green">075</FONT> throw new NullPointerException("id argument cannot be null.");<a name="line.75"></a>
<FONT color="green">076</FONT> }<a name="line.76"></a>
<FONT color="green">077</FONT> return sessions.putIfAbsent(id, session);<a name="line.77"></a>
<FONT color="green">078</FONT> }<a name="line.78"></a>
<FONT color="green">079</FONT> <a name="line.79"></a>
<FONT color="green">080</FONT> protected Session doReadSession(Serializable sessionId) {<a name="line.80"></a>
<FONT color="green">081</FONT> return sessions.get(sessionId);<a name="line.81"></a>
<FONT color="green">082</FONT> }<a name="line.82"></a>
<FONT color="green">083</FONT> <a name="line.83"></a>
<FONT color="green">084</FONT> public void update(Session session) throws UnknownSessionException {<a name="line.84"></a>
<FONT color="green">085</FONT> storeSession(session.getId(), session);<a name="line.85"></a>
<FONT color="green">086</FONT> }<a name="line.86"></a>
<FONT color="green">087</FONT> <a name="line.87"></a>
<FONT color="green">088</FONT> public void delete(Session session) {<a name="line.88"></a>
<FONT color="green">089</FONT> if (session == null) {<a name="line.89"></a>
<FONT color="green">090</FONT> throw new NullPointerException("session argument cannot be null.");<a name="line.90"></a>
<FONT color="green">091</FONT> }<a name="line.91"></a>
<FONT color="green">092</FONT> Serializable id = session.getId();<a name="line.92"></a>
<FONT color="green">093</FONT> if (id != null) {<a name="line.93"></a>
<FONT color="green">094</FONT> sessions.remove(id);<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> public Collection&lt;Session&gt; getActiveSessions() {<a name="line.98"></a>
<FONT color="green">099</FONT> Collection&lt;Session&gt; values = sessions.values();<a name="line.99"></a>
<FONT color="green">100</FONT> if (CollectionUtils.isEmpty(values)) {<a name="line.100"></a>
<FONT color="green">101</FONT> return Collections.emptySet();<a name="line.101"></a>
<FONT color="green">102</FONT> } else {<a name="line.102"></a>
<FONT color="green">103</FONT> return Collections.unmodifiableCollection(values);<a name="line.103"></a>
<FONT color="green">104</FONT> }<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>
</PRE>
</BODY>
</HTML>