Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.5.3 / apidocs / src-html / org / apache / shiro / session / Session.html
blob: 657056d2c9adcf197bb470552940c10524360030 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="fr">
<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;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.Serializable;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Collection;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Date;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>/**<a name="line.25"></a>
<span class="sourceLineNo">026</span> * A {@code Session} is a stateful data context associated with a single Subject (user, daemon process,<a name="line.26"></a>
<span class="sourceLineNo">027</span> * etc) who interacts with a software system over a period of time.<a name="line.27"></a>
<span class="sourceLineNo">028</span> * &lt;p/&gt;<a name="line.28"></a>
<span class="sourceLineNo">029</span> * A {@code Session} is intended to be managed by the business tier and accessible via other<a name="line.29"></a>
<span class="sourceLineNo">030</span> * tiers without being tied to any given client technology. This is a &lt;em&gt;great&lt;/em&gt; benefit to Java<a name="line.30"></a>
<span class="sourceLineNo">031</span> * systems, since until now, the only viable session mechanisms were the<a name="line.31"></a>
<span class="sourceLineNo">032</span> * {@code javax.servlet.http.HttpSession} or Stateful Session EJB's, which many times<a name="line.32"></a>
<span class="sourceLineNo">033</span> * unnecessarily coupled applications to web or ejb technologies.<a name="line.33"></a>
<span class="sourceLineNo">034</span> *<a name="line.34"></a>
<span class="sourceLineNo">035</span> * @since 0.1<a name="line.35"></a>
<span class="sourceLineNo">036</span> */<a name="line.36"></a>
<span class="sourceLineNo">037</span>public interface Session {<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span> /**<a name="line.39"></a>
<span class="sourceLineNo">040</span> * Returns the unique identifier assigned by the system upon session creation.<a name="line.40"></a>
<span class="sourceLineNo">041</span> * &lt;p/&gt;<a name="line.41"></a>
<span class="sourceLineNo">042</span> * All return values from this method are expected to have proper {@code toString()},<a name="line.42"></a>
<span class="sourceLineNo">043</span> * {@code equals()}, and {@code hashCode()} implementations. Good candidates for such<a name="line.43"></a>
<span class="sourceLineNo">044</span> * an identifier are {@link java.util.UUID UUID}s, {@link java.lang.Integer Integer}s, and<a name="line.44"></a>
<span class="sourceLineNo">045</span> * {@link java.lang.String String}s.<a name="line.45"></a>
<span class="sourceLineNo">046</span> *<a name="line.46"></a>
<span class="sourceLineNo">047</span> * @return The unique identifier assigned to the session upon creation.<a name="line.47"></a>
<span class="sourceLineNo">048</span> */<a name="line.48"></a>
<span class="sourceLineNo">049</span> Serializable getId();<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> /**<a name="line.51"></a>
<span class="sourceLineNo">052</span> * Returns the time the session was started; that is, the time the system created the instance.<a name="line.52"></a>
<span class="sourceLineNo">053</span> *<a name="line.53"></a>
<span class="sourceLineNo">054</span> * @return The time the system created the session.<a name="line.54"></a>
<span class="sourceLineNo">055</span> */<a name="line.55"></a>
<span class="sourceLineNo">056</span> Date getStartTimestamp();<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> * Returns the last time the application received a request or method invocation from the user associated<a name="line.59"></a>
<span class="sourceLineNo">060</span> * with this session. Application calls to this method do not affect this access time.<a name="line.60"></a>
<span class="sourceLineNo">061</span> *<a name="line.61"></a>
<span class="sourceLineNo">062</span> * @return The time the user last interacted with the system.<a name="line.62"></a>
<span class="sourceLineNo">063</span> * @see #touch()<a name="line.63"></a>
<span class="sourceLineNo">064</span> */<a name="line.64"></a>
<span class="sourceLineNo">065</span> Date getLastAccessTime();<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> /**<a name="line.67"></a>
<span class="sourceLineNo">068</span> * Returns the time in milliseconds that the session session may remain idle before expiring.<a name="line.68"></a>
<span class="sourceLineNo">069</span> * &lt;ul&gt;<a name="line.69"></a>
<span class="sourceLineNo">070</span> * &lt;li&gt;A negative return value means the session will never expire.&lt;/li&gt;<a name="line.70"></a>
<span class="sourceLineNo">071</span> * &lt;li&gt;A non-negative return value (0 or greater) means the session expiration will occur if idle for that<a name="line.71"></a>
<span class="sourceLineNo">072</span> * length of time.&lt;/li&gt;<a name="line.72"></a>
<span class="sourceLineNo">073</span> * &lt;/ul&gt;<a name="line.73"></a>
<span class="sourceLineNo">074</span> * &lt;b&gt;*Note:&lt;/b&gt; if you are used to the {@code HttpSession}'s {@code getMaxInactiveInterval()} method, the scale on<a name="line.74"></a>
<span class="sourceLineNo">075</span> * this method is different: Shiro Sessions use millisecond values for timeout whereas<a name="line.75"></a>
<span class="sourceLineNo">076</span> * {@code HttpSession.getMaxInactiveInterval} uses seconds. Always use millisecond values with Shiro sessions.<a name="line.76"></a>
<span class="sourceLineNo">077</span> *<a name="line.77"></a>
<span class="sourceLineNo">078</span> * @return the time in milliseconds the session may remain idle before expiring.<a name="line.78"></a>
<span class="sourceLineNo">079</span> * @throws InvalidSessionException if the session has been stopped or expired prior to calling this method.<a name="line.79"></a>
<span class="sourceLineNo">080</span> * @since 0.2<a name="line.80"></a>
<span class="sourceLineNo">081</span> */<a name="line.81"></a>
<span class="sourceLineNo">082</span> long getTimeout() throws InvalidSessionException;<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> * Sets the time in milliseconds that the session may remain idle before expiring.<a name="line.85"></a>
<span class="sourceLineNo">086</span> * &lt;ul&gt;<a name="line.86"></a>
<span class="sourceLineNo">087</span> * &lt;li&gt;A negative value means the session will never expire.&lt;/li&gt;<a name="line.87"></a>
<span class="sourceLineNo">088</span> * &lt;li&gt;A non-negative value (0 or greater) means the session expiration will occur if idle for that<a name="line.88"></a>
<span class="sourceLineNo">089</span> * length of time.&lt;/li&gt;<a name="line.89"></a>
<span class="sourceLineNo">090</span> * &lt;/ul&gt;<a name="line.90"></a>
<span class="sourceLineNo">091</span> * &lt;p/&gt;<a name="line.91"></a>
<span class="sourceLineNo">092</span> * &lt;b&gt;*Note:&lt;/b&gt; if you are used to the {@code HttpSession}'s {@code getMaxInactiveInterval()} method, the scale on<a name="line.92"></a>
<span class="sourceLineNo">093</span> * this method is different: Shiro Sessions use millisecond values for timeout whereas<a name="line.93"></a>
<span class="sourceLineNo">094</span> * {@code HttpSession.getMaxInactiveInterval} uses seconds. Always use millisecond values with Shiro sessions.<a name="line.94"></a>
<span class="sourceLineNo">095</span> *<a name="line.95"></a>
<span class="sourceLineNo">096</span> * @param maxIdleTimeInMillis the time in milliseconds that the session may remain idle before expiring.<a name="line.96"></a>
<span class="sourceLineNo">097</span> * @throws InvalidSessionException if the session has been stopped or expired prior to calling this method.<a name="line.97"></a>
<span class="sourceLineNo">098</span> * @since 0.2<a name="line.98"></a>
<span class="sourceLineNo">099</span> */<a name="line.99"></a>
<span class="sourceLineNo">100</span> void setTimeout(long maxIdleTimeInMillis) throws InvalidSessionException;<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> /**<a name="line.102"></a>
<span class="sourceLineNo">103</span> * Returns the host name or IP string of the host that originated this session, or {@code null}<a name="line.103"></a>
<span class="sourceLineNo">104</span> * if the host is unknown.<a name="line.104"></a>
<span class="sourceLineNo">105</span> *<a name="line.105"></a>
<span class="sourceLineNo">106</span> * @return the host name or IP string of the host that originated this session, or {@code null}<a name="line.106"></a>
<span class="sourceLineNo">107</span> * if the host address is unknown.<a name="line.107"></a>
<span class="sourceLineNo">108</span> */<a name="line.108"></a>
<span class="sourceLineNo">109</span> String getHost();<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span> /**<a name="line.111"></a>
<span class="sourceLineNo">112</span> * Explicitly updates the {@link #getLastAccessTime() lastAccessTime} of this session to the current time when<a name="line.112"></a>
<span class="sourceLineNo">113</span> * this method is invoked. This method can be used to ensure a session does not time out.<a name="line.113"></a>
<span class="sourceLineNo">114</span> * &lt;p/&gt;<a name="line.114"></a>
<span class="sourceLineNo">115</span> * Most programmers won't use this method directly and will instead rely on the last access time to be updated<a name="line.115"></a>
<span class="sourceLineNo">116</span> * automatically as a result of an incoming web request or remote procedure call/method invocation.<a name="line.116"></a>
<span class="sourceLineNo">117</span> * &lt;p/&gt;<a name="line.117"></a>
<span class="sourceLineNo">118</span> * However, this method is particularly useful when supporting rich-client applications such as<a name="line.118"></a>
<span class="sourceLineNo">119</span> * Java Web Start app, Java or Flash applets, etc. Although rare, it is possible in a rich-client<a name="line.119"></a>
<span class="sourceLineNo">120</span> * environment that a user continuously interacts with the client-side application without a<a name="line.120"></a>
<span class="sourceLineNo">121</span> * server-side method call ever being invoked. If this happens over a long enough period of<a name="line.121"></a>
<span class="sourceLineNo">122</span> * time, the user's server-side session could time-out. Again, such cases are rare since most<a name="line.122"></a>
<span class="sourceLineNo">123</span> * rich-clients frequently require server-side method invocations.<a name="line.123"></a>
<span class="sourceLineNo">124</span> * &lt;p/&gt;<a name="line.124"></a>
<span class="sourceLineNo">125</span> * In this example though, the user's session might still be considered valid because<a name="line.125"></a>
<span class="sourceLineNo">126</span> * the user is actively &amp;quot;using&amp;quot; the application, just not communicating with the<a name="line.126"></a>
<span class="sourceLineNo">127</span> * server. But because no server-side method calls are invoked, there is no way for the server<a name="line.127"></a>
<span class="sourceLineNo">128</span> * to know if the user is sitting idle or not, so it must assume so to maintain session<a name="line.128"></a>
<span class="sourceLineNo">129</span> * integrity. This {@code touch()} method could be invoked by the rich-client application code during those<a name="line.129"></a>
<span class="sourceLineNo">130</span> * times to ensure that the next time a server-side method is invoked, the invocation will not<a name="line.130"></a>
<span class="sourceLineNo">131</span> * throw an {@link ExpiredSessionException ExpiredSessionException}. In short terms, it could be used periodically<a name="line.131"></a>
<span class="sourceLineNo">132</span> * to ensure a session does not time out.<a name="line.132"></a>
<span class="sourceLineNo">133</span> * &lt;p/&gt;<a name="line.133"></a>
<span class="sourceLineNo">134</span> * How often this rich-client &amp;quot;maintenance&amp;quot; might occur is entirely dependent upon<a name="line.134"></a>
<span class="sourceLineNo">135</span> * the application and would be based on variables such as session timeout configuration,<a name="line.135"></a>
<span class="sourceLineNo">136</span> * usage characteristics of the client application, network utilization and application server<a name="line.136"></a>
<span class="sourceLineNo">137</span> * performance.<a name="line.137"></a>
<span class="sourceLineNo">138</span> *<a name="line.138"></a>
<span class="sourceLineNo">139</span> * @throws InvalidSessionException if this session has stopped or expired prior to calling this method.<a name="line.139"></a>
<span class="sourceLineNo">140</span> */<a name="line.140"></a>
<span class="sourceLineNo">141</span> void touch() throws InvalidSessionException;<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> * Explicitly stops (invalidates) this session and releases all associated resources.<a name="line.144"></a>
<span class="sourceLineNo">145</span> * &lt;p/&gt;<a name="line.145"></a>
<span class="sourceLineNo">146</span> * If this session has already been authenticated (i.e. the {@code Subject} that<a name="line.146"></a>
<span class="sourceLineNo">147</span> * owns this session has logged-in), calling this method explicitly might have undesired side effects:<a name="line.147"></a>
<span class="sourceLineNo">148</span> * &lt;p/&gt;<a name="line.148"></a>
<span class="sourceLineNo">149</span> * It is common for a {@code Subject} implementation to retain authentication state in the<a name="line.149"></a>
<span class="sourceLineNo">150</span> * {@code Session}. If the session<a name="line.150"></a>
<span class="sourceLineNo">151</span> * is explicitly stopped by application code by calling this method directly, it could clear out any<a name="line.151"></a>
<span class="sourceLineNo">152</span> * authentication state that might exist, thereby effectively &amp;quot;unauthenticating&amp;quot; the {@code Subject}.<a name="line.152"></a>
<span class="sourceLineNo">153</span> * &lt;p/&gt;<a name="line.153"></a>
<span class="sourceLineNo">154</span> * As such, you might consider {@link org.apache.shiro.subject.Subject#logout logging-out} the 'owning'<a name="line.154"></a>
<span class="sourceLineNo">155</span> * {@code Subject} instead of manually calling this method, as a log out is expected to stop the<a name="line.155"></a>
<span class="sourceLineNo">156</span> * corresponding session automatically, and also allows framework code to execute additional cleanup logic.<a name="line.156"></a>
<span class="sourceLineNo">157</span> *<a name="line.157"></a>
<span class="sourceLineNo">158</span> * @throws InvalidSessionException if this session has stopped or expired prior to calling this method.<a name="line.158"></a>
<span class="sourceLineNo">159</span> */<a name="line.159"></a>
<span class="sourceLineNo">160</span> void stop() throws InvalidSessionException;<a name="line.160"></a>
<span class="sourceLineNo">161</span><a name="line.161"></a>
<span class="sourceLineNo">162</span> /**<a name="line.162"></a>
<span class="sourceLineNo">163</span> * Returns the keys of all the attributes stored under this session. If there are no<a name="line.163"></a>
<span class="sourceLineNo">164</span> * attributes, this returns an empty collection.<a name="line.164"></a>
<span class="sourceLineNo">165</span> *<a name="line.165"></a>
<span class="sourceLineNo">166</span> * @return the keys of all attributes stored under this session, or an empty collection if<a name="line.166"></a>
<span class="sourceLineNo">167</span> * there are no session attributes.<a name="line.167"></a>
<span class="sourceLineNo">168</span> * @throws InvalidSessionException if this session has stopped or expired prior to calling this method.<a name="line.168"></a>
<span class="sourceLineNo">169</span> * @since 0.2<a name="line.169"></a>
<span class="sourceLineNo">170</span> */<a name="line.170"></a>
<span class="sourceLineNo">171</span> Collection&lt;Object&gt; getAttributeKeys() throws InvalidSessionException;<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span> /**<a name="line.173"></a>
<span class="sourceLineNo">174</span> * Returns the object bound to this session identified by the specified key. If there is no<a name="line.174"></a>
<span class="sourceLineNo">175</span> * object bound under the key, {@code null} is returned.<a name="line.175"></a>
<span class="sourceLineNo">176</span> *<a name="line.176"></a>
<span class="sourceLineNo">177</span> * @param key the unique name of the object bound to this session<a name="line.177"></a>
<span class="sourceLineNo">178</span> * @return the object bound under the specified {@code key} name or {@code null} if there is<a name="line.178"></a>
<span class="sourceLineNo">179</span> * no object bound under that name.<a name="line.179"></a>
<span class="sourceLineNo">180</span> * @throws InvalidSessionException if this session has stopped or expired prior to calling<a name="line.180"></a>
<span class="sourceLineNo">181</span> * this method.<a name="line.181"></a>
<span class="sourceLineNo">182</span> */<a name="line.182"></a>
<span class="sourceLineNo">183</span> Object getAttribute(Object key) throws InvalidSessionException;<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>
<span class="sourceLineNo">186</span> * Binds the specified {@code value} to this session, uniquely identified by the specified<a name="line.186"></a>
<span class="sourceLineNo">187</span> * {@code key} name. If there is already an object bound under the {@code key} name, that<a name="line.187"></a>
<span class="sourceLineNo">188</span> * existing object will be replaced by the new {@code value}.<a name="line.188"></a>
<span class="sourceLineNo">189</span> * &lt;p/&gt;<a name="line.189"></a>
<span class="sourceLineNo">190</span> * If the {@code value} parameter is null, it has the same effect as if<a name="line.190"></a>
<span class="sourceLineNo">191</span> * {@link #removeAttribute(Object) removeAttribute} was called.<a name="line.191"></a>
<span class="sourceLineNo">192</span> *<a name="line.192"></a>
<span class="sourceLineNo">193</span> * @param key the name under which the {@code value} object will be bound in this session<a name="line.193"></a>
<span class="sourceLineNo">194</span> * @param value the object to bind in this session.<a name="line.194"></a>
<span class="sourceLineNo">195</span> * @throws InvalidSessionException if this session has stopped or expired prior to calling<a name="line.195"></a>
<span class="sourceLineNo">196</span> * this method.<a name="line.196"></a>
<span class="sourceLineNo">197</span> */<a name="line.197"></a>
<span class="sourceLineNo">198</span> void setAttribute(Object key, Object value) throws InvalidSessionException;<a name="line.198"></a>
<span class="sourceLineNo">199</span><a name="line.199"></a>
<span class="sourceLineNo">200</span> /**<a name="line.200"></a>
<span class="sourceLineNo">201</span> * Removes (unbinds) the object bound to this session under the specified {@code key} name.<a name="line.201"></a>
<span class="sourceLineNo">202</span> *<a name="line.202"></a>
<span class="sourceLineNo">203</span> * @param key the name uniquely identifying the object to remove<a name="line.203"></a>
<span class="sourceLineNo">204</span> * @return the object removed or {@code null} if there was no object bound under the name<a name="line.204"></a>
<span class="sourceLineNo">205</span> * {@code key}.<a name="line.205"></a>
<span class="sourceLineNo">206</span> * @throws InvalidSessionException if this session has stopped or expired prior to calling<a name="line.206"></a>
<span class="sourceLineNo">207</span> * this method.<a name="line.207"></a>
<span class="sourceLineNo">208</span> */<a name="line.208"></a>
<span class="sourceLineNo">209</span> Object removeAttribute(Object key) throws InvalidSessionException;<a name="line.209"></a>
<span class="sourceLineNo">210</span>}<a name="line.210"></a>
</pre>
</div>
</body>
</html>