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