| <!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.AbstractCacheManager;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.shiro.cache.Cache;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.shiro.cache.CacheException;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.shiro.cache.MapCache;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.shiro.session.Session;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span><a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.io.Serializable;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>/**<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * SessionDAO implementation that relies on an enterprise caching product as the EIS system of record for all sessions.<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * It is expected that an injected {@link org.apache.shiro.cache.Cache Cache} or<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * {@link org.apache.shiro.cache.CacheManager CacheManager} is backed by an enterprise caching product that can support<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * all application sessions and/or provide disk paging for resilient data storage.<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * <h2>Production Note</h2><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * This implementation defaults to using an in-memory map-based {@code CacheManager}, which is great for testing but<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * will typically not scale for production environments and could easily cause {@code OutOfMemoryException}s. Just<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * don't forget to configure<b>*</b> an instance of this class with a production-grade {@code CacheManager} that can<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * handle disk paging for large numbers of sessions and you'll be fine.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <p/><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <b>*</b>If you configure Shiro's {@code SecurityManager} instance with such a {@code CacheManager}, it will be<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * automatically applied to an instance of this class and you won't need to explicitly set it in configuration.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * <h3>Implementation Details</h3><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * This implementation relies heavily on the {@link CachingSessionDAO parent class}'s transparent caching behavior for<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * all storage operations with the enterprise caching product. Because the parent class uses a {@code Cache} or<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * {@code CacheManager} to perform caching, and the cache is considered the system of record, nothing further needs to<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * be done for the {@link #doReadSession}, {@link #doUpdate} and {@link #doDelete} method implementations. This class<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * implements those methods as required by the parent class, but they essentially do nothing.<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> *<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * @since 1.0<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> */<a name="line.51"></a> |
| <span class="sourceLineNo">052</span>public class EnterpriseCacheSessionDAO extends CachingSessionDAO {<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> public EnterpriseCacheSessionDAO() {<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> setCacheManager(new AbstractCacheManager() {<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> @Override<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> protected Cache<Serializable, Session> createCache(String name) throws CacheException {<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> return new MapCache<Serializable, Session>(name, new ConcurrentHashMap<Serializable, Session>());<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> }<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> protected Serializable doCreate(Session session) {<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> Serializable sessionId = generateSessionId(session);<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> assignSessionId(session, sessionId);<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> return sessionId;<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> }<a name="line.67"></a> |
| <span class="sourceLineNo">068</span><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> protected Session doReadSession(Serializable sessionId) {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> return null; //should never execute because this implementation relies on parent class to access cache, which<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> //is where all sessions reside - it is the cache implementation that determines if the<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> //cache is memory only or disk-persistent, etc.<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> }<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> protected void doUpdate(Session session) {<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> //does nothing - parent class persists to cache.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> }<a name="line.77"></a> |
| <span class="sourceLineNo">078</span><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> protected void doDelete(Session session) {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> //does nothing - parent class removes from cache.<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> }<a name="line.81"></a> |
| <span class="sourceLineNo">082</span>}<a name="line.82"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
