| <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> <a name="line.23"></a> |
| <FONT color="green">024</FONT> import java.io.Serializable;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import java.util.Collection;<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> * Data Access Object design pattern specification to enable {@link Session} access to an<a name="line.29"></a> |
| <FONT color="green">030</FONT> * EIS (Enterprise Information System). It provides your four typical CRUD methods:<a name="line.30"></a> |
| <FONT color="green">031</FONT> * {@link #create}, {@link #readSession(java.io.Serializable)}, {@link #update(org.apache.shiro.session.Session)},<a name="line.31"></a> |
| <FONT color="green">032</FONT> * and {@link #delete(org.apache.shiro.session.Session)}.<a name="line.32"></a> |
| <FONT color="green">033</FONT> * <p/><a name="line.33"></a> |
| <FONT color="green">034</FONT> * The remaining {@link #getActiveSessions()} method exists as a support mechanism to pre-emptively orphaned sessions,<a name="line.34"></a> |
| <FONT color="green">035</FONT> * typically by {@link org.apache.shiro.session.mgt.ValidatingSessionManager ValidatingSessionManager}s), and should<a name="line.35"></a> |
| <FONT color="green">036</FONT> * be as efficient as possible, especially if there are thousands of active sessions. Large scale/high performance<a name="line.36"></a> |
| <FONT color="green">037</FONT> * implementations will often return a subset of the total active sessions and perform validation a little more<a name="line.37"></a> |
| <FONT color="green">038</FONT> * frequently, rather than return a massive set and infrequently validate.<a name="line.38"></a> |
| <FONT color="green">039</FONT> *<a name="line.39"></a> |
| <FONT color="green">040</FONT> * @since 0.1<a name="line.40"></a> |
| <FONT color="green">041</FONT> */<a name="line.41"></a> |
| <FONT color="green">042</FONT> public interface SessionDAO {<a name="line.42"></a> |
| <FONT color="green">043</FONT> <a name="line.43"></a> |
| <FONT color="green">044</FONT> /**<a name="line.44"></a> |
| <FONT color="green">045</FONT> * Inserts a new Session record into the underling EIS (e.g. Relational database, file system, persistent cache,<a name="line.45"></a> |
| <FONT color="green">046</FONT> * etc, depending on the DAO implementation).<a name="line.46"></a> |
| <FONT color="green">047</FONT> * <p/><a name="line.47"></a> |
| <FONT color="green">048</FONT> * After this method is invoked, the {@link org.apache.shiro.session.Session#getId()}<a name="line.48"></a> |
| <FONT color="green">049</FONT> * method executed on the argument must return a valid session identifier. That is, the following should<a name="line.49"></a> |
| <FONT color="green">050</FONT> * always be true:<a name="line.50"></a> |
| <FONT color="green">051</FONT> * <pre><a name="line.51"></a> |
| <FONT color="green">052</FONT> * Serializable id = create( session );<a name="line.52"></a> |
| <FONT color="green">053</FONT> * id.equals( session.getId() ) == true</pre><a name="line.53"></a> |
| <FONT color="green">054</FONT> * <p/><a name="line.54"></a> |
| <FONT color="green">055</FONT> * Implementations are free to throw any exceptions that might occur due to<a name="line.55"></a> |
| <FONT color="green">056</FONT> * integrity violation constraints or other EIS related errors.<a name="line.56"></a> |
| <FONT color="green">057</FONT> *<a name="line.57"></a> |
| <FONT color="green">058</FONT> * @param session the {@link org.apache.shiro.session.Session} object to create in the EIS.<a name="line.58"></a> |
| <FONT color="green">059</FONT> * @return the EIS id (e.g. primary key) of the created {@code Session} object.<a name="line.59"></a> |
| <FONT color="green">060</FONT> */<a name="line.60"></a> |
| <FONT color="green">061</FONT> Serializable create(Session session);<a name="line.61"></a> |
| <FONT color="green">062</FONT> <a name="line.62"></a> |
| <FONT color="green">063</FONT> /**<a name="line.63"></a> |
| <FONT color="green">064</FONT> * Retrieves the session from the EIS uniquely identified by the specified<a name="line.64"></a> |
| <FONT color="green">065</FONT> * {@code sessionId}.<a name="line.65"></a> |
| <FONT color="green">066</FONT> *<a name="line.66"></a> |
| <FONT color="green">067</FONT> * @param sessionId the system-wide unique identifier of the Session object to retrieve from<a name="line.67"></a> |
| <FONT color="green">068</FONT> * the EIS.<a name="line.68"></a> |
| <FONT color="green">069</FONT> * @return the persisted session in the EIS identified by {@code sessionId}.<a name="line.69"></a> |
| <FONT color="green">070</FONT> * @throws UnknownSessionException if there is no EIS record for any session with the<a name="line.70"></a> |
| <FONT color="green">071</FONT> * specified {@code sessionId}<a name="line.71"></a> |
| <FONT color="green">072</FONT> */<a name="line.72"></a> |
| <FONT color="green">073</FONT> Session readSession(Serializable sessionId) throws UnknownSessionException;<a name="line.73"></a> |
| <FONT color="green">074</FONT> <a name="line.74"></a> |
| <FONT color="green">075</FONT> /**<a name="line.75"></a> |
| <FONT color="green">076</FONT> * Updates (persists) data from a previously created Session instance in the EIS identified by<a name="line.76"></a> |
| <FONT color="green">077</FONT> * {@code {@link Session#getId() session.getId()}}. This effectively propagates<a name="line.77"></a> |
| <FONT color="green">078</FONT> * the data in the argument to the EIS record previously saved.<a name="line.78"></a> |
| <FONT color="green">079</FONT> * <p/><a name="line.79"></a> |
| <FONT color="green">080</FONT> * In addition to UnknownSessionException, implementations are free to throw any other<a name="line.80"></a> |
| <FONT color="green">081</FONT> * exceptions that might occur due to integrity violation constraints or other EIS related<a name="line.81"></a> |
| <FONT color="green">082</FONT> * errors.<a name="line.82"></a> |
| <FONT color="green">083</FONT> *<a name="line.83"></a> |
| <FONT color="green">084</FONT> * @param session the Session to update<a name="line.84"></a> |
| <FONT color="green">085</FONT> * @throws org.apache.shiro.session.UnknownSessionException<a name="line.85"></a> |
| <FONT color="green">086</FONT> * if no existing EIS session record exists with the<a name="line.86"></a> |
| <FONT color="green">087</FONT> * identifier of {@link Session#getId() session.getSessionId()}<a name="line.87"></a> |
| <FONT color="green">088</FONT> */<a name="line.88"></a> |
| <FONT color="green">089</FONT> void update(Session session) throws UnknownSessionException;<a name="line.89"></a> |
| <FONT color="green">090</FONT> <a name="line.90"></a> |
| <FONT color="green">091</FONT> /**<a name="line.91"></a> |
| <FONT color="green">092</FONT> * Deletes the associated EIS record of the specified {@code session}. If there never<a name="line.92"></a> |
| <FONT color="green">093</FONT> * existed a session EIS record with the identifier of<a name="line.93"></a> |
| <FONT color="green">094</FONT> * {@link Session#getId() session.getId()}, then this method does nothing.<a name="line.94"></a> |
| <FONT color="green">095</FONT> *<a name="line.95"></a> |
| <FONT color="green">096</FONT> * @param session the session to delete.<a name="line.96"></a> |
| <FONT color="green">097</FONT> */<a name="line.97"></a> |
| <FONT color="green">098</FONT> void delete(Session session);<a name="line.98"></a> |
| <FONT color="green">099</FONT> <a name="line.99"></a> |
| <FONT color="green">100</FONT> /**<a name="line.100"></a> |
| <FONT color="green">101</FONT> * Returns all sessions in the EIS that are considered active, meaning all sessions that<a name="line.101"></a> |
| <FONT color="green">102</FONT> * haven't been stopped/expired. This is primarily used to validate potential orphans.<a name="line.102"></a> |
| <FONT color="green">103</FONT> * <p/><a name="line.103"></a> |
| <FONT color="green">104</FONT> * If there are no active sessions in the EIS, this method may return an empty collection or {@code null}.<a name="line.104"></a> |
| <FONT color="green">105</FONT> * <h4>Performance</h4><a name="line.105"></a> |
| <FONT color="green">106</FONT> * This method should be as efficient as possible, especially in larger systems where there might be<a name="line.106"></a> |
| <FONT color="green">107</FONT> * thousands of active sessions. Large scale/high performance<a name="line.107"></a> |
| <FONT color="green">108</FONT> * implementations will often return a subset of the total active sessions and perform validation a little more<a name="line.108"></a> |
| <FONT color="green">109</FONT> * frequently, rather than return a massive set and validate infrequently. If efficient and possible, it would<a name="line.109"></a> |
| <FONT color="green">110</FONT> * make sense to return the oldest unstopped sessions available, ordered by<a name="line.110"></a> |
| <FONT color="green">111</FONT> * {@link org.apache.shiro.session.Session#getLastAccessTime() lastAccessTime}.<a name="line.111"></a> |
| <FONT color="green">112</FONT> * <h4>Smart Results</h4><a name="line.112"></a> |
| <FONT color="green">113</FONT> * <em>Ideally</em> this method would only return active sessions that the EIS was certain should be invalided.<a name="line.113"></a> |
| <FONT color="green">114</FONT> * Typically that is any session that is not stopped and where its lastAccessTimestamp is older than the session<a name="line.114"></a> |
| <FONT color="green">115</FONT> * timeout.<a name="line.115"></a> |
| <FONT color="green">116</FONT> * <p/><a name="line.116"></a> |
| <FONT color="green">117</FONT> * For example, if sessions were backed by a relational database or SQL-92 'query-able' enterprise cache, you might<a name="line.117"></a> |
| <FONT color="green">118</FONT> * return something similar to the results returned by this query (assuming<a name="line.118"></a> |
| <FONT color="green">119</FONT> * {@link org.apache.shiro.session.mgt.SimpleSession SimpleSession}s were being stored):<a name="line.119"></a> |
| <FONT color="green">120</FONT> * <pre><a name="line.120"></a> |
| <FONT color="green">121</FONT> * select * from sessions s where s.lastAccessTimestamp < ? and s.stopTimestamp is null<a name="line.121"></a> |
| <FONT color="green">122</FONT> * </pre><a name="line.122"></a> |
| <FONT color="green">123</FONT> * where the {@code ?} parameter is a date instance equal to 'now' minus the session timeout<a name="line.123"></a> |
| <FONT color="green">124</FONT> * (e.g. now - 30 minutes).<a name="line.124"></a> |
| <FONT color="green">125</FONT> *<a name="line.125"></a> |
| <FONT color="green">126</FONT> * @return a Collection of {@code Session}s that are considered active, or an<a name="line.126"></a> |
| <FONT color="green">127</FONT> * empty collection or {@code null} if there are no active sessions.<a name="line.127"></a> |
| <FONT color="green">128</FONT> */<a name="line.128"></a> |
| <FONT color="green">129</FONT> Collection<Session> getActiveSessions();<a name="line.129"></a> |
| <FONT color="green">130</FONT> }<a name="line.130"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
