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