| <!DOCTYPE HTML> |
| <html lang="fr"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <main role="main"> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span><a id="line.1">/*</a> |
| <span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> *</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> */</a> |
| <span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.session.mgt.eis;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.session.Session;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.session.UnknownSessionException;</a> |
| <span class="sourceLineNo">023</span><a id="line.23"></a> |
| <span class="sourceLineNo">024</span><a id="line.24">import java.io.Serializable;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import java.util.Collection;</a> |
| <span class="sourceLineNo">026</span><a id="line.26"></a> |
| <span class="sourceLineNo">027</span><a id="line.27"></a> |
| <span class="sourceLineNo">028</span><a id="line.28">/**</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * Data Access Object design pattern specification to enable {@link Session} access to an</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * EIS (Enterprise Information System). It provides your four typical CRUD methods:</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * {@link #create}, {@link #readSession(java.io.Serializable)}, {@link #update(org.apache.shiro.session.Session)},</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * and {@link #delete(org.apache.shiro.session.Session)}.</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * <p/></a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * The remaining {@link #getActiveSessions()} method exists as a support mechanism to pre-emptively orphaned sessions,</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * typically by {@link org.apache.shiro.session.mgt.ValidatingSessionManager ValidatingSessionManager}s), and should</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * be as efficient as possible, especially if there are thousands of active sessions. Large scale/high performance</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * implementations will often return a subset of the total active sessions and perform validation a little more</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * frequently, rather than return a massive set and infrequently validate.</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> *</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * @since 0.1</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> */</a> |
| <span class="sourceLineNo">042</span><a id="line.42">public interface SessionDAO {</a> |
| <span class="sourceLineNo">043</span><a id="line.43"></a> |
| <span class="sourceLineNo">044</span><a id="line.44"> /**</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * Inserts a new Session record into the underling EIS (e.g. Relational database, file system, persistent cache,</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * etc, depending on the DAO implementation).</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> * <p/></a> |
| <span class="sourceLineNo">048</span><a id="line.48"> * After this method is invoked, the {@link org.apache.shiro.session.Session#getId()}</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * method executed on the argument must return a valid session identifier. That is, the following should</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * always be true:</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> * <pre></a> |
| <span class="sourceLineNo">052</span><a id="line.52"> * Serializable id = create( session );</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * id.equals( session.getId() ) == true</pre></a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * <p/></a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * Implementations are free to throw any exceptions that might occur due to</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * integrity violation constraints or other EIS related errors.</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> *</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * @param session the {@link org.apache.shiro.session.Session} object to create in the EIS.</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> * @return the EIS id (e.g. primary key) of the created {@code Session} object.</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> */</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> Serializable create(Session session);</a> |
| <span class="sourceLineNo">062</span><a id="line.62"></a> |
| <span class="sourceLineNo">063</span><a id="line.63"> /**</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> * Retrieves the session from the EIS uniquely identified by the specified</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> * {@code sessionId}.</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> *</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> * @param sessionId the system-wide unique identifier of the Session object to retrieve from</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> * the EIS.</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> * @return the persisted session in the EIS identified by {@code sessionId}.</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> * @throws UnknownSessionException if there is no EIS record for any session with the</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> * specified {@code sessionId}</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> */</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> Session readSession(Serializable sessionId) throws UnknownSessionException;</a> |
| <span class="sourceLineNo">074</span><a id="line.74"></a> |
| <span class="sourceLineNo">075</span><a id="line.75"> /**</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> * Updates (persists) data from a previously created Session instance in the EIS identified by</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> * {@code {@link Session#getId() session.getId()}}. This effectively propagates</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> * the data in the argument to the EIS record previously saved.</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> * <p/></a> |
| <span class="sourceLineNo">080</span><a id="line.80"> * In addition to UnknownSessionException, implementations are free to throw any other</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> * exceptions that might occur due to integrity violation constraints or other EIS related</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> * errors.</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> *</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> * @param session the Session to update</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> * @throws org.apache.shiro.session.UnknownSessionException</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> * if no existing EIS session record exists with the</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> * identifier of {@link Session#getId() session.getSessionId()}</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> */</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> void update(Session session) throws UnknownSessionException;</a> |
| <span class="sourceLineNo">090</span><a id="line.90"></a> |
| <span class="sourceLineNo">091</span><a id="line.91"> /**</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> * Deletes the associated EIS record of the specified {@code session}. If there never</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> * existed a session EIS record with the identifier of</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> * {@link Session#getId() session.getId()}, then this method does nothing.</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> *</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> * @param session the session to delete.</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> */</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> void delete(Session session);</a> |
| <span class="sourceLineNo">099</span><a id="line.99"></a> |
| <span class="sourceLineNo">100</span><a id="line.100"> /**</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> * Returns all sessions in the EIS that are considered active, meaning all sessions that</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> * haven't been stopped/expired. This is primarily used to validate potential orphans.</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> * <p/></a> |
| <span class="sourceLineNo">104</span><a id="line.104"> * If there are no active sessions in the EIS, this method may return an empty collection or {@code null}.</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> * <h4>Performance</h4></a> |
| <span class="sourceLineNo">106</span><a id="line.106"> * This method should be as efficient as possible, especially in larger systems where there might be</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> * thousands of active sessions. Large scale/high performance</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> * implementations will often return a subset of the total active sessions and perform validation a little more</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> * frequently, rather than return a massive set and validate infrequently. If efficient and possible, it would</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> * make sense to return the oldest unstopped sessions available, ordered by</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> * {@link org.apache.shiro.session.Session#getLastAccessTime() lastAccessTime}.</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> * <h4>Smart Results</h4></a> |
| <span class="sourceLineNo">113</span><a id="line.113"> * <em>Ideally</em> this method would only return active sessions that the EIS was certain should be invalided.</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> * Typically that is any session that is not stopped and where its lastAccessTimestamp is older than the session</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> * timeout.</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> * <p/></a> |
| <span class="sourceLineNo">117</span><a id="line.117"> * For example, if sessions were backed by a relational database or SQL-92 'query-able' enterprise cache, you might</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> * return something similar to the results returned by this query (assuming</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> * {@link org.apache.shiro.session.mgt.SimpleSession SimpleSession}s were being stored):</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> * <pre></a> |
| <span class="sourceLineNo">121</span><a id="line.121"> * select * from sessions s where s.lastAccessTimestamp < ? and s.stopTimestamp is null</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> * </pre></a> |
| <span class="sourceLineNo">123</span><a id="line.123"> * where the {@code ?} parameter is a date instance equal to 'now' minus the session timeout</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> * (e.g. now - 30 minutes).</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> *</a> |
| <span class="sourceLineNo">126</span><a id="line.126"> * @return a Collection of {@code Session}s that are considered active, or an</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> * empty collection or {@code null} if there are no active sessions.</a> |
| <span class="sourceLineNo">128</span><a id="line.128"> */</a> |
| <span class="sourceLineNo">129</span><a id="line.129"> Collection<Session> getActiveSessions();</a> |
| <span class="sourceLineNo">130</span><a id="line.130">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
