| <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.session.mgt.SimpleSession;<a name="line.23"></a> |
| <FONT color="green">024</FONT> <a name="line.24"></a> |
| <FONT color="green">025</FONT> import java.io.Serializable;<a name="line.25"></a> |
| <FONT color="green">026</FONT> <a name="line.26"></a> |
| <FONT color="green">027</FONT> <a name="line.27"></a> |
| <FONT color="green">028</FONT> /**<a name="line.28"></a> |
| <FONT color="green">029</FONT> * An abstract {@code SessionDAO} implementation that performs some sanity checks on session creation and reading and<a name="line.29"></a> |
| <FONT color="green">030</FONT> * allows for pluggable Session ID generation strategies if desired. The {@code SessionDAO}<a name="line.30"></a> |
| <FONT color="green">031</FONT> * {@link SessionDAO#update update} and {@link SessionDAO#delete delete} methods are left to<a name="line.31"></a> |
| <FONT color="green">032</FONT> * subclasses.<a name="line.32"></a> |
| <FONT color="green">033</FONT> * <h3>Session ID Generation</h3><a name="line.33"></a> |
| <FONT color="green">034</FONT> * This class also allows for plugging in a {@link SessionIdGenerator} for custom ID generation strategies. This is<a name="line.34"></a> |
| <FONT color="green">035</FONT> * optional, as the default generator is probably sufficient for most cases. Subclass implementations that do use a<a name="line.35"></a> |
| <FONT color="green">036</FONT> * generator (default or custom) will want to call the<a name="line.36"></a> |
| <FONT color="green">037</FONT> * {@link #generateSessionId(org.apache.shiro.session.Session)} method from within their {@link #doCreate}<a name="line.37"></a> |
| <FONT color="green">038</FONT> * implementations.<a name="line.38"></a> |
| <FONT color="green">039</FONT> * <p/><a name="line.39"></a> |
| <FONT color="green">040</FONT> * Subclass implementations that rely on the EIS data store to generate the ID automatically (e.g. when the session<a name="line.40"></a> |
| <FONT color="green">041</FONT> * ID is also an auto-generated primary key), they can simply ignore the {@code SessionIdGenerator} concept<a name="line.41"></a> |
| <FONT color="green">042</FONT> * entirely and just return the data store's ID from the {@link #doCreate} implementation.<a name="line.42"></a> |
| <FONT color="green">043</FONT> *<a name="line.43"></a> |
| <FONT color="green">044</FONT> * @since 1.0<a name="line.44"></a> |
| <FONT color="green">045</FONT> */<a name="line.45"></a> |
| <FONT color="green">046</FONT> public abstract class AbstractSessionDAO implements SessionDAO {<a name="line.46"></a> |
| <FONT color="green">047</FONT> <a name="line.47"></a> |
| <FONT color="green">048</FONT> /**<a name="line.48"></a> |
| <FONT color="green">049</FONT> * Optional SessionIdGenerator instance available to subclasses via the<a name="line.49"></a> |
| <FONT color="green">050</FONT> * {@link #generateSessionId(org.apache.shiro.session.Session)} method.<a name="line.50"></a> |
| <FONT color="green">051</FONT> */<a name="line.51"></a> |
| <FONT color="green">052</FONT> private SessionIdGenerator sessionIdGenerator;<a name="line.52"></a> |
| <FONT color="green">053</FONT> <a name="line.53"></a> |
| <FONT color="green">054</FONT> /**<a name="line.54"></a> |
| <FONT color="green">055</FONT> * Default no-arg constructor that defaults the {@link #setSessionIdGenerator sessionIdGenerator} to be a<a name="line.55"></a> |
| <FONT color="green">056</FONT> * {@link org.apache.shiro.session.mgt.eis.JavaUuidSessionIdGenerator}.<a name="line.56"></a> |
| <FONT color="green">057</FONT> */<a name="line.57"></a> |
| <FONT color="green">058</FONT> public AbstractSessionDAO() {<a name="line.58"></a> |
| <FONT color="green">059</FONT> this.sessionIdGenerator = new JavaUuidSessionIdGenerator();<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> * Returns the {@code SessionIdGenerator} used by the {@link #generateSessionId(org.apache.shiro.session.Session)}<a name="line.63"></a> |
| <FONT color="green">064</FONT> * method. Unless overridden by the {@link #setSessionIdGenerator(SessionIdGenerator)} method, the default instance<a name="line.64"></a> |
| <FONT color="green">065</FONT> * is a {@link JavaUuidSessionIdGenerator}.<a name="line.65"></a> |
| <FONT color="green">066</FONT> *<a name="line.66"></a> |
| <FONT color="green">067</FONT> * @return the {@code SessionIdGenerator} used by the {@link #generateSessionId(org.apache.shiro.session.Session)}<a name="line.67"></a> |
| <FONT color="green">068</FONT> * method.<a name="line.68"></a> |
| <FONT color="green">069</FONT> */<a name="line.69"></a> |
| <FONT color="green">070</FONT> public SessionIdGenerator getSessionIdGenerator() {<a name="line.70"></a> |
| <FONT color="green">071</FONT> return sessionIdGenerator;<a name="line.71"></a> |
| <FONT color="green">072</FONT> }<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> * Sets the {@code SessionIdGenerator} used by the {@link #generateSessionId(org.apache.shiro.session.Session)}<a name="line.75"></a> |
| <FONT color="green">076</FONT> * method. Unless overridden by this method, the default instance ss a {@link JavaUuidSessionIdGenerator}.<a name="line.76"></a> |
| <FONT color="green">077</FONT> *<a name="line.77"></a> |
| <FONT color="green">078</FONT> * @param sessionIdGenerator the {@code SessionIdGenerator} to use in the<a name="line.78"></a> |
| <FONT color="green">079</FONT> * {@link #generateSessionId(org.apache.shiro.session.Session)} method.<a name="line.79"></a> |
| <FONT color="green">080</FONT> */<a name="line.80"></a> |
| <FONT color="green">081</FONT> public void setSessionIdGenerator(SessionIdGenerator sessionIdGenerator) {<a name="line.81"></a> |
| <FONT color="green">082</FONT> this.sessionIdGenerator = sessionIdGenerator;<a name="line.82"></a> |
| <FONT color="green">083</FONT> }<a name="line.83"></a> |
| <FONT color="green">084</FONT> <a name="line.84"></a> |
| <FONT color="green">085</FONT> /**<a name="line.85"></a> |
| <FONT color="green">086</FONT> * Generates a new ID to be applied to the specified {@code session} instance. This method is usually called<a name="line.86"></a> |
| <FONT color="green">087</FONT> * from within a subclass's {@link #doCreate} implementation where they assign the returned id to the session<a name="line.87"></a> |
| <FONT color="green">088</FONT> * instance and then create a record with this ID in the EIS data store.<a name="line.88"></a> |
| <FONT color="green">089</FONT> * <p/><a name="line.89"></a> |
| <FONT color="green">090</FONT> * Subclass implementations backed by EIS data stores that auto-generate IDs during record creation, such as<a name="line.90"></a> |
| <FONT color="green">091</FONT> * relational databases, don't need to use this method or the {@link #getSessionIdGenerator() sessionIdGenerator}<a name="line.91"></a> |
| <FONT color="green">092</FONT> * attribute - they can simply return the data store's generated ID from the {@link #doCreate} implementation<a name="line.92"></a> |
| <FONT color="green">093</FONT> * if desired.<a name="line.93"></a> |
| <FONT color="green">094</FONT> * <p/><a name="line.94"></a> |
| <FONT color="green">095</FONT> * This implementation uses the {@link #setSessionIdGenerator configured} {@link SessionIdGenerator} to create<a name="line.95"></a> |
| <FONT color="green">096</FONT> * the ID.<a name="line.96"></a> |
| <FONT color="green">097</FONT> *<a name="line.97"></a> |
| <FONT color="green">098</FONT> * @param session the new session instance for which an ID will be generated and then assigned<a name="line.98"></a> |
| <FONT color="green">099</FONT> * @return the generated ID to assign<a name="line.99"></a> |
| <FONT color="green">100</FONT> */<a name="line.100"></a> |
| <FONT color="green">101</FONT> protected Serializable generateSessionId(Session session) {<a name="line.101"></a> |
| <FONT color="green">102</FONT> if (this.sessionIdGenerator == null) {<a name="line.102"></a> |
| <FONT color="green">103</FONT> String msg = "sessionIdGenerator attribute has not been configured.";<a name="line.103"></a> |
| <FONT color="green">104</FONT> throw new IllegalStateException(msg);<a name="line.104"></a> |
| <FONT color="green">105</FONT> }<a name="line.105"></a> |
| <FONT color="green">106</FONT> return this.sessionIdGenerator.generateId(session);<a name="line.106"></a> |
| <FONT color="green">107</FONT> }<a name="line.107"></a> |
| <FONT color="green">108</FONT> <a name="line.108"></a> |
| <FONT color="green">109</FONT> /**<a name="line.109"></a> |
| <FONT color="green">110</FONT> * Creates the session by delegating EIS creation to subclasses via the {@link #doCreate} method, and then<a name="line.110"></a> |
| <FONT color="green">111</FONT> * asserting that the returned sessionId is not null.<a name="line.111"></a> |
| <FONT color="green">112</FONT> *<a name="line.112"></a> |
| <FONT color="green">113</FONT> * @param session Session object to create in the EIS and associate with an ID.<a name="line.113"></a> |
| <FONT color="green">114</FONT> */<a name="line.114"></a> |
| <FONT color="green">115</FONT> public Serializable create(Session session) {<a name="line.115"></a> |
| <FONT color="green">116</FONT> Serializable sessionId = doCreate(session);<a name="line.116"></a> |
| <FONT color="green">117</FONT> verifySessionId(sessionId);<a name="line.117"></a> |
| <FONT color="green">118</FONT> return sessionId;<a name="line.118"></a> |
| <FONT color="green">119</FONT> }<a name="line.119"></a> |
| <FONT color="green">120</FONT> <a name="line.120"></a> |
| <FONT color="green">121</FONT> /**<a name="line.121"></a> |
| <FONT color="green">122</FONT> * Ensures the sessionId returned from the subclass implementation of {@link #doCreate} is not null and not<a name="line.122"></a> |
| <FONT color="green">123</FONT> * already in use.<a name="line.123"></a> |
| <FONT color="green">124</FONT> *<a name="line.124"></a> |
| <FONT color="green">125</FONT> * @param sessionId session id returned from the subclass implementation of {@link #doCreate}<a name="line.125"></a> |
| <FONT color="green">126</FONT> */<a name="line.126"></a> |
| <FONT color="green">127</FONT> private void verifySessionId(Serializable sessionId) {<a name="line.127"></a> |
| <FONT color="green">128</FONT> if (sessionId == null) {<a name="line.128"></a> |
| <FONT color="green">129</FONT> String msg = "sessionId returned from doCreate implementation is null. Please verify the implementation.";<a name="line.129"></a> |
| <FONT color="green">130</FONT> throw new IllegalStateException(msg);<a name="line.130"></a> |
| <FONT color="green">131</FONT> }<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> |
| <FONT color="green">134</FONT> /**<a name="line.134"></a> |
| <FONT color="green">135</FONT> * Utility method available to subclasses that wish to<a name="line.135"></a> |
| <FONT color="green">136</FONT> * assign a generated session ID to the session instance directly. This method is not used by the<a name="line.136"></a> |
| <FONT color="green">137</FONT> * {@code AbstractSessionDAO} implementation directly, but it is provided so subclasses don't<a name="line.137"></a> |
| <FONT color="green">138</FONT> * need to know the {@code Session} implementation if they don't need to.<a name="line.138"></a> |
| <FONT color="green">139</FONT> * <p/><a name="line.139"></a> |
| <FONT color="green">140</FONT> * This default implementation casts the argument to a {@link SimpleSession}, Shiro's default EIS implementation.<a name="line.140"></a> |
| <FONT color="green">141</FONT> *<a name="line.141"></a> |
| <FONT color="green">142</FONT> * @param session the session instance to which the sessionId will be applied<a name="line.142"></a> |
| <FONT color="green">143</FONT> * @param sessionId the id to assign to the specified session instance.<a name="line.143"></a> |
| <FONT color="green">144</FONT> */<a name="line.144"></a> |
| <FONT color="green">145</FONT> protected void assignSessionId(Session session, Serializable sessionId) {<a name="line.145"></a> |
| <FONT color="green">146</FONT> ((SimpleSession) session).setId(sessionId);<a name="line.146"></a> |
| <FONT color="green">147</FONT> }<a name="line.147"></a> |
| <FONT color="green">148</FONT> <a name="line.148"></a> |
| <FONT color="green">149</FONT> /**<a name="line.149"></a> |
| <FONT color="green">150</FONT> * Subclass hook to actually persist the given <tt>Session</tt> instance to the underlying EIS.<a name="line.150"></a> |
| <FONT color="green">151</FONT> *<a name="line.151"></a> |
| <FONT color="green">152</FONT> * @param session the Session instance to persist to the EIS.<a name="line.152"></a> |
| <FONT color="green">153</FONT> * @return the id of the session created in the EIS (i.e. this is almost always a primary key and should be the<a name="line.153"></a> |
| <FONT color="green">154</FONT> * value returned from {@link org.apache.shiro.session.Session#getId() Session.getId()}.<a name="line.154"></a> |
| <FONT color="green">155</FONT> */<a name="line.155"></a> |
| <FONT color="green">156</FONT> protected abstract Serializable doCreate(Session session);<a name="line.156"></a> |
| <FONT color="green">157</FONT> <a name="line.157"></a> |
| <FONT color="green">158</FONT> /**<a name="line.158"></a> |
| <FONT color="green">159</FONT> * Retrieves the Session object from the underlying EIS identified by <tt>sessionId</tt> by delegating to<a name="line.159"></a> |
| <FONT color="green">160</FONT> * the {@link #doReadSession(java.io.Serializable)} method. If {@code null} is returned from that method, an<a name="line.160"></a> |
| <FONT color="green">161</FONT> * {@link UnknownSessionException} will be thrown.<a name="line.161"></a> |
| <FONT color="green">162</FONT> *<a name="line.162"></a> |
| <FONT color="green">163</FONT> * @param sessionId the id of the session to retrieve from the EIS.<a name="line.163"></a> |
| <FONT color="green">164</FONT> * @return the session identified by <tt>sessionId</tt> in the EIS.<a name="line.164"></a> |
| <FONT color="green">165</FONT> * @throws UnknownSessionException if the id specified does not correspond to any session in the EIS.<a name="line.165"></a> |
| <FONT color="green">166</FONT> */<a name="line.166"></a> |
| <FONT color="green">167</FONT> public Session readSession(Serializable sessionId) throws UnknownSessionException {<a name="line.167"></a> |
| <FONT color="green">168</FONT> Session s = doReadSession(sessionId);<a name="line.168"></a> |
| <FONT color="green">169</FONT> if (s == null) {<a name="line.169"></a> |
| <FONT color="green">170</FONT> throw new UnknownSessionException("There is no session with id [" + sessionId + "]");<a name="line.170"></a> |
| <FONT color="green">171</FONT> }<a name="line.171"></a> |
| <FONT color="green">172</FONT> return s;<a name="line.172"></a> |
| <FONT color="green">173</FONT> }<a name="line.173"></a> |
| <FONT color="green">174</FONT> <a name="line.174"></a> |
| <FONT color="green">175</FONT> /**<a name="line.175"></a> |
| <FONT color="green">176</FONT> * Subclass implementation hook that retrieves the Session object from the underlying EIS or {@code null} if a<a name="line.176"></a> |
| <FONT color="green">177</FONT> * session with that ID could not be found.<a name="line.177"></a> |
| <FONT color="green">178</FONT> *<a name="line.178"></a> |
| <FONT color="green">179</FONT> * @param sessionId the id of the <tt>Session</tt> to retrieve.<a name="line.179"></a> |
| <FONT color="green">180</FONT> * @return the Session in the EIS identified by <tt>sessionId</tt> or {@code null} if a<a name="line.180"></a> |
| <FONT color="green">181</FONT> * session with that ID could not be found.<a name="line.181"></a> |
| <FONT color="green">182</FONT> */<a name="line.182"></a> |
| <FONT color="green">183</FONT> protected abstract Session doReadSession(Serializable sessionId);<a name="line.183"></a> |
| <FONT color="green">184</FONT> <a name="line.184"></a> |
| <FONT color="green">185</FONT> }<a name="line.185"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
