blob: 4a6184794340ee51470fdc426d7aac0c9ed6c9d6 [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.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.authz.AuthorizationException;<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.SessionException;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.shiro.session.mgt.DefaultSessionManager;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.shiro.session.mgt.SessionContext;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.shiro.session.mgt.SessionKey;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.shiro.session.mgt.SessionManager;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.apache.shiro.util.LifecycleUtils;<a name="line.29"></a>
<FONT color="green">030</FONT> <a name="line.30"></a>
<FONT color="green">031</FONT> <a name="line.31"></a>
<FONT color="green">032</FONT> /**<a name="line.32"></a>
<FONT color="green">033</FONT> * Shiro support of a {@link SecurityManager} class hierarchy that delegates all<a name="line.33"></a>
<FONT color="green">034</FONT> * {@link org.apache.shiro.session.Session session} operations to a wrapped<a name="line.34"></a>
<FONT color="green">035</FONT> * {@link org.apache.shiro.session.mgt.SessionManager SessionManager} instance. That is, this class implements the<a name="line.35"></a>
<FONT color="green">036</FONT> * methods in the {@link SessionManager SessionManager} interface, but in reality, those methods are merely<a name="line.36"></a>
<FONT color="green">037</FONT> * passthrough calls to the underlying 'real' {@code SessionManager} instance.<a name="line.37"></a>
<FONT color="green">038</FONT> * &lt;p/&gt;<a name="line.38"></a>
<FONT color="green">039</FONT> * The remaining {@code SecurityManager} methods not implemented by this class or its parents are left to be<a name="line.39"></a>
<FONT color="green">040</FONT> * implemented by subclasses.<a name="line.40"></a>
<FONT color="green">041</FONT> * &lt;p/&gt;<a name="line.41"></a>
<FONT color="green">042</FONT> * In keeping with the other classes in this hierarchy and Shiro's desire to minimize configuration whenever<a name="line.42"></a>
<FONT color="green">043</FONT> * possible, suitable default instances for all dependencies will be created upon instantiation.<a name="line.43"></a>
<FONT color="green">044</FONT> *<a name="line.44"></a>
<FONT color="green">045</FONT> * @since 0.9<a name="line.45"></a>
<FONT color="green">046</FONT> */<a name="line.46"></a>
<FONT color="green">047</FONT> public abstract class SessionsSecurityManager extends AuthorizingSecurityManager {<a name="line.47"></a>
<FONT color="green">048</FONT> <a name="line.48"></a>
<FONT color="green">049</FONT> /**<a name="line.49"></a>
<FONT color="green">050</FONT> * The internal delegate &lt;code&gt;SessionManager&lt;/code&gt; used by this security manager that manages all the<a name="line.50"></a>
<FONT color="green">051</FONT> * application's {@link Session Session}s.<a name="line.51"></a>
<FONT color="green">052</FONT> */<a name="line.52"></a>
<FONT color="green">053</FONT> private SessionManager sessionManager;<a name="line.53"></a>
<FONT color="green">054</FONT> <a name="line.54"></a>
<FONT color="green">055</FONT> /**<a name="line.55"></a>
<FONT color="green">056</FONT> * Default no-arg constructor, internally creates a suitable default {@link SessionManager SessionManager} delegate<a name="line.56"></a>
<FONT color="green">057</FONT> * instance.<a name="line.57"></a>
<FONT color="green">058</FONT> */<a name="line.58"></a>
<FONT color="green">059</FONT> public SessionsSecurityManager() {<a name="line.59"></a>
<FONT color="green">060</FONT> super();<a name="line.60"></a>
<FONT color="green">061</FONT> this.sessionManager = new DefaultSessionManager();<a name="line.61"></a>
<FONT color="green">062</FONT> applyCacheManagerToSessionManager();<a name="line.62"></a>
<FONT color="green">063</FONT> }<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> * Sets the underlying delegate {@link SessionManager} instance that will be used to support this implementation's<a name="line.66"></a>
<FONT color="green">067</FONT> * &lt;tt&gt;SessionManager&lt;/tt&gt; method calls.<a name="line.67"></a>
<FONT color="green">068</FONT> * &lt;p/&gt;<a name="line.68"></a>
<FONT color="green">069</FONT> * This &lt;tt&gt;SecurityManager&lt;/tt&gt; implementation does not provide logic to support the inherited<a name="line.69"></a>
<FONT color="green">070</FONT> * &lt;tt&gt;SessionManager&lt;/tt&gt; interface, but instead delegates these calls to an internal<a name="line.70"></a>
<FONT color="green">071</FONT> * &lt;tt&gt;SessionManager&lt;/tt&gt; instance.<a name="line.71"></a>
<FONT color="green">072</FONT> * &lt;p/&gt;<a name="line.72"></a>
<FONT color="green">073</FONT> * If a &lt;tt&gt;SessionManager&lt;/tt&gt; instance is not set, a default one will be automatically created and<a name="line.73"></a>
<FONT color="green">074</FONT> * initialized appropriately for the the existing runtime environment.<a name="line.74"></a>
<FONT color="green">075</FONT> *<a name="line.75"></a>
<FONT color="green">076</FONT> * @param sessionManager delegate instance to use to support this manager's &lt;tt&gt;SessionManager&lt;/tt&gt; method calls.<a name="line.76"></a>
<FONT color="green">077</FONT> */<a name="line.77"></a>
<FONT color="green">078</FONT> public void setSessionManager(SessionManager sessionManager) {<a name="line.78"></a>
<FONT color="green">079</FONT> this.sessionManager = sessionManager;<a name="line.79"></a>
<FONT color="green">080</FONT> afterSessionManagerSet();<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>
<FONT color="green">083</FONT> protected void afterSessionManagerSet() {<a name="line.83"></a>
<FONT color="green">084</FONT> applyCacheManagerToSessionManager();<a name="line.84"></a>
<FONT color="green">085</FONT> }<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> * Returns this security manager's internal delegate {@link SessionManager SessionManager}.<a name="line.88"></a>
<FONT color="green">089</FONT> *<a name="line.89"></a>
<FONT color="green">090</FONT> * @return this security manager's internal delegate {@link SessionManager SessionManager}.<a name="line.90"></a>
<FONT color="green">091</FONT> * @see #setSessionManager(org.apache.shiro.session.mgt.SessionManager) setSessionManager<a name="line.91"></a>
<FONT color="green">092</FONT> */<a name="line.92"></a>
<FONT color="green">093</FONT> public SessionManager getSessionManager() {<a name="line.93"></a>
<FONT color="green">094</FONT> return this.sessionManager;<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> * Calls {@link org.apache.shiro.mgt.AuthorizingSecurityManager#afterCacheManagerSet() super.afterCacheManagerSet()} and then immediately calls<a name="line.98"></a>
<FONT color="green">099</FONT> * {@link #applyCacheManagerToSessionManager() applyCacheManagerToSessionManager()} to ensure the<a name="line.99"></a>
<FONT color="green">100</FONT> * &lt;code&gt;CacheManager&lt;/code&gt; is applied to the SessionManager as necessary.<a name="line.100"></a>
<FONT color="green">101</FONT> */<a name="line.101"></a>
<FONT color="green">102</FONT> protected void afterCacheManagerSet() {<a name="line.102"></a>
<FONT color="green">103</FONT> super.afterCacheManagerSet();<a name="line.103"></a>
<FONT color="green">104</FONT> applyCacheManagerToSessionManager();<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>
<FONT color="green">108</FONT> * Ensures the internal delegate &lt;code&gt;SessionManager&lt;/code&gt; is injected with the newly set<a name="line.108"></a>
<FONT color="green">109</FONT> * {@link #setCacheManager CacheManager} so it may use it for its internal caching needs.<a name="line.109"></a>
<FONT color="green">110</FONT> * &lt;p/&gt;<a name="line.110"></a>
<FONT color="green">111</FONT> * Note: This implementation only injects the CacheManager into the SessionManager if the SessionManager<a name="line.111"></a>
<FONT color="green">112</FONT> * instance implements the {@link CacheManagerAware CacheManagerAware} interface.<a name="line.112"></a>
<FONT color="green">113</FONT> */<a name="line.113"></a>
<FONT color="green">114</FONT> protected void applyCacheManagerToSessionManager() {<a name="line.114"></a>
<FONT color="green">115</FONT> if (this.sessionManager instanceof CacheManagerAware) {<a name="line.115"></a>
<FONT color="green">116</FONT> ((CacheManagerAware) this.sessionManager).setCacheManager(getCacheManager());<a name="line.116"></a>
<FONT color="green">117</FONT> }<a name="line.117"></a>
<FONT color="green">118</FONT> }<a name="line.118"></a>
<FONT color="green">119</FONT> <a name="line.119"></a>
<FONT color="green">120</FONT> public Session start(SessionContext context) throws AuthorizationException {<a name="line.120"></a>
<FONT color="green">121</FONT> return this.sessionManager.start(context);<a name="line.121"></a>
<FONT color="green">122</FONT> }<a name="line.122"></a>
<FONT color="green">123</FONT> <a name="line.123"></a>
<FONT color="green">124</FONT> public Session getSession(SessionKey key) throws SessionException {<a name="line.124"></a>
<FONT color="green">125</FONT> return this.sessionManager.getSession(key);<a name="line.125"></a>
<FONT color="green">126</FONT> }<a name="line.126"></a>
<FONT color="green">127</FONT> <a name="line.127"></a>
<FONT color="green">128</FONT> public void destroy() {<a name="line.128"></a>
<FONT color="green">129</FONT> LifecycleUtils.destroy(getSessionManager());<a name="line.129"></a>
<FONT color="green">130</FONT> this.sessionManager = null;<a name="line.130"></a>
<FONT color="green">131</FONT> super.destroy();<a name="line.131"></a>
<FONT color="green">132</FONT> }<a name="line.132"></a>
<FONT color="green">133</FONT> }<a name="line.133"></a>
</PRE>
</BODY>
</HTML>