Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.8.0 / shiro-core / apidocs / src-html / org / apache / shiro / session / mgt / AbstractNativeSessionManager.html
blob: b242f85f5c30529d4adb6cf0a56eab700dad0318 [file] [log] [blame]
<!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.session.mgt;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.authz.AuthorizationException;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.event.EventBus;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.event.EventBusAware;</a>
<span class="sourceLineNo">024</span><a id="line.24">import org.apache.shiro.session.InvalidSessionException;</a>
<span class="sourceLineNo">025</span><a id="line.25">import org.apache.shiro.session.Session;</a>
<span class="sourceLineNo">026</span><a id="line.26">import org.apache.shiro.session.SessionException;</a>
<span class="sourceLineNo">027</span><a id="line.27">import org.apache.shiro.session.SessionListener;</a>
<span class="sourceLineNo">028</span><a id="line.28">import org.apache.shiro.session.UnknownSessionException;</a>
<span class="sourceLineNo">029</span><a id="line.29">import org.apache.shiro.util.CollectionUtils;</a>
<span class="sourceLineNo">030</span><a id="line.30">import org.slf4j.Logger;</a>
<span class="sourceLineNo">031</span><a id="line.31">import org.slf4j.LoggerFactory;</a>
<span class="sourceLineNo">032</span><a id="line.32"></a>
<span class="sourceLineNo">033</span><a id="line.33">import java.util.ArrayList;</a>
<span class="sourceLineNo">034</span><a id="line.34">import java.util.Collection;</a>
<span class="sourceLineNo">035</span><a id="line.35">import java.util.Collections;</a>
<span class="sourceLineNo">036</span><a id="line.36">import java.util.Date;</a>
<span class="sourceLineNo">037</span><a id="line.37"></a>
<span class="sourceLineNo">038</span><a id="line.38">/**</a>
<span class="sourceLineNo">039</span><a id="line.39"> * Abstract implementation supporting the {@link NativeSessionManager NativeSessionManager} interface, supporting</a>
<span class="sourceLineNo">040</span><a id="line.40"> * {@link SessionListener SessionListener}s and application of the</a>
<span class="sourceLineNo">041</span><a id="line.41"> * {@link #getGlobalSessionTimeout() globalSessionTimeout}.</a>
<span class="sourceLineNo">042</span><a id="line.42"> *</a>
<span class="sourceLineNo">043</span><a id="line.43"> * @since 1.0</a>
<span class="sourceLineNo">044</span><a id="line.44"> */</a>
<span class="sourceLineNo">045</span><a id="line.45">public abstract class AbstractNativeSessionManager extends AbstractSessionManager implements NativeSessionManager, EventBusAware {</a>
<span class="sourceLineNo">046</span><a id="line.46"></a>
<span class="sourceLineNo">047</span><a id="line.47"> private static final Logger log = LoggerFactory.getLogger(AbstractSessionManager.class);</a>
<span class="sourceLineNo">048</span><a id="line.48"></a>
<span class="sourceLineNo">049</span><a id="line.49"> private EventBus eventBus;</a>
<span class="sourceLineNo">050</span><a id="line.50"></a>
<span class="sourceLineNo">051</span><a id="line.51"> private Collection&lt;SessionListener&gt; listeners;</a>
<span class="sourceLineNo">052</span><a id="line.52"></a>
<span class="sourceLineNo">053</span><a id="line.53"> public AbstractNativeSessionManager() {</a>
<span class="sourceLineNo">054</span><a id="line.54"> this.listeners = new ArrayList&lt;SessionListener&gt;();</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"> public void setSessionListeners(Collection&lt;SessionListener&gt; listeners) {</a>
<span class="sourceLineNo">058</span><a id="line.58"> this.listeners = listeners != null ? listeners : new ArrayList&lt;SessionListener&gt;();</a>
<span class="sourceLineNo">059</span><a id="line.59"> }</a>
<span class="sourceLineNo">060</span><a id="line.60"></a>
<span class="sourceLineNo">061</span><a id="line.61"> @SuppressWarnings({"UnusedDeclaration"})</a>
<span class="sourceLineNo">062</span><a id="line.62"> public Collection&lt;SessionListener&gt; getSessionListeners() {</a>
<span class="sourceLineNo">063</span><a id="line.63"> return this.listeners;</a>
<span class="sourceLineNo">064</span><a id="line.64"> }</a>
<span class="sourceLineNo">065</span><a id="line.65"></a>
<span class="sourceLineNo">066</span><a id="line.66"> /**</a>
<span class="sourceLineNo">067</span><a id="line.67"> * Returns the EventBus used to publish SessionEvents.</a>
<span class="sourceLineNo">068</span><a id="line.68"> *</a>
<span class="sourceLineNo">069</span><a id="line.69"> * @return the EventBus used to publish SessionEvents.</a>
<span class="sourceLineNo">070</span><a id="line.70"> * @since 1.3</a>
<span class="sourceLineNo">071</span><a id="line.71"> */</a>
<span class="sourceLineNo">072</span><a id="line.72"> protected EventBus getEventBus() {</a>
<span class="sourceLineNo">073</span><a id="line.73"> return eventBus;</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"> /**</a>
<span class="sourceLineNo">077</span><a id="line.77"> * Sets the EventBus to use to publish SessionEvents.</a>
<span class="sourceLineNo">078</span><a id="line.78"> *</a>
<span class="sourceLineNo">079</span><a id="line.79"> * @param eventBus the EventBus to use to publish SessionEvents.</a>
<span class="sourceLineNo">080</span><a id="line.80"> * @since 1.3</a>
<span class="sourceLineNo">081</span><a id="line.81"> */</a>
<span class="sourceLineNo">082</span><a id="line.82"> public void setEventBus(EventBus eventBus) {</a>
<span class="sourceLineNo">083</span><a id="line.83"> this.eventBus = eventBus;</a>
<span class="sourceLineNo">084</span><a id="line.84"> }</a>
<span class="sourceLineNo">085</span><a id="line.85"></a>
<span class="sourceLineNo">086</span><a id="line.86"> /**</a>
<span class="sourceLineNo">087</span><a id="line.87"> * Publishes events on the event bus if the event bus is non-null, otherwise does nothing.</a>
<span class="sourceLineNo">088</span><a id="line.88"> *</a>
<span class="sourceLineNo">089</span><a id="line.89"> * @param event the event to publish on the event bus if the event bus exists.</a>
<span class="sourceLineNo">090</span><a id="line.90"> * @since 1.3</a>
<span class="sourceLineNo">091</span><a id="line.91"> */</a>
<span class="sourceLineNo">092</span><a id="line.92"> protected void publishEvent(Object event) {</a>
<span class="sourceLineNo">093</span><a id="line.93"> if (this.eventBus != null) {</a>
<span class="sourceLineNo">094</span><a id="line.94"> this.eventBus.publish(event);</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"></a>
<span class="sourceLineNo">098</span><a id="line.98"> public Session start(SessionContext context) {</a>
<span class="sourceLineNo">099</span><a id="line.99"> Session session = createSession(context);</a>
<span class="sourceLineNo">100</span><a id="line.100"> applyGlobalSessionTimeout(session);</a>
<span class="sourceLineNo">101</span><a id="line.101"> onStart(session, context);</a>
<span class="sourceLineNo">102</span><a id="line.102"> notifyStart(session);</a>
<span class="sourceLineNo">103</span><a id="line.103"> //Don't expose the EIS-tier Session object to the client-tier:</a>
<span class="sourceLineNo">104</span><a id="line.104"> return createExposedSession(session, context);</a>
<span class="sourceLineNo">105</span><a id="line.105"> }</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"> * Creates a new {@code Session Session} instance based on the specified (possibly {@code null})</a>
<span class="sourceLineNo">109</span><a id="line.109"> * initialization data. Implementing classes must manage the persistent state of the returned session such that it</a>
<span class="sourceLineNo">110</span><a id="line.110"> * could later be acquired via the {@link #getSession(SessionKey)} method.</a>
<span class="sourceLineNo">111</span><a id="line.111"> *</a>
<span class="sourceLineNo">112</span><a id="line.112"> * @param context the initialization data that can be used by the implementation or underlying</a>
<span class="sourceLineNo">113</span><a id="line.113"> * {@link SessionFactory} when instantiating the internal {@code Session} instance.</a>
<span class="sourceLineNo">114</span><a id="line.114"> * @return the new {@code Session} instance.</a>
<span class="sourceLineNo">115</span><a id="line.115"> * @throws org.apache.shiro.authz.HostUnauthorizedException</a>
<span class="sourceLineNo">116</span><a id="line.116"> * if the system access control policy restricts access based</a>
<span class="sourceLineNo">117</span><a id="line.117"> * on client location/IP and the specified hostAddress hasn't been enabled.</a>
<span class="sourceLineNo">118</span><a id="line.118"> * @throws AuthorizationException if the system access control policy does not allow the currently executing</a>
<span class="sourceLineNo">119</span><a id="line.119"> * caller to start sessions.</a>
<span class="sourceLineNo">120</span><a id="line.120"> */</a>
<span class="sourceLineNo">121</span><a id="line.121"> protected abstract Session createSession(SessionContext context) throws AuthorizationException;</a>
<span class="sourceLineNo">122</span><a id="line.122"></a>
<span class="sourceLineNo">123</span><a id="line.123"> protected void applyGlobalSessionTimeout(Session session) {</a>
<span class="sourceLineNo">124</span><a id="line.124"> session.setTimeout(getGlobalSessionTimeout());</a>
<span class="sourceLineNo">125</span><a id="line.125"> onChange(session);</a>
<span class="sourceLineNo">126</span><a id="line.126"> }</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"> * Template method that allows subclasses to react to a new session being created.</a>
<span class="sourceLineNo">130</span><a id="line.130"> * &lt;p/&gt;</a>
<span class="sourceLineNo">131</span><a id="line.131"> * This method is invoked &lt;em&gt;before&lt;/em&gt; any session listeners are notified.</a>
<span class="sourceLineNo">132</span><a id="line.132"> *</a>
<span class="sourceLineNo">133</span><a id="line.133"> * @param session the session that was just {@link #createSession created}.</a>
<span class="sourceLineNo">134</span><a id="line.134"> * @param context the {@link SessionContext SessionContext} that was used to start the session.</a>
<span class="sourceLineNo">135</span><a id="line.135"> */</a>
<span class="sourceLineNo">136</span><a id="line.136"> protected void onStart(Session session, SessionContext context) {</a>
<span class="sourceLineNo">137</span><a id="line.137"> }</a>
<span class="sourceLineNo">138</span><a id="line.138"></a>
<span class="sourceLineNo">139</span><a id="line.139"> public Session getSession(SessionKey key) throws SessionException {</a>
<span class="sourceLineNo">140</span><a id="line.140"> Session session = lookupSession(key);</a>
<span class="sourceLineNo">141</span><a id="line.141"> return session != null ? createExposedSession(session, key) : null;</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"> private Session lookupSession(SessionKey key) throws SessionException {</a>
<span class="sourceLineNo">145</span><a id="line.145"> if (key == null) {</a>
<span class="sourceLineNo">146</span><a id="line.146"> throw new NullPointerException("SessionKey argument cannot be null.");</a>
<span class="sourceLineNo">147</span><a id="line.147"> }</a>
<span class="sourceLineNo">148</span><a id="line.148"> return doGetSession(key);</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"> private Session lookupRequiredSession(SessionKey key) throws SessionException {</a>
<span class="sourceLineNo">152</span><a id="line.152"> Session session = lookupSession(key);</a>
<span class="sourceLineNo">153</span><a id="line.153"> if (session == null) {</a>
<span class="sourceLineNo">154</span><a id="line.154"> String msg = "Unable to locate required Session instance based on SessionKey [" + key + "].";</a>
<span class="sourceLineNo">155</span><a id="line.155"> throw new UnknownSessionException(msg);</a>
<span class="sourceLineNo">156</span><a id="line.156"> }</a>
<span class="sourceLineNo">157</span><a id="line.157"> return session;</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"> protected abstract Session doGetSession(SessionKey key) throws InvalidSessionException;</a>
<span class="sourceLineNo">161</span><a id="line.161"></a>
<span class="sourceLineNo">162</span><a id="line.162"> protected Session createExposedSession(Session session, SessionContext context) {</a>
<span class="sourceLineNo">163</span><a id="line.163"> return new DelegatingSession(this, new DefaultSessionKey(session.getId()));</a>
<span class="sourceLineNo">164</span><a id="line.164"> }</a>
<span class="sourceLineNo">165</span><a id="line.165"></a>
<span class="sourceLineNo">166</span><a id="line.166"> protected Session createExposedSession(Session session, SessionKey key) {</a>
<span class="sourceLineNo">167</span><a id="line.167"> return new DelegatingSession(this, new DefaultSessionKey(session.getId()));</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>
<span class="sourceLineNo">171</span><a id="line.171"> * Returns the session instance to use to pass to registered {@code SessionListener}s for notification</a>
<span class="sourceLineNo">172</span><a id="line.172"> * that the session has been invalidated (stopped or expired).</a>
<span class="sourceLineNo">173</span><a id="line.173"> * &lt;p/&gt;</a>
<span class="sourceLineNo">174</span><a id="line.174"> * The default implementation returns an {@link ImmutableProxiedSession ImmutableProxiedSession} instance to ensure</a>
<span class="sourceLineNo">175</span><a id="line.175"> * that the specified {@code session} argument is not modified by any listeners.</a>
<span class="sourceLineNo">176</span><a id="line.176"> *</a>
<span class="sourceLineNo">177</span><a id="line.177"> * @param session the {@code Session} object being invalidated.</a>
<span class="sourceLineNo">178</span><a id="line.178"> * @return the {@code Session} instance to use to pass to registered {@code SessionListener}s for notification.</a>
<span class="sourceLineNo">179</span><a id="line.179"> */</a>
<span class="sourceLineNo">180</span><a id="line.180"> protected Session beforeInvalidNotification(Session session) {</a>
<span class="sourceLineNo">181</span><a id="line.181"> return new ImmutableProxiedSession(session);</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"> /**</a>
<span class="sourceLineNo">185</span><a id="line.185"> * Notifies any interested {@link SessionListener}s that a Session has started. This method is invoked</a>
<span class="sourceLineNo">186</span><a id="line.186"> * &lt;em&gt;after&lt;/em&gt; the {@link #onStart onStart} method is called.</a>
<span class="sourceLineNo">187</span><a id="line.187"> *</a>
<span class="sourceLineNo">188</span><a id="line.188"> * @param session the session that has just started that will be delivered to any</a>
<span class="sourceLineNo">189</span><a id="line.189"> * {@link #setSessionListeners(java.util.Collection) registered} session listeners.</a>
<span class="sourceLineNo">190</span><a id="line.190"> * @see SessionListener#onStart(org.apache.shiro.session.Session)</a>
<span class="sourceLineNo">191</span><a id="line.191"> */</a>
<span class="sourceLineNo">192</span><a id="line.192"> protected void notifyStart(Session session) {</a>
<span class="sourceLineNo">193</span><a id="line.193"> for (SessionListener listener : this.listeners) {</a>
<span class="sourceLineNo">194</span><a id="line.194"> listener.onStart(session);</a>
<span class="sourceLineNo">195</span><a id="line.195"> }</a>
<span class="sourceLineNo">196</span><a id="line.196"> }</a>
<span class="sourceLineNo">197</span><a id="line.197"></a>
<span class="sourceLineNo">198</span><a id="line.198"> protected void notifyStop(Session session) {</a>
<span class="sourceLineNo">199</span><a id="line.199"> Session forNotification = beforeInvalidNotification(session);</a>
<span class="sourceLineNo">200</span><a id="line.200"> for (SessionListener listener : this.listeners) {</a>
<span class="sourceLineNo">201</span><a id="line.201"> listener.onStop(forNotification);</a>
<span class="sourceLineNo">202</span><a id="line.202"> }</a>
<span class="sourceLineNo">203</span><a id="line.203"> }</a>
<span class="sourceLineNo">204</span><a id="line.204"></a>
<span class="sourceLineNo">205</span><a id="line.205"> protected void notifyExpiration(Session session) {</a>
<span class="sourceLineNo">206</span><a id="line.206"> Session forNotification = beforeInvalidNotification(session);</a>
<span class="sourceLineNo">207</span><a id="line.207"> for (SessionListener listener : this.listeners) {</a>
<span class="sourceLineNo">208</span><a id="line.208"> listener.onExpiration(forNotification);</a>
<span class="sourceLineNo">209</span><a id="line.209"> }</a>
<span class="sourceLineNo">210</span><a id="line.210"> }</a>
<span class="sourceLineNo">211</span><a id="line.211"></a>
<span class="sourceLineNo">212</span><a id="line.212"> public Date getStartTimestamp(SessionKey key) {</a>
<span class="sourceLineNo">213</span><a id="line.213"> return lookupRequiredSession(key).getStartTimestamp();</a>
<span class="sourceLineNo">214</span><a id="line.214"> }</a>
<span class="sourceLineNo">215</span><a id="line.215"></a>
<span class="sourceLineNo">216</span><a id="line.216"> public Date getLastAccessTime(SessionKey key) {</a>
<span class="sourceLineNo">217</span><a id="line.217"> return lookupRequiredSession(key).getLastAccessTime();</a>
<span class="sourceLineNo">218</span><a id="line.218"> }</a>
<span class="sourceLineNo">219</span><a id="line.219"></a>
<span class="sourceLineNo">220</span><a id="line.220"> public long getTimeout(SessionKey key) throws InvalidSessionException {</a>
<span class="sourceLineNo">221</span><a id="line.221"> return lookupRequiredSession(key).getTimeout();</a>
<span class="sourceLineNo">222</span><a id="line.222"> }</a>
<span class="sourceLineNo">223</span><a id="line.223"></a>
<span class="sourceLineNo">224</span><a id="line.224"> public void setTimeout(SessionKey key, long maxIdleTimeInMillis) throws InvalidSessionException {</a>
<span class="sourceLineNo">225</span><a id="line.225"> Session s = lookupRequiredSession(key);</a>
<span class="sourceLineNo">226</span><a id="line.226"> s.setTimeout(maxIdleTimeInMillis);</a>
<span class="sourceLineNo">227</span><a id="line.227"> onChange(s);</a>
<span class="sourceLineNo">228</span><a id="line.228"> }</a>
<span class="sourceLineNo">229</span><a id="line.229"></a>
<span class="sourceLineNo">230</span><a id="line.230"> public void touch(SessionKey key) throws InvalidSessionException {</a>
<span class="sourceLineNo">231</span><a id="line.231"> Session s = lookupRequiredSession(key);</a>
<span class="sourceLineNo">232</span><a id="line.232"> s.touch();</a>
<span class="sourceLineNo">233</span><a id="line.233"> onChange(s);</a>
<span class="sourceLineNo">234</span><a id="line.234"> }</a>
<span class="sourceLineNo">235</span><a id="line.235"></a>
<span class="sourceLineNo">236</span><a id="line.236"> public String getHost(SessionKey key) {</a>
<span class="sourceLineNo">237</span><a id="line.237"> return lookupRequiredSession(key).getHost();</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 Collection&lt;Object&gt; getAttributeKeys(SessionKey key) {</a>
<span class="sourceLineNo">241</span><a id="line.241"> Collection&lt;Object&gt; c = lookupRequiredSession(key).getAttributeKeys();</a>
<span class="sourceLineNo">242</span><a id="line.242"> if (!CollectionUtils.isEmpty(c)) {</a>
<span class="sourceLineNo">243</span><a id="line.243"> return Collections.unmodifiableCollection(c);</a>
<span class="sourceLineNo">244</span><a id="line.244"> }</a>
<span class="sourceLineNo">245</span><a id="line.245"> return Collections.emptySet();</a>
<span class="sourceLineNo">246</span><a id="line.246"> }</a>
<span class="sourceLineNo">247</span><a id="line.247"></a>
<span class="sourceLineNo">248</span><a id="line.248"> public Object getAttribute(SessionKey sessionKey, Object attributeKey) throws InvalidSessionException {</a>
<span class="sourceLineNo">249</span><a id="line.249"> return lookupRequiredSession(sessionKey).getAttribute(attributeKey);</a>
<span class="sourceLineNo">250</span><a id="line.250"> }</a>
<span class="sourceLineNo">251</span><a id="line.251"></a>
<span class="sourceLineNo">252</span><a id="line.252"> public void setAttribute(SessionKey sessionKey, Object attributeKey, Object value) throws InvalidSessionException {</a>
<span class="sourceLineNo">253</span><a id="line.253"> if (value == null) {</a>
<span class="sourceLineNo">254</span><a id="line.254"> removeAttribute(sessionKey, attributeKey);</a>
<span class="sourceLineNo">255</span><a id="line.255"> } else {</a>
<span class="sourceLineNo">256</span><a id="line.256"> Session s = lookupRequiredSession(sessionKey);</a>
<span class="sourceLineNo">257</span><a id="line.257"> s.setAttribute(attributeKey, value);</a>
<span class="sourceLineNo">258</span><a id="line.258"> onChange(s);</a>
<span class="sourceLineNo">259</span><a id="line.259"> }</a>
<span class="sourceLineNo">260</span><a id="line.260"> }</a>
<span class="sourceLineNo">261</span><a id="line.261"></a>
<span class="sourceLineNo">262</span><a id="line.262"> public Object removeAttribute(SessionKey sessionKey, Object attributeKey) throws InvalidSessionException {</a>
<span class="sourceLineNo">263</span><a id="line.263"> Session s = lookupRequiredSession(sessionKey);</a>
<span class="sourceLineNo">264</span><a id="line.264"> Object removed = s.removeAttribute(attributeKey);</a>
<span class="sourceLineNo">265</span><a id="line.265"> if (removed != null) {</a>
<span class="sourceLineNo">266</span><a id="line.266"> onChange(s);</a>
<span class="sourceLineNo">267</span><a id="line.267"> }</a>
<span class="sourceLineNo">268</span><a id="line.268"> return removed;</a>
<span class="sourceLineNo">269</span><a id="line.269"> }</a>
<span class="sourceLineNo">270</span><a id="line.270"></a>
<span class="sourceLineNo">271</span><a id="line.271"> public boolean isValid(SessionKey key) {</a>
<span class="sourceLineNo">272</span><a id="line.272"> try {</a>
<span class="sourceLineNo">273</span><a id="line.273"> checkValid(key);</a>
<span class="sourceLineNo">274</span><a id="line.274"> return true;</a>
<span class="sourceLineNo">275</span><a id="line.275"> } catch (InvalidSessionException e) {</a>
<span class="sourceLineNo">276</span><a id="line.276"> return false;</a>
<span class="sourceLineNo">277</span><a id="line.277"> }</a>
<span class="sourceLineNo">278</span><a id="line.278"> }</a>
<span class="sourceLineNo">279</span><a id="line.279"></a>
<span class="sourceLineNo">280</span><a id="line.280"> public void stop(SessionKey key) throws InvalidSessionException {</a>
<span class="sourceLineNo">281</span><a id="line.281"> Session session = lookupRequiredSession(key);</a>
<span class="sourceLineNo">282</span><a id="line.282"> try {</a>
<span class="sourceLineNo">283</span><a id="line.283"> if (log.isDebugEnabled()) {</a>
<span class="sourceLineNo">284</span><a id="line.284"> log.debug("Stopping session with id [" + session.getId() + "]");</a>
<span class="sourceLineNo">285</span><a id="line.285"> }</a>
<span class="sourceLineNo">286</span><a id="line.286"> session.stop();</a>
<span class="sourceLineNo">287</span><a id="line.287"> onStop(session, key);</a>
<span class="sourceLineNo">288</span><a id="line.288"> notifyStop(session);</a>
<span class="sourceLineNo">289</span><a id="line.289"> } finally {</a>
<span class="sourceLineNo">290</span><a id="line.290"> afterStopped(session);</a>
<span class="sourceLineNo">291</span><a id="line.291"> }</a>
<span class="sourceLineNo">292</span><a id="line.292"> }</a>
<span class="sourceLineNo">293</span><a id="line.293"></a>
<span class="sourceLineNo">294</span><a id="line.294"> protected void onStop(Session session, SessionKey key) {</a>
<span class="sourceLineNo">295</span><a id="line.295"> onStop(session);</a>
<span class="sourceLineNo">296</span><a id="line.296"> }</a>
<span class="sourceLineNo">297</span><a id="line.297"></a>
<span class="sourceLineNo">298</span><a id="line.298"> protected void onStop(Session session) {</a>
<span class="sourceLineNo">299</span><a id="line.299"> onChange(session);</a>
<span class="sourceLineNo">300</span><a id="line.300"> }</a>
<span class="sourceLineNo">301</span><a id="line.301"></a>
<span class="sourceLineNo">302</span><a id="line.302"> protected void afterStopped(Session session) {</a>
<span class="sourceLineNo">303</span><a id="line.303"> }</a>
<span class="sourceLineNo">304</span><a id="line.304"></a>
<span class="sourceLineNo">305</span><a id="line.305"> public void checkValid(SessionKey key) throws InvalidSessionException {</a>
<span class="sourceLineNo">306</span><a id="line.306"> //just try to acquire it. If there is a problem, an exception will be thrown:</a>
<span class="sourceLineNo">307</span><a id="line.307"> lookupRequiredSession(key);</a>
<span class="sourceLineNo">308</span><a id="line.308"> }</a>
<span class="sourceLineNo">309</span><a id="line.309"></a>
<span class="sourceLineNo">310</span><a id="line.310"> protected void onChange(Session s) {</a>
<span class="sourceLineNo">311</span><a id="line.311"> }</a>
<span class="sourceLineNo">312</span><a id="line.312">}</a>
</pre>
</div>
</main>
</body>
</html>