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