Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.5.0 / shiro-web / apidocs / src-html / org / apache / shiro / web / servlet / ShiroHttpSession.html
blob: 531259a28ff091e7c6766931a645e872b5d5dd5f [file] [log] [blame]
<!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.web.servlet;</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">import org.apache.shiro.web.session.HttpServletSession;</a>
<span class="sourceLineNo">024</span><a id="line.24"></a>
<span class="sourceLineNo">025</span><a id="line.25">import javax.servlet.ServletContext;</a>
<span class="sourceLineNo">026</span><a id="line.26">import javax.servlet.http.HttpServletRequest;</a>
<span class="sourceLineNo">027</span><a id="line.27">import javax.servlet.http.HttpSession;</a>
<span class="sourceLineNo">028</span><a id="line.28">import javax.servlet.http.HttpSessionBindingEvent;</a>
<span class="sourceLineNo">029</span><a id="line.29">import javax.servlet.http.HttpSessionBindingListener;</a>
<span class="sourceLineNo">030</span><a id="line.30">import java.util.*;</a>
<span class="sourceLineNo">031</span><a id="line.31"></a>
<span class="sourceLineNo">032</span><a id="line.32"></a>
<span class="sourceLineNo">033</span><a id="line.33">/**</a>
<span class="sourceLineNo">034</span><a id="line.34"> * Wrapper class that uses a Shiro {@link Session Session} under the hood for all session operations instead of the</a>
<span class="sourceLineNo">035</span><a id="line.35"> * Servlet Container's session mechanism. This is required in heterogeneous client environments where the Session</a>
<span class="sourceLineNo">036</span><a id="line.36"> * is used on both the business tier as well as in multiple client technologies (web, swing, flash, etc) since</a>
<span class="sourceLineNo">037</span><a id="line.37"> * Servlet container sessions alone cannot support this feature.</a>
<span class="sourceLineNo">038</span><a id="line.38"> *</a>
<span class="sourceLineNo">039</span><a id="line.39"> * @since 0.2</a>
<span class="sourceLineNo">040</span><a id="line.40"> */</a>
<span class="sourceLineNo">041</span><a id="line.41">public class ShiroHttpSession implements HttpSession {</a>
<span class="sourceLineNo">042</span><a id="line.42"></a>
<span class="sourceLineNo">043</span><a id="line.43"> //TODO - complete JavaDoc</a>
<span class="sourceLineNo">044</span><a id="line.44"></a>
<span class="sourceLineNo">045</span><a id="line.45"> public static final String DEFAULT_SESSION_ID_NAME = "JSESSIONID";</a>
<span class="sourceLineNo">046</span><a id="line.46"></a>
<span class="sourceLineNo">047</span><a id="line.47"> private static final Enumeration EMPTY_ENUMERATION = new Enumeration() {</a>
<span class="sourceLineNo">048</span><a id="line.48"> public boolean hasMoreElements() {</a>
<span class="sourceLineNo">049</span><a id="line.49"> return false;</a>
<span class="sourceLineNo">050</span><a id="line.50"> }</a>
<span class="sourceLineNo">051</span><a id="line.51"></a>
<span class="sourceLineNo">052</span><a id="line.52"> public Object nextElement() {</a>
<span class="sourceLineNo">053</span><a id="line.53"> return null;</a>
<span class="sourceLineNo">054</span><a id="line.54"> }</a>
<span class="sourceLineNo">055</span><a id="line.55"> };</a>
<span class="sourceLineNo">056</span><a id="line.56"></a>
<span class="sourceLineNo">057</span><a id="line.57"> @SuppressWarnings({"deprecation"})</a>
<span class="sourceLineNo">058</span><a id="line.58"> private static final javax.servlet.http.HttpSessionContext HTTP_SESSION_CONTEXT =</a>
<span class="sourceLineNo">059</span><a id="line.59"> new javax.servlet.http.HttpSessionContext() {</a>
<span class="sourceLineNo">060</span><a id="line.60"> public HttpSession getSession(String s) {</a>
<span class="sourceLineNo">061</span><a id="line.61"> return null;</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"> public Enumeration getIds() {</a>
<span class="sourceLineNo">065</span><a id="line.65"> return EMPTY_ENUMERATION;</a>
<span class="sourceLineNo">066</span><a id="line.66"> }</a>
<span class="sourceLineNo">067</span><a id="line.67"> };</a>
<span class="sourceLineNo">068</span><a id="line.68"></a>
<span class="sourceLineNo">069</span><a id="line.69"> protected ServletContext servletContext = null;</a>
<span class="sourceLineNo">070</span><a id="line.70"> protected HttpServletRequest currentRequest = null;</a>
<span class="sourceLineNo">071</span><a id="line.71"> protected Session session = null; //'real' Shiro Session</a>
<span class="sourceLineNo">072</span><a id="line.72"></a>
<span class="sourceLineNo">073</span><a id="line.73"> public ShiroHttpSession(Session session, HttpServletRequest currentRequest, ServletContext servletContext) {</a>
<span class="sourceLineNo">074</span><a id="line.74"> if (session instanceof HttpServletSession) {</a>
<span class="sourceLineNo">075</span><a id="line.75"> String msg = "Session constructor argument cannot be an instance of HttpServletSession. This is enforced to " +</a>
<span class="sourceLineNo">076</span><a id="line.76"> "prevent circular dependencies and infinite loops.";</a>
<span class="sourceLineNo">077</span><a id="line.77"> throw new IllegalArgumentException(msg);</a>
<span class="sourceLineNo">078</span><a id="line.78"> }</a>
<span class="sourceLineNo">079</span><a id="line.79"> this.session = session;</a>
<span class="sourceLineNo">080</span><a id="line.80"> this.currentRequest = currentRequest;</a>
<span class="sourceLineNo">081</span><a id="line.81"> this.servletContext = servletContext;</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"> public Session getSession() {</a>
<span class="sourceLineNo">085</span><a id="line.85"> return this.session;</a>
<span class="sourceLineNo">086</span><a id="line.86"> }</a>
<span class="sourceLineNo">087</span><a id="line.87"></a>
<span class="sourceLineNo">088</span><a id="line.88"> public long getCreationTime() {</a>
<span class="sourceLineNo">089</span><a id="line.89"> try {</a>
<span class="sourceLineNo">090</span><a id="line.90"> return getSession().getStartTimestamp().getTime();</a>
<span class="sourceLineNo">091</span><a id="line.91"> } catch (Exception e) {</a>
<span class="sourceLineNo">092</span><a id="line.92"> throw new IllegalStateException(e);</a>
<span class="sourceLineNo">093</span><a id="line.93"> }</a>
<span class="sourceLineNo">094</span><a id="line.94"> }</a>
<span class="sourceLineNo">095</span><a id="line.95"></a>
<span class="sourceLineNo">096</span><a id="line.96"> public String getId() {</a>
<span class="sourceLineNo">097</span><a id="line.97"> return getSession().getId().toString();</a>
<span class="sourceLineNo">098</span><a id="line.98"> }</a>
<span class="sourceLineNo">099</span><a id="line.99"></a>
<span class="sourceLineNo">100</span><a id="line.100"> public long getLastAccessedTime() {</a>
<span class="sourceLineNo">101</span><a id="line.101"> return getSession().getLastAccessTime().getTime();</a>
<span class="sourceLineNo">102</span><a id="line.102"> }</a>
<span class="sourceLineNo">103</span><a id="line.103"></a>
<span class="sourceLineNo">104</span><a id="line.104"> public ServletContext getServletContext() {</a>
<span class="sourceLineNo">105</span><a id="line.105"> return this.servletContext;</a>
<span class="sourceLineNo">106</span><a id="line.106"> }</a>
<span class="sourceLineNo">107</span><a id="line.107"></a>
<span class="sourceLineNo">108</span><a id="line.108"> public void setMaxInactiveInterval(int i) {</a>
<span class="sourceLineNo">109</span><a id="line.109"> try {</a>
<span class="sourceLineNo">110</span><a id="line.110"> getSession().setTimeout(i * 1000L);</a>
<span class="sourceLineNo">111</span><a id="line.111"> } catch (InvalidSessionException e) {</a>
<span class="sourceLineNo">112</span><a id="line.112"> throw new IllegalStateException(e);</a>
<span class="sourceLineNo">113</span><a id="line.113"> }</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"> public int getMaxInactiveInterval() {</a>
<span class="sourceLineNo">117</span><a id="line.117"> try {</a>
<span class="sourceLineNo">118</span><a id="line.118"> return (new Long(getSession().getTimeout() / 1000)).intValue();</a>
<span class="sourceLineNo">119</span><a id="line.119"> } catch (InvalidSessionException e) {</a>
<span class="sourceLineNo">120</span><a id="line.120"> throw new IllegalStateException(e);</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"> @SuppressWarnings({"deprecation"})</a>
<span class="sourceLineNo">125</span><a id="line.125"> public javax.servlet.http.HttpSessionContext getSessionContext() {</a>
<span class="sourceLineNo">126</span><a id="line.126"> return HTTP_SESSION_CONTEXT;</a>
<span class="sourceLineNo">127</span><a id="line.127"> }</a>
<span class="sourceLineNo">128</span><a id="line.128"></a>
<span class="sourceLineNo">129</span><a id="line.129"> public Object getAttribute(String s) {</a>
<span class="sourceLineNo">130</span><a id="line.130"> try {</a>
<span class="sourceLineNo">131</span><a id="line.131"> return getSession().getAttribute(s);</a>
<span class="sourceLineNo">132</span><a id="line.132"> } catch (InvalidSessionException e) {</a>
<span class="sourceLineNo">133</span><a id="line.133"> throw new IllegalStateException(e);</a>
<span class="sourceLineNo">134</span><a id="line.134"> }</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"> public Object getValue(String s) {</a>
<span class="sourceLineNo">138</span><a id="line.138"> return getAttribute(s);</a>
<span class="sourceLineNo">139</span><a id="line.139"> }</a>
<span class="sourceLineNo">140</span><a id="line.140"></a>
<span class="sourceLineNo">141</span><a id="line.141"> @SuppressWarnings({"unchecked"})</a>
<span class="sourceLineNo">142</span><a id="line.142"> protected Set&lt;String&gt; getKeyNames() {</a>
<span class="sourceLineNo">143</span><a id="line.143"> Collection&lt;Object&gt; keySet;</a>
<span class="sourceLineNo">144</span><a id="line.144"> try {</a>
<span class="sourceLineNo">145</span><a id="line.145"> keySet = getSession().getAttributeKeys();</a>
<span class="sourceLineNo">146</span><a id="line.146"> } catch (InvalidSessionException e) {</a>
<span class="sourceLineNo">147</span><a id="line.147"> throw new IllegalStateException(e);</a>
<span class="sourceLineNo">148</span><a id="line.148"> }</a>
<span class="sourceLineNo">149</span><a id="line.149"> Set&lt;String&gt; keyNames;</a>
<span class="sourceLineNo">150</span><a id="line.150"> if (keySet != null &amp;&amp; !keySet.isEmpty()) {</a>
<span class="sourceLineNo">151</span><a id="line.151"> keyNames = new HashSet&lt;String&gt;(keySet.size());</a>
<span class="sourceLineNo">152</span><a id="line.152"> for (Object o : keySet) {</a>
<span class="sourceLineNo">153</span><a id="line.153"> keyNames.add(o.toString());</a>
<span class="sourceLineNo">154</span><a id="line.154"> }</a>
<span class="sourceLineNo">155</span><a id="line.155"> } else {</a>
<span class="sourceLineNo">156</span><a id="line.156"> keyNames = Collections.EMPTY_SET;</a>
<span class="sourceLineNo">157</span><a id="line.157"> }</a>
<span class="sourceLineNo">158</span><a id="line.158"> return keyNames;</a>
<span class="sourceLineNo">159</span><a id="line.159"> }</a>
<span class="sourceLineNo">160</span><a id="line.160"></a>
<span class="sourceLineNo">161</span><a id="line.161"> public Enumeration getAttributeNames() {</a>
<span class="sourceLineNo">162</span><a id="line.162"> Set&lt;String&gt; keyNames = getKeyNames();</a>
<span class="sourceLineNo">163</span><a id="line.163"> final Iterator iterator = keyNames.iterator();</a>
<span class="sourceLineNo">164</span><a id="line.164"> return new Enumeration() {</a>
<span class="sourceLineNo">165</span><a id="line.165"> public boolean hasMoreElements() {</a>
<span class="sourceLineNo">166</span><a id="line.166"> return iterator.hasNext();</a>
<span class="sourceLineNo">167</span><a id="line.167"> }</a>
<span class="sourceLineNo">168</span><a id="line.168"></a>
<span class="sourceLineNo">169</span><a id="line.169"> public Object nextElement() {</a>
<span class="sourceLineNo">170</span><a id="line.170"> return iterator.next();</a>
<span class="sourceLineNo">171</span><a id="line.171"> }</a>
<span class="sourceLineNo">172</span><a id="line.172"> };</a>
<span class="sourceLineNo">173</span><a id="line.173"> }</a>
<span class="sourceLineNo">174</span><a id="line.174"></a>
<span class="sourceLineNo">175</span><a id="line.175"> public String[] getValueNames() {</a>
<span class="sourceLineNo">176</span><a id="line.176"> Set&lt;String&gt; keyNames = getKeyNames();</a>
<span class="sourceLineNo">177</span><a id="line.177"> String[] array = new String[keyNames.size()];</a>
<span class="sourceLineNo">178</span><a id="line.178"> if (keyNames.size() &gt; 0) {</a>
<span class="sourceLineNo">179</span><a id="line.179"> array = keyNames.toArray(array);</a>
<span class="sourceLineNo">180</span><a id="line.180"> }</a>
<span class="sourceLineNo">181</span><a id="line.181"> return array;</a>
<span class="sourceLineNo">182</span><a id="line.182"> }</a>
<span class="sourceLineNo">183</span><a id="line.183"></a>
<span class="sourceLineNo">184</span><a id="line.184"> protected void afterBound(String s, Object o) {</a>
<span class="sourceLineNo">185</span><a id="line.185"> if (o instanceof HttpSessionBindingListener) {</a>
<span class="sourceLineNo">186</span><a id="line.186"> HttpSessionBindingListener listener = (HttpSessionBindingListener) o;</a>
<span class="sourceLineNo">187</span><a id="line.187"> HttpSessionBindingEvent event = new HttpSessionBindingEvent(this, s, o);</a>
<span class="sourceLineNo">188</span><a id="line.188"> listener.valueBound(event);</a>
<span class="sourceLineNo">189</span><a id="line.189"> }</a>
<span class="sourceLineNo">190</span><a id="line.190"> }</a>
<span class="sourceLineNo">191</span><a id="line.191"></a>
<span class="sourceLineNo">192</span><a id="line.192"> protected void afterUnbound(String s, Object o) {</a>
<span class="sourceLineNo">193</span><a id="line.193"> if (o instanceof HttpSessionBindingListener) {</a>
<span class="sourceLineNo">194</span><a id="line.194"> HttpSessionBindingListener listener = (HttpSessionBindingListener) o;</a>
<span class="sourceLineNo">195</span><a id="line.195"> HttpSessionBindingEvent event = new HttpSessionBindingEvent(this, s, o);</a>
<span class="sourceLineNo">196</span><a id="line.196"> listener.valueUnbound(event);</a>
<span class="sourceLineNo">197</span><a id="line.197"> }</a>
<span class="sourceLineNo">198</span><a id="line.198"> }</a>
<span class="sourceLineNo">199</span><a id="line.199"></a>
<span class="sourceLineNo">200</span><a id="line.200"> public void setAttribute(String s, Object o) {</a>
<span class="sourceLineNo">201</span><a id="line.201"> try {</a>
<span class="sourceLineNo">202</span><a id="line.202"> getSession().setAttribute(s, o);</a>
<span class="sourceLineNo">203</span><a id="line.203"> afterBound(s, o);</a>
<span class="sourceLineNo">204</span><a id="line.204"> } catch (InvalidSessionException e) {</a>
<span class="sourceLineNo">205</span><a id="line.205"> //noinspection finally</a>
<span class="sourceLineNo">206</span><a id="line.206"> try {</a>
<span class="sourceLineNo">207</span><a id="line.207"> afterUnbound(s, o);</a>
<span class="sourceLineNo">208</span><a id="line.208"> } finally {</a>
<span class="sourceLineNo">209</span><a id="line.209"> //noinspection ThrowFromFinallyBlock</a>
<span class="sourceLineNo">210</span><a id="line.210"> throw new IllegalStateException(e);</a>
<span class="sourceLineNo">211</span><a id="line.211"> }</a>
<span class="sourceLineNo">212</span><a id="line.212"> }</a>
<span class="sourceLineNo">213</span><a id="line.213"> }</a>
<span class="sourceLineNo">214</span><a id="line.214"></a>
<span class="sourceLineNo">215</span><a id="line.215"> public void putValue(String s, Object o) {</a>
<span class="sourceLineNo">216</span><a id="line.216"> setAttribute(s, o);</a>
<span class="sourceLineNo">217</span><a id="line.217"> }</a>
<span class="sourceLineNo">218</span><a id="line.218"></a>
<span class="sourceLineNo">219</span><a id="line.219"> public void removeAttribute(String s) {</a>
<span class="sourceLineNo">220</span><a id="line.220"> try {</a>
<span class="sourceLineNo">221</span><a id="line.221"> Object attribute = getSession().removeAttribute(s);</a>
<span class="sourceLineNo">222</span><a id="line.222"> afterUnbound(s, attribute);</a>
<span class="sourceLineNo">223</span><a id="line.223"> } catch (InvalidSessionException e) {</a>
<span class="sourceLineNo">224</span><a id="line.224"> throw new IllegalStateException(e);</a>
<span class="sourceLineNo">225</span><a id="line.225"> }</a>
<span class="sourceLineNo">226</span><a id="line.226"> }</a>
<span class="sourceLineNo">227</span><a id="line.227"></a>
<span class="sourceLineNo">228</span><a id="line.228"> public void removeValue(String s) {</a>
<span class="sourceLineNo">229</span><a id="line.229"> removeAttribute(s);</a>
<span class="sourceLineNo">230</span><a id="line.230"> }</a>
<span class="sourceLineNo">231</span><a id="line.231"></a>
<span class="sourceLineNo">232</span><a id="line.232"> public void invalidate() {</a>
<span class="sourceLineNo">233</span><a id="line.233"> try {</a>
<span class="sourceLineNo">234</span><a id="line.234"> getSession().stop();</a>
<span class="sourceLineNo">235</span><a id="line.235"> } catch (InvalidSessionException e) {</a>
<span class="sourceLineNo">236</span><a id="line.236"> throw new IllegalStateException(e);</a>
<span class="sourceLineNo">237</span><a id="line.237"> }</a>
<span class="sourceLineNo">238</span><a id="line.238"> }</a>
<span class="sourceLineNo">239</span><a id="line.239"></a>
<span class="sourceLineNo">240</span><a id="line.240"> public boolean isNew() {</a>
<span class="sourceLineNo">241</span><a id="line.241"> Boolean value = (Boolean) currentRequest.getAttribute(ShiroHttpServletRequest.REFERENCED_SESSION_IS_NEW);</a>
<span class="sourceLineNo">242</span><a id="line.242"> return value != null &amp;&amp; value.equals(Boolean.TRUE);</a>
<span class="sourceLineNo">243</span><a id="line.243"> }</a>
<span class="sourceLineNo">244</span><a id="line.244">}</a>
</pre>
</div>
</main>
</body>
</html>