| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <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.mgt;<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.Session;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.shiro.subject.PrincipalCollection;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.shiro.subject.Subject;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.shiro.subject.support.DefaultSubjectContext;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.shiro.subject.support.DelegatingSubject;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.shiro.util.CollectionUtils;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.slf4j.Logger;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.slf4j.LoggerFactory;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import java.lang.reflect.Field;<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> * Default {@code SubjectDAO} implementation that stores Subject state in the Subject's Session by default (but this<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * can be disabled - see below). The Subject instance<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * can be re-created at a later time by first acquiring the associated Session (typically from a<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * {@link org.apache.shiro.session.mgt.SessionManager SessionManager}) via a session ID or session key and then<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * building a {@code Subject} instance from {@code Session} attributes.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * <h2>Controlling how Sessions are used</h2><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * Whether or not a {@code Subject}'s {@code Session} is used or not to persist its own state is controlled on a<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <em>per-Subject</em> basis as determined by the configured<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * {@link #setSessionStorageEvaluator(SessionStorageEvaluator) sessionStorageEvaluator}.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * The default {@code Evaluator} is a {@link DefaultSessionStorageEvaluator}, which supports enabling or disabling<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * session usage for Subject persistence at a global level for all subjects (and defaults to allowing sessions to be<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * used).<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * <h3>Disabling Session Persistence Entirely</h3><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * Because the default {@code SessionStorageEvaluator} instance is a {@link DefaultSessionStorageEvaluator}, you<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * can disable Session usage for Subject state entirely by configuring that instance directly, e.g.:<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * <pre><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * ((DefaultSessionStorageEvaluator)sessionDAO.getSessionStorageEvaluator()).setSessionStorageEnabled(false);<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * </pre><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * or, for example, in {@code shiro.ini}:<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * <pre><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * securityManager.subjectDAO.sessionStorageEvaluator.sessionStorageEnabled = false<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * </pre><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * but <b>note:</b> ONLY do this your<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * application is 100% stateless and you <em>DO NOT</em> need subjects to be remembered across remote<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * invocations, or in a web environment across HTTP requests.<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * <h3>Supporting Both Stateful and Stateless Subject paradigms</h3><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * Perhaps your application needs to support a hybrid approach of both stateful and stateless Subjects:<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * <ul><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * <li>Stateful: Stateful subjects might represent web end-users that need their identity and authentication<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * state to be remembered from page to page.</li><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * <li>Stateless: Stateless subjects might represent API clients (e.g. REST clients) that authenticate on every<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * request, and therefore don't need authentication state to be stored across requests in a session.</li><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * </ul><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * To support the hybrid <em>per-Subject</em> approach, you will need to create your own implementation of the<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * {@link SessionStorageEvaluator} interface and configure it via the<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * {@link #setSessionStorageEvaluator(SessionStorageEvaluator)} method, or, with {@code shiro.ini}:<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * <pre><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * myEvaluator = com.my.CustomSessionStorageEvaluator<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * securityManager.subjectDAO.sessionStorageEvaluator = $myEvaluator<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * </pre><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * <p/><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * Unless overridden, the default evaluator is a {@link DefaultSessionStorageEvaluator}, which enables session usage for<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * Subject state by default.<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> *<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * @see #isSessionStorageEnabled(org.apache.shiro.subject.Subject)<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @see SessionStorageEvaluator<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @see DefaultSessionStorageEvaluator<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * @since 1.2<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> */<a name="line.81"></a> |
| <span class="sourceLineNo">082</span>public class DefaultSubjectDAO implements SubjectDAO {<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> private static final Logger log = LoggerFactory.getLogger(DefaultSubjectDAO.class);<a name="line.84"></a> |
| <span class="sourceLineNo">085</span><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> /**<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * Evaluator that determines if a Subject's session may be used to store the Subject's own state.<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> */<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> private SessionStorageEvaluator sessionStorageEvaluator;<a name="line.89"></a> |
| <span class="sourceLineNo">090</span><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> public DefaultSubjectDAO() {<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> //default implementation allows enabling/disabling session usages at a global level for all subjects:<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> this.sessionStorageEvaluator = new DefaultSessionStorageEvaluator();<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> /**<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * Determines if the subject's session will be used to persist subject state or not. This implementation<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * merely delegates to the internal {@link SessionStorageEvaluator} (a<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * {@code DefaultSessionStorageEvaluator} by default).<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> *<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * @param subject the subject to inspect to determine if the subject's session will be used to persist subject<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * state or not.<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * @return {@code true} if the subject's session will be used to persist subject state, {@code false} otherwise.<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * @see #setSessionStorageEvaluator(SessionStorageEvaluator)<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * @see DefaultSessionStorageEvaluator<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> */<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> protected boolean isSessionStorageEnabled(Subject subject) {<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> return getSessionStorageEvaluator().isSessionStorageEnabled(subject);<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> }<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> * Returns the {@code SessionStorageEvaluator} that will determine if a {@code Subject}'s state may be persisted in<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * the Subject's session. The default instance is a {@link DefaultSessionStorageEvaluator}.<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> *<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * @return the {@code SessionStorageEvaluator} that will determine if a {@code Subject}'s state may be persisted in<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * the Subject's session.<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * @see DefaultSessionStorageEvaluator<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> */<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> public SessionStorageEvaluator getSessionStorageEvaluator() {<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> return sessionStorageEvaluator;<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> * Sets the {@code SessionStorageEvaluator} that will determine if a {@code Subject}'s state may be persisted in<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * the Subject's session. The default instance is a {@link DefaultSessionStorageEvaluator}.<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> *<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * @param sessionStorageEvaluator the {@code SessionStorageEvaluator} that will determine if a {@code Subject}'s<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * state may be persisted in the Subject's session.<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * @see DefaultSessionStorageEvaluator<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> */<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> public void setSessionStorageEvaluator(SessionStorageEvaluator sessionStorageEvaluator) {<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> this.sessionStorageEvaluator = sessionStorageEvaluator;<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> }<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> * Saves the subject's state to the subject's {@link org.apache.shiro.subject.Subject#getSession() session} only<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * if {@link #isSessionStorageEnabled(Subject) sessionStorageEnabled(subject)}. If session storage is not enabled<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * for the specific {@code Subject}, this method does nothing.<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * <p/><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * In either case, the argument {@code Subject} is returned directly (a new Subject instance is not created).<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> *<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * @param subject the Subject instance for which its state will be created or updated.<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * @return the same {@code Subject} passed in (a new Subject instance is not created).<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> */<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> public Subject save(Subject subject) {<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> if (isSessionStorageEnabled(subject)) {<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> saveToSession(subject);<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> } else {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> log.trace("Session storage of subject state for Subject [{}] has been disabled: identity and " +<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> "authentication state are expected to be initialized on every request or invocation.", subject);<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> }<a name="line.151"></a> |
| <span class="sourceLineNo">152</span><a name="line.152"></a> |
| <span class="sourceLineNo">153</span> return subject;<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> }<a name="line.154"></a> |
| <span class="sourceLineNo">155</span><a name="line.155"></a> |
| <span class="sourceLineNo">156</span> /**<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * Saves the subject's state (it's principals and authentication state) to its<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * {@link org.apache.shiro.subject.Subject#getSession() session}. The session can be retrieved at a later time<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * (typically from a {@link org.apache.shiro.session.mgt.SessionManager SessionManager} to be used to recreate<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * the {@code Subject} instance.<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> *<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * @param subject the subject for which state will be persisted to its session.<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> */<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> protected void saveToSession(Subject subject) {<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> //performs merge logic, only updating the Subject's session if it does not match the current state:<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> mergePrincipals(subject);<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> mergeAuthenticationState(subject);<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> }<a name="line.168"></a> |
| <span class="sourceLineNo">169</span><a name="line.169"></a> |
| <span class="sourceLineNo">170</span> /**<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * Merges the Subject's current {@link org.apache.shiro.subject.Subject#getPrincipals()} with whatever may be in<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * any available session. Only updates the Subject's session if the session does not match the current principals<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * state.<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> *<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * @param subject the Subject for which principals will potentially be merged into the Subject's session.<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> */<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> protected void mergePrincipals(Subject subject) {<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> //merge PrincipalCollection state:<a name="line.178"></a> |
| <span class="sourceLineNo">179</span><a name="line.179"></a> |
| <span class="sourceLineNo">180</span> PrincipalCollection currentPrincipals = null;<a name="line.180"></a> |
| <span class="sourceLineNo">181</span><a name="line.181"></a> |
| <span class="sourceLineNo">182</span> //SHIRO-380: added if/else block - need to retain original (source) principals<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> //This technique (reflection) is only temporary - a proper long term solution needs to be found,<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> //but this technique allowed an immediate fix that is API point-version forwards and backwards compatible<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> //<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> //A more comprehensive review / cleaning of runAs should be performed for Shiro 1.3 / 2.0 +<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> if (subject.isRunAs() && subject instanceof DelegatingSubject) {<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> try {<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> Field field = DelegatingSubject.class.getDeclaredField("principals");<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> field.setAccessible(true);<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> currentPrincipals = (PrincipalCollection)field.get(subject);<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> } catch (Exception e) {<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> throw new IllegalStateException("Unable to access DelegatingSubject principals property.", e);<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> }<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> }<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> if (currentPrincipals == null || currentPrincipals.isEmpty()) {<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> currentPrincipals = subject.getPrincipals();<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> Session session = subject.getSession(false);<a name="line.200"></a> |
| <span class="sourceLineNo">201</span><a name="line.201"></a> |
| <span class="sourceLineNo">202</span> if (session == null) {<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> if (!CollectionUtils.isEmpty(currentPrincipals)) {<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> session = subject.getSession();<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> session.setAttribute(DefaultSubjectContext.PRINCIPALS_SESSION_KEY, currentPrincipals);<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> }<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> //otherwise no session and no principals - nothing to save<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> } else {<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> PrincipalCollection existingPrincipals =<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> (PrincipalCollection) session.getAttribute(DefaultSubjectContext.PRINCIPALS_SESSION_KEY);<a name="line.210"></a> |
| <span class="sourceLineNo">211</span><a name="line.211"></a> |
| <span class="sourceLineNo">212</span> if (CollectionUtils.isEmpty(currentPrincipals)) {<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> if (!CollectionUtils.isEmpty(existingPrincipals)) {<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> session.removeAttribute(DefaultSubjectContext.PRINCIPALS_SESSION_KEY);<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> }<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> //otherwise both are null or empty - no need to update the session<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> } else {<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> if (!currentPrincipals.equals(existingPrincipals)) {<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> session.setAttribute(DefaultSubjectContext.PRINCIPALS_SESSION_KEY, currentPrincipals);<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> }<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> //otherwise they're the same - no need to update the session<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> }<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> }<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> }<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> * Merges the Subject's current authentication state with whatever may be in<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> * any available session. Only updates the Subject's session if the session does not match the current<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> * authentication state.<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> *<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * @param subject the Subject for which principals will potentially be merged into the Subject's session.<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> */<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> protected void mergeAuthenticationState(Subject subject) {<a name="line.233"></a> |
| <span class="sourceLineNo">234</span><a name="line.234"></a> |
| <span class="sourceLineNo">235</span> Session session = subject.getSession(false);<a name="line.235"></a> |
| <span class="sourceLineNo">236</span><a name="line.236"></a> |
| <span class="sourceLineNo">237</span> if (session == null) {<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> if (subject.isAuthenticated()) {<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> session = subject.getSession();<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> session.setAttribute(DefaultSubjectContext.AUTHENTICATED_SESSION_KEY, Boolean.TRUE);<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> }<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> //otherwise no session and not authenticated - nothing to save<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> } else {<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> Boolean existingAuthc = (Boolean) session.getAttribute(DefaultSubjectContext.AUTHENTICATED_SESSION_KEY);<a name="line.244"></a> |
| <span class="sourceLineNo">245</span><a name="line.245"></a> |
| <span class="sourceLineNo">246</span> if (subject.isAuthenticated()) {<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> if (existingAuthc == null || !existingAuthc) {<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> session.setAttribute(DefaultSubjectContext.AUTHENTICATED_SESSION_KEY, Boolean.TRUE);<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> }<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> //otherwise authc state matches - no need to update the session<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> } else {<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> if (existingAuthc != null) {<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> //existing doesn't match the current state - remove it:<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> session.removeAttribute(DefaultSubjectContext.AUTHENTICATED_SESSION_KEY);<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> }<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> //otherwise not in the session and not authenticated - no need to update the session<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> }<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> }<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> }<a name="line.259"></a> |
| <span class="sourceLineNo">260</span><a name="line.260"></a> |
| <span class="sourceLineNo">261</span> /**<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> * Removes any existing subject state from the Subject's session (if the session exists). If the session<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> * does not exist, this method does not do anything.<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> *<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> * @param subject the subject for which any existing subject state will be removed from its session.<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> */<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> protected void removeFromSession(Subject subject) {<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> Session session = subject.getSession(false);<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> if (session != null) {<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> session.removeAttribute(DefaultSubjectContext.AUTHENTICATED_SESSION_KEY);<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> session.removeAttribute(DefaultSubjectContext.PRINCIPALS_SESSION_KEY);<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> }<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> }<a name="line.273"></a> |
| <span class="sourceLineNo">274</span><a name="line.274"></a> |
| <span class="sourceLineNo">275</span> /**<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> * Removes any existing subject state from the subject's session (if the session exists).<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> *<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> * @param subject the Subject instance for which any persistent state should be deleted.<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> */<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> public void delete(Subject subject) {<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> removeFromSession(subject);<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> }<a name="line.282"></a> |
| <span class="sourceLineNo">283</span>}<a name="line.283"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
