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