| <!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;</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.InvalidSessionException;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.session.Session;</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">import java.util.Date;</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"> * A DelegatingSession is a client-tier representation of a server side</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * {@link org.apache.shiro.session.Session Session}.</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * This implementation is basically a proxy to a server-side {@link NativeSessionManager NativeSessionManager},</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * which will return the proper results for each method call.</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * <p/></a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * <p>A <tt>DelegatingSession</tt> will cache data when appropriate to avoid a remote method invocation,</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * only communicating with the server when necessary.</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * <p/></a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * <p>Of course, if used in-process with a NativeSessionManager business POJO, as might be the case in a</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * web-based application where the web classes and server-side business pojos exist in the same</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * JVM, a remote method call will not be incurred.</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> *</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * @since 0.1</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> */</a> |
| <span class="sourceLineNo">043</span><a id="line.43">public class DelegatingSession implements Session, Serializable {</a> |
| <span class="sourceLineNo">044</span><a id="line.44"></a> |
| <span class="sourceLineNo">045</span><a id="line.45"> //TODO - complete JavaDoc</a> |
| <span class="sourceLineNo">046</span><a id="line.46"></a> |
| <span class="sourceLineNo">047</span><a id="line.47"> private final SessionKey key;</a> |
| <span class="sourceLineNo">048</span><a id="line.48"></a> |
| <span class="sourceLineNo">049</span><a id="line.49"> //cached fields to avoid a server-side method call if out-of-process:</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> private Date startTimestamp = null;</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> private String host = null;</a> |
| <span class="sourceLineNo">052</span><a id="line.52"></a> |
| <span class="sourceLineNo">053</span><a id="line.53"> /**</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * Handle to the target NativeSessionManager that will support the delegate calls.</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> */</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> private final transient NativeSessionManager sessionManager;</a> |
| <span class="sourceLineNo">057</span><a id="line.57"></a> |
| <span class="sourceLineNo">058</span><a id="line.58"></a> |
| <span class="sourceLineNo">059</span><a id="line.59"> public DelegatingSession(NativeSessionManager sessionManager, SessionKey key) {</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> if (sessionManager == null) {</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> throw new IllegalArgumentException("sessionManager argument cannot be null.");</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> }</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> if (key == null) {</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> throw new IllegalArgumentException("sessionKey argument cannot be null.");</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> }</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> if (key.getSessionId() == null) {</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> String msg = "The " + DelegatingSession.class.getName() + " implementation requires that the " +</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> "SessionKey argument returns a non-null sessionId to support the " +</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> "Session.getId() invocations.";</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> throw new IllegalArgumentException(msg);</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> }</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> this.sessionManager = sessionManager;</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> this.key = key;</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"> /**</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> * @see org.apache.shiro.session.Session#getId()</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> */</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> public Serializable getId() {</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> return key.getSessionId();</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> }</a> |
| <span class="sourceLineNo">082</span><a id="line.82"></a> |
| <span class="sourceLineNo">083</span><a id="line.83"> /**</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> * @see org.apache.shiro.session.Session#getStartTimestamp()</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> */</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> public Date getStartTimestamp() {</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> if (startTimestamp == null) {</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> startTimestamp = sessionManager.getStartTimestamp(key);</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> }</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> return startTimestamp;</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> }</a> |
| <span class="sourceLineNo">092</span><a id="line.92"></a> |
| <span class="sourceLineNo">093</span><a id="line.93"> /**</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> * @see org.apache.shiro.session.Session#getLastAccessTime()</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> */</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> public Date getLastAccessTime() {</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> //can't cache - only business pojo knows the accurate time:</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> return sessionManager.getLastAccessTime(key);</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"> public long getTimeout() throws InvalidSessionException {</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> return sessionManager.getTimeout(key);</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> }</a> |
| <span class="sourceLineNo">104</span><a id="line.104"></a> |
| <span class="sourceLineNo">105</span><a id="line.105"> public void setTimeout(long maxIdleTimeInMillis) throws InvalidSessionException {</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> sessionManager.setTimeout(key, maxIdleTimeInMillis);</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> }</a> |
| <span class="sourceLineNo">108</span><a id="line.108"></a> |
| <span class="sourceLineNo">109</span><a id="line.109"> public String getHost() {</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> if (host == null) {</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> host = sessionManager.getHost(key);</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> }</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> return host;</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> }</a> |
| <span class="sourceLineNo">115</span><a id="line.115"></a> |
| <span class="sourceLineNo">116</span><a id="line.116"> /**</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> * @see org.apache.shiro.session.Session#touch()</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> */</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> public void touch() throws InvalidSessionException {</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> sessionManager.touch(key);</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> }</a> |
| <span class="sourceLineNo">122</span><a id="line.122"></a> |
| <span class="sourceLineNo">123</span><a id="line.123"> /**</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> * @see org.apache.shiro.session.Session#stop()</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> */</a> |
| <span class="sourceLineNo">126</span><a id="line.126"> public void stop() throws InvalidSessionException {</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> sessionManager.stop(key);</a> |
| <span class="sourceLineNo">128</span><a id="line.128"> }</a> |
| <span class="sourceLineNo">129</span><a id="line.129"></a> |
| <span class="sourceLineNo">130</span><a id="line.130"> /**</a> |
| <span class="sourceLineNo">131</span><a id="line.131"> * @see org.apache.shiro.session.Session#getAttributeKeys</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> */</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> public Collection<Object> getAttributeKeys() throws InvalidSessionException {</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> return sessionManager.getAttributeKeys(key);</a> |
| <span class="sourceLineNo">135</span><a id="line.135"> }</a> |
| <span class="sourceLineNo">136</span><a id="line.136"></a> |
| <span class="sourceLineNo">137</span><a id="line.137"> /**</a> |
| <span class="sourceLineNo">138</span><a id="line.138"> * @see org.apache.shiro.session.Session#getAttribute(Object key)</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> */</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> public Object getAttribute(Object attributeKey) throws InvalidSessionException {</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> return sessionManager.getAttribute(this.key, attributeKey);</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> }</a> |
| <span class="sourceLineNo">143</span><a id="line.143"></a> |
| <span class="sourceLineNo">144</span><a id="line.144"> /**</a> |
| <span class="sourceLineNo">145</span><a id="line.145"> * @see Session#setAttribute(Object key, Object value)</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> */</a> |
| <span class="sourceLineNo">147</span><a id="line.147"> public void setAttribute(Object attributeKey, Object value) throws InvalidSessionException {</a> |
| <span class="sourceLineNo">148</span><a id="line.148"> if (value == null) {</a> |
| <span class="sourceLineNo">149</span><a id="line.149"> removeAttribute(attributeKey);</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> } else {</a> |
| <span class="sourceLineNo">151</span><a id="line.151"> sessionManager.setAttribute(this.key, attributeKey, value);</a> |
| <span class="sourceLineNo">152</span><a id="line.152"> }</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> }</a> |
| <span class="sourceLineNo">154</span><a id="line.154"></a> |
| <span class="sourceLineNo">155</span><a id="line.155"> /**</a> |
| <span class="sourceLineNo">156</span><a id="line.156"> * @see Session#removeAttribute(Object key)</a> |
| <span class="sourceLineNo">157</span><a id="line.157"> */</a> |
| <span class="sourceLineNo">158</span><a id="line.158"> public Object removeAttribute(Object attributeKey) throws InvalidSessionException {</a> |
| <span class="sourceLineNo">159</span><a id="line.159"> return sessionManager.removeAttribute(this.key, attributeKey);</a> |
| <span class="sourceLineNo">160</span><a id="line.160"> }</a> |
| <span class="sourceLineNo">161</span><a id="line.161">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
