blob: d08017d29bd430cc3896d1615f63061f6685eb84 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a>
<span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">009</span><a id="line.9"> *</a>
<span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">011</span><a id="line.11"> *</a>
<span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a>
<span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a>
<span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a>
<span class="sourceLineNo">018</span><a id="line.18"> */</a>
<span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.session.mgt.eis;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.session.Session;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.session.UnknownSessionException;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.util.CollectionUtils;</a>
<span class="sourceLineNo">024</span><a id="line.24">import org.slf4j.Logger;</a>
<span class="sourceLineNo">025</span><a id="line.25">import org.slf4j.LoggerFactory;</a>
<span class="sourceLineNo">026</span><a id="line.26"></a>
<span class="sourceLineNo">027</span><a id="line.27">import java.io.Serializable;</a>
<span class="sourceLineNo">028</span><a id="line.28">import java.util.Collection;</a>
<span class="sourceLineNo">029</span><a id="line.29">import java.util.Collections;</a>
<span class="sourceLineNo">030</span><a id="line.30">import java.util.concurrent.ConcurrentHashMap;</a>
<span class="sourceLineNo">031</span><a id="line.31">import java.util.concurrent.ConcurrentMap;</a>
<span class="sourceLineNo">032</span><a id="line.32"></a>
<span class="sourceLineNo">033</span><a id="line.33"></a>
<span class="sourceLineNo">034</span><a id="line.34">/**</a>
<span class="sourceLineNo">035</span><a id="line.35"> * Simple memory-based implementation of the SessionDAO that stores all of its sessions in an in-memory</a>
<span class="sourceLineNo">036</span><a id="line.36"> * {@link ConcurrentMap}. &lt;b&gt;This implementation does not page to disk and is therefore unsuitable for applications</a>
<span class="sourceLineNo">037</span><a id="line.37"> * that could experience a large amount of sessions&lt;/b&gt; and would therefore cause {@code OutOfMemoryException}s. It is</a>
<span class="sourceLineNo">038</span><a id="line.38"> * &lt;em&gt;not&lt;/em&gt; recommended for production use in most environments.</a>
<span class="sourceLineNo">039</span><a id="line.39"> * &lt;h2&gt;Memory Restrictions&lt;/h2&gt;</a>
<span class="sourceLineNo">040</span><a id="line.40"> * If your application is expected to host many sessions beyond what can be stored in the</a>
<span class="sourceLineNo">041</span><a id="line.41"> * memory available to the JVM, it is highly recommended to use a different {@code SessionDAO} implementation which</a>
<span class="sourceLineNo">042</span><a id="line.42"> * uses a more expansive or permanent backing data store.</a>
<span class="sourceLineNo">043</span><a id="line.43"> * &lt;p/&gt;</a>
<span class="sourceLineNo">044</span><a id="line.44"> * In this case, it is recommended to instead use a custom</a>
<span class="sourceLineNo">045</span><a id="line.45"> * {@link CachingSessionDAO} implementation that communicates with a higher-capacity data store of your choice</a>
<span class="sourceLineNo">046</span><a id="line.46"> * (file system, database, etc).</a>
<span class="sourceLineNo">047</span><a id="line.47"> * &lt;h2&gt;Changes in 1.0&lt;/h2&gt;</a>
<span class="sourceLineNo">048</span><a id="line.48"> * This implementation prior to 1.0 used to subclass the {@link CachingSessionDAO}, but this caused problems with many</a>
<span class="sourceLineNo">049</span><a id="line.49"> * cache implementations that would expunge entries due to TTL settings, resulting in Sessions that would be randomly</a>
<span class="sourceLineNo">050</span><a id="line.50"> * (and permanently) lost. The Shiro 1.0 release refactored this implementation to be 100% memory-based (without</a>
<span class="sourceLineNo">051</span><a id="line.51"> * {@code Cache} usage to avoid this problem.</a>
<span class="sourceLineNo">052</span><a id="line.52"> *</a>
<span class="sourceLineNo">053</span><a id="line.53"> * @see CachingSessionDAO</a>
<span class="sourceLineNo">054</span><a id="line.54"> * @since 0.1</a>
<span class="sourceLineNo">055</span><a id="line.55"> */</a>
<span class="sourceLineNo">056</span><a id="line.56">public class MemorySessionDAO extends AbstractSessionDAO {</a>
<span class="sourceLineNo">057</span><a id="line.57"></a>
<span class="sourceLineNo">058</span><a id="line.58"> private static final Logger log = LoggerFactory.getLogger(MemorySessionDAO.class);</a>
<span class="sourceLineNo">059</span><a id="line.59"></a>
<span class="sourceLineNo">060</span><a id="line.60"> private ConcurrentMap&lt;Serializable, Session&gt; sessions;</a>
<span class="sourceLineNo">061</span><a id="line.61"></a>
<span class="sourceLineNo">062</span><a id="line.62"> public MemorySessionDAO() {</a>
<span class="sourceLineNo">063</span><a id="line.63"> this.sessions = new ConcurrentHashMap&lt;Serializable, Session&gt;();</a>
<span class="sourceLineNo">064</span><a id="line.64"> }</a>
<span class="sourceLineNo">065</span><a id="line.65"></a>
<span class="sourceLineNo">066</span><a id="line.66"> protected Serializable doCreate(Session session) {</a>
<span class="sourceLineNo">067</span><a id="line.67"> Serializable sessionId = generateSessionId(session);</a>
<span class="sourceLineNo">068</span><a id="line.68"> assignSessionId(session, sessionId);</a>
<span class="sourceLineNo">069</span><a id="line.69"> storeSession(sessionId, session);</a>
<span class="sourceLineNo">070</span><a id="line.70"> return sessionId;</a>
<span class="sourceLineNo">071</span><a id="line.71"> }</a>
<span class="sourceLineNo">072</span><a id="line.72"></a>
<span class="sourceLineNo">073</span><a id="line.73"> protected Session storeSession(Serializable id, Session session) {</a>
<span class="sourceLineNo">074</span><a id="line.74"> if (id == null) {</a>
<span class="sourceLineNo">075</span><a id="line.75"> throw new NullPointerException("id argument cannot be null.");</a>
<span class="sourceLineNo">076</span><a id="line.76"> }</a>
<span class="sourceLineNo">077</span><a id="line.77"> return sessions.putIfAbsent(id, session);</a>
<span class="sourceLineNo">078</span><a id="line.78"> }</a>
<span class="sourceLineNo">079</span><a id="line.79"></a>
<span class="sourceLineNo">080</span><a id="line.80"> protected Session doReadSession(Serializable sessionId) {</a>
<span class="sourceLineNo">081</span><a id="line.81"> return sessions.get(sessionId);</a>
<span class="sourceLineNo">082</span><a id="line.82"> }</a>
<span class="sourceLineNo">083</span><a id="line.83"></a>
<span class="sourceLineNo">084</span><a id="line.84"> public void update(Session session) throws UnknownSessionException {</a>
<span class="sourceLineNo">085</span><a id="line.85"> storeSession(session.getId(), session);</a>
<span class="sourceLineNo">086</span><a id="line.86"> }</a>
<span class="sourceLineNo">087</span><a id="line.87"></a>
<span class="sourceLineNo">088</span><a id="line.88"> public void delete(Session session) {</a>
<span class="sourceLineNo">089</span><a id="line.89"> if (session == null) {</a>
<span class="sourceLineNo">090</span><a id="line.90"> throw new NullPointerException("session argument cannot be null.");</a>
<span class="sourceLineNo">091</span><a id="line.91"> }</a>
<span class="sourceLineNo">092</span><a id="line.92"> Serializable id = session.getId();</a>
<span class="sourceLineNo">093</span><a id="line.93"> if (id != null) {</a>
<span class="sourceLineNo">094</span><a id="line.94"> sessions.remove(id);</a>
<span class="sourceLineNo">095</span><a id="line.95"> }</a>
<span class="sourceLineNo">096</span><a id="line.96"> }</a>
<span class="sourceLineNo">097</span><a id="line.97"></a>
<span class="sourceLineNo">098</span><a id="line.98"> public Collection&lt;Session&gt; getActiveSessions() {</a>
<span class="sourceLineNo">099</span><a id="line.99"> Collection&lt;Session&gt; values = sessions.values();</a>
<span class="sourceLineNo">100</span><a id="line.100"> if (CollectionUtils.isEmpty(values)) {</a>
<span class="sourceLineNo">101</span><a id="line.101"> return Collections.emptySet();</a>
<span class="sourceLineNo">102</span><a id="line.102"> } else {</a>
<span class="sourceLineNo">103</span><a id="line.103"> return Collections.unmodifiableCollection(values);</a>
<span class="sourceLineNo">104</span><a id="line.104"> }</a>
<span class="sourceLineNo">105</span><a id="line.105"> }</a>
<span class="sourceLineNo">106</span><a id="line.106"></a>
<span class="sourceLineNo">107</span><a id="line.107">}</a>
</pre>
</div>
</main>
</body>
</html>