| <!DOCTYPE HTML> |
| <html lang="en"> |
| <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.session;</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.util.StringUtils;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import org.apache.shiro.web.servlet.ShiroHttpSession;</a> |
| <span class="sourceLineNo">025</span><a id="line.25"></a> |
| <span class="sourceLineNo">026</span><a id="line.26">import javax.servlet.http.HttpSession;</a> |
| <span class="sourceLineNo">027</span><a id="line.27">import java.io.Serializable;</a> |
| <span class="sourceLineNo">028</span><a id="line.28">import java.util.ArrayList;</a> |
| <span class="sourceLineNo">029</span><a id="line.29">import java.util.Collection;</a> |
| <span class="sourceLineNo">030</span><a id="line.30">import java.util.Date;</a> |
| <span class="sourceLineNo">031</span><a id="line.31">import java.util.Enumeration;</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"> * {@link Session Session} implementation that is backed entirely by a standard servlet container</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * {@link HttpSession HttpSession} instance. It does not interact with any of Shiro's session-related components</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * {@code SessionManager}, {@code SecurityManager}, etc, and instead satisfies all method implementations by interacting</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * with a servlet container provided {@link HttpSession HttpSession} instance.</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> *</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * @since 1.0</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> */</a> |
| <span class="sourceLineNo">041</span><a id="line.41">public class HttpServletSession implements Session {</a> |
| <span class="sourceLineNo">042</span><a id="line.42"></a> |
| <span class="sourceLineNo">043</span><a id="line.43"> private static final String HOST_SESSION_KEY = HttpServletSession.class.getName() + ".HOST_SESSION_KEY";</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> private static final String TOUCH_OBJECT_SESSION_KEY = HttpServletSession.class.getName() + ".TOUCH_OBJECT_SESSION_KEY";</a> |
| <span class="sourceLineNo">045</span><a id="line.45"></a> |
| <span class="sourceLineNo">046</span><a id="line.46"> private HttpSession httpSession = null;</a> |
| <span class="sourceLineNo">047</span><a id="line.47"></a> |
| <span class="sourceLineNo">048</span><a id="line.48"> public HttpServletSession(HttpSession httpSession, String host) {</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> if (httpSession == null) {</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> String msg = "HttpSession constructor argument cannot be null.";</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> throw new IllegalArgumentException(msg);</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> }</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> if (httpSession instanceof ShiroHttpSession) {</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> String msg = "HttpSession constructor argument cannot be an instance of ShiroHttpSession. This " +</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> "is enforced to prevent circular dependencies and infinite loops.";</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> throw new IllegalArgumentException(msg);</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> }</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> this.httpSession = httpSession;</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> if (StringUtils.hasText(host)) {</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> setHost(host);</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> }</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 Serializable getId() {</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> return httpSession.getId();</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"> public Date getStartTimestamp() {</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> return new Date(httpSession.getCreationTime());</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> }</a> |
| <span class="sourceLineNo">071</span><a id="line.71"></a> |
| <span class="sourceLineNo">072</span><a id="line.72"> public Date getLastAccessTime() {</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> return new Date(httpSession.getLastAccessedTime());</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"> public long getTimeout() throws InvalidSessionException {</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> try {</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> return httpSession.getMaxInactiveInterval() * 1000L;</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> } catch (Exception e) {</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> throw new InvalidSessionException(e);</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"> public void setTimeout(long maxIdleTimeInMillis) throws InvalidSessionException {</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> try {</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> int timeout = Long.valueOf(maxIdleTimeInMillis / 1000).intValue();</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> httpSession.setMaxInactiveInterval(timeout);</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> } catch (Exception e) {</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> throw new InvalidSessionException(e);</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> }</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"> protected void setHost(String host) {</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> setAttribute(HOST_SESSION_KEY, host);</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> }</a> |
| <span class="sourceLineNo">096</span><a id="line.96"></a> |
| <span class="sourceLineNo">097</span><a id="line.97"> public String getHost() {</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> return (String) getAttribute(HOST_SESSION_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 void touch() throws InvalidSessionException {</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> //just manipulate the session to update the access time:</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> try {</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> httpSession.setAttribute(TOUCH_OBJECT_SESSION_KEY, TOUCH_OBJECT_SESSION_KEY);</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> httpSession.removeAttribute(TOUCH_OBJECT_SESSION_KEY);</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> } catch (Exception e) {</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> throw new InvalidSessionException(e);</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> }</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> }</a> |
| <span class="sourceLineNo">110</span><a id="line.110"></a> |
| <span class="sourceLineNo">111</span><a id="line.111"> public void stop() throws InvalidSessionException {</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> try {</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> httpSession.invalidate();</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> } catch (Exception e) {</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> throw new InvalidSessionException(e);</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> }</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> }</a> |
| <span class="sourceLineNo">118</span><a id="line.118"></a> |
| <span class="sourceLineNo">119</span><a id="line.119"> public Collection<Object> getAttributeKeys() throws InvalidSessionException {</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> try {</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> Enumeration namesEnum = httpSession.getAttributeNames();</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> Collection<Object> keys = null;</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> if (namesEnum != null) {</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> keys = new ArrayList<Object>();</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> while (namesEnum.hasMoreElements()) {</a> |
| <span class="sourceLineNo">126</span><a id="line.126"> keys.add(namesEnum.nextElement());</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"> return keys;</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> } catch (Exception e) {</a> |
| <span class="sourceLineNo">131</span><a id="line.131"> throw new InvalidSessionException(e);</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> }</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> }</a> |
| <span class="sourceLineNo">134</span><a id="line.134"></a> |
| <span class="sourceLineNo">135</span><a id="line.135"> private static String assertString(Object key) {</a> |
| <span class="sourceLineNo">136</span><a id="line.136"> if (!(key instanceof String)) {</a> |
| <span class="sourceLineNo">137</span><a id="line.137"> String msg = "HttpSession based implementations of the Shiro Session interface requires attribute keys " +</a> |
| <span class="sourceLineNo">138</span><a id="line.138"> "to be String objects. The HttpSession class does not support anything other than String keys.";</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> throw new IllegalArgumentException(msg);</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> }</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> return (String) key;</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"> public Object getAttribute(Object key) throws InvalidSessionException {</a> |
| <span class="sourceLineNo">145</span><a id="line.145"> try {</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> return httpSession.getAttribute(assertString(key));</a> |
| <span class="sourceLineNo">147</span><a id="line.147"> } catch (Exception e) {</a> |
| <span class="sourceLineNo">148</span><a id="line.148"> throw new InvalidSessionException(e);</a> |
| <span class="sourceLineNo">149</span><a id="line.149"> }</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> }</a> |
| <span class="sourceLineNo">151</span><a id="line.151"></a> |
| <span class="sourceLineNo">152</span><a id="line.152"> public void setAttribute(Object key, Object value) throws InvalidSessionException {</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> try {</a> |
| <span class="sourceLineNo">154</span><a id="line.154"> httpSession.setAttribute(assertString(key), value);</a> |
| <span class="sourceLineNo">155</span><a id="line.155"> } catch (Exception e) {</a> |
| <span class="sourceLineNo">156</span><a id="line.156"> throw new InvalidSessionException(e);</a> |
| <span class="sourceLineNo">157</span><a id="line.157"> }</a> |
| <span class="sourceLineNo">158</span><a id="line.158"> }</a> |
| <span class="sourceLineNo">159</span><a id="line.159"></a> |
| <span class="sourceLineNo">160</span><a id="line.160"> public Object removeAttribute(Object key) throws InvalidSessionException {</a> |
| <span class="sourceLineNo">161</span><a id="line.161"> try {</a> |
| <span class="sourceLineNo">162</span><a id="line.162"> String sKey = assertString(key);</a> |
| <span class="sourceLineNo">163</span><a id="line.163"> Object removed = httpSession.getAttribute(sKey);</a> |
| <span class="sourceLineNo">164</span><a id="line.164"> httpSession.removeAttribute(sKey);</a> |
| <span class="sourceLineNo">165</span><a id="line.165"> return removed;</a> |
| <span class="sourceLineNo">166</span><a id="line.166"> } catch (Exception e) {</a> |
| <span class="sourceLineNo">167</span><a id="line.167"> throw new InvalidSessionException(e);</a> |
| <span class="sourceLineNo">168</span><a id="line.168"> }</a> |
| <span class="sourceLineNo">169</span><a id="line.169"> }</a> |
| <span class="sourceLineNo">170</span><a id="line.170">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
