| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a> |
| <FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <FONT color="green">009</FONT> *<a name="line.9"></a> |
| <FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <FONT color="green">011</FONT> *<a name="line.11"></a> |
| <FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a> |
| <FONT color="green">017</FONT> * under the License.<a name="line.17"></a> |
| <FONT color="green">018</FONT> */<a name="line.18"></a> |
| <FONT color="green">019</FONT> package org.apache.shiro.mgt;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.shiro.authc.*;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.authz.Authorizer;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.shiro.realm.Realm;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.apache.shiro.session.InvalidSessionException;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.apache.shiro.session.Session;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import org.apache.shiro.session.mgt.DefaultSessionContext;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import org.apache.shiro.session.mgt.DefaultSessionKey;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import org.apache.shiro.session.mgt.SessionContext;<a name="line.28"></a> |
| <FONT color="green">029</FONT> import org.apache.shiro.session.mgt.SessionKey;<a name="line.29"></a> |
| <FONT color="green">030</FONT> import org.apache.shiro.subject.PrincipalCollection;<a name="line.30"></a> |
| <FONT color="green">031</FONT> import org.apache.shiro.subject.Subject;<a name="line.31"></a> |
| <FONT color="green">032</FONT> import org.apache.shiro.subject.SubjectContext;<a name="line.32"></a> |
| <FONT color="green">033</FONT> import org.apache.shiro.subject.support.DefaultSubjectContext;<a name="line.33"></a> |
| <FONT color="green">034</FONT> import org.apache.shiro.util.CollectionUtils;<a name="line.34"></a> |
| <FONT color="green">035</FONT> import org.slf4j.Logger;<a name="line.35"></a> |
| <FONT color="green">036</FONT> import org.slf4j.LoggerFactory;<a name="line.36"></a> |
| <FONT color="green">037</FONT> <a name="line.37"></a> |
| <FONT color="green">038</FONT> import java.io.Serializable;<a name="line.38"></a> |
| <FONT color="green">039</FONT> import java.util.Collection;<a name="line.39"></a> |
| <FONT color="green">040</FONT> <a name="line.40"></a> |
| <FONT color="green">041</FONT> /**<a name="line.41"></a> |
| <FONT color="green">042</FONT> * The Shiro framework's default concrete implementation of the {@link SecurityManager} interface,<a name="line.42"></a> |
| <FONT color="green">043</FONT> * based around a collection of {@link org.apache.shiro.realm.Realm}s. This implementation delegates its<a name="line.43"></a> |
| <FONT color="green">044</FONT> * authentication, authorization, and session operations to wrapped {@link Authenticator}, {@link Authorizer}, and<a name="line.44"></a> |
| <FONT color="green">045</FONT> * {@link org.apache.shiro.session.mgt.SessionManager SessionManager} instances respectively via superclass<a name="line.45"></a> |
| <FONT color="green">046</FONT> * implementation.<a name="line.46"></a> |
| <FONT color="green">047</FONT> * <p/><a name="line.47"></a> |
| <FONT color="green">048</FONT> * To greatly reduce and simplify configuration, this implementation (and its superclasses) will<a name="line.48"></a> |
| <FONT color="green">049</FONT> * create suitable defaults for all of its required dependencies, <em>except</em> the required one or more<a name="line.49"></a> |
| <FONT color="green">050</FONT> * {@link Realm Realm}s. Because {@code Realm} implementations usually interact with an application's data model,<a name="line.50"></a> |
| <FONT color="green">051</FONT> * they are almost always application specific; you will want to specify at least one custom<a name="line.51"></a> |
| <FONT color="green">052</FONT> * {@code Realm} implementation that 'knows' about your application's data/security model<a name="line.52"></a> |
| <FONT color="green">053</FONT> * (via {@link #setRealm} or one of the overloaded constructors). All other attributes in this class hierarchy<a name="line.53"></a> |
| <FONT color="green">054</FONT> * will have suitable defaults for most enterprise applications.<a name="line.54"></a> |
| <FONT color="green">055</FONT> * <p/><a name="line.55"></a> |
| <FONT color="green">056</FONT> * <b>RememberMe notice</b>: This class supports the ability to configure a<a name="line.56"></a> |
| <FONT color="green">057</FONT> * {@link #setRememberMeManager RememberMeManager}<a name="line.57"></a> |
| <FONT color="green">058</FONT> * for {@code RememberMe} identity services for login/logout, BUT, a default instance <em>will not</em> be created<a name="line.58"></a> |
| <FONT color="green">059</FONT> * for this attribute at startup.<a name="line.59"></a> |
| <FONT color="green">060</FONT> * <p/><a name="line.60"></a> |
| <FONT color="green">061</FONT> * Because RememberMe services are inherently client tier-specific and<a name="line.61"></a> |
| <FONT color="green">062</FONT> * therefore aplication-dependent, if you want {@code RememberMe} services enabled, you will have to specify an<a name="line.62"></a> |
| <FONT color="green">063</FONT> * instance yourself via the {@link #setRememberMeManager(RememberMeManager) setRememberMeManager}<a name="line.63"></a> |
| <FONT color="green">064</FONT> * mutator. However if you're reading this JavaDoc with the<a name="line.64"></a> |
| <FONT color="green">065</FONT> * expectation of operating in a Web environment, take a look at the<a name="line.65"></a> |
| <FONT color="green">066</FONT> * {@code org.apache.shiro.web.DefaultWebSecurityManager} implementation, which<a name="line.66"></a> |
| <FONT color="green">067</FONT> * <em>does</em> support {@code RememberMe} services by default at startup.<a name="line.67"></a> |
| <FONT color="green">068</FONT> *<a name="line.68"></a> |
| <FONT color="green">069</FONT> * @since 0.2<a name="line.69"></a> |
| <FONT color="green">070</FONT> */<a name="line.70"></a> |
| <FONT color="green">071</FONT> public class DefaultSecurityManager extends SessionsSecurityManager {<a name="line.71"></a> |
| <FONT color="green">072</FONT> <a name="line.72"></a> |
| <FONT color="green">073</FONT> private static final Logger log = LoggerFactory.getLogger(DefaultSecurityManager.class);<a name="line.73"></a> |
| <FONT color="green">074</FONT> <a name="line.74"></a> |
| <FONT color="green">075</FONT> protected RememberMeManager rememberMeManager;<a name="line.75"></a> |
| <FONT color="green">076</FONT> protected SubjectDAO subjectDAO;<a name="line.76"></a> |
| <FONT color="green">077</FONT> protected SubjectFactory subjectFactory;<a name="line.77"></a> |
| <FONT color="green">078</FONT> <a name="line.78"></a> |
| <FONT color="green">079</FONT> /**<a name="line.79"></a> |
| <FONT color="green">080</FONT> * Default no-arg constructor.<a name="line.80"></a> |
| <FONT color="green">081</FONT> */<a name="line.81"></a> |
| <FONT color="green">082</FONT> public DefaultSecurityManager() {<a name="line.82"></a> |
| <FONT color="green">083</FONT> super();<a name="line.83"></a> |
| <FONT color="green">084</FONT> this.subjectFactory = new DefaultSubjectFactory();<a name="line.84"></a> |
| <FONT color="green">085</FONT> this.subjectDAO = new DefaultSubjectDAO();<a name="line.85"></a> |
| <FONT color="green">086</FONT> }<a name="line.86"></a> |
| <FONT color="green">087</FONT> <a name="line.87"></a> |
| <FONT color="green">088</FONT> /**<a name="line.88"></a> |
| <FONT color="green">089</FONT> * Supporting constructor for a single-realm application.<a name="line.89"></a> |
| <FONT color="green">090</FONT> *<a name="line.90"></a> |
| <FONT color="green">091</FONT> * @param singleRealm the single realm used by this SecurityManager.<a name="line.91"></a> |
| <FONT color="green">092</FONT> */<a name="line.92"></a> |
| <FONT color="green">093</FONT> public DefaultSecurityManager(Realm singleRealm) {<a name="line.93"></a> |
| <FONT color="green">094</FONT> this();<a name="line.94"></a> |
| <FONT color="green">095</FONT> setRealm(singleRealm);<a name="line.95"></a> |
| <FONT color="green">096</FONT> }<a name="line.96"></a> |
| <FONT color="green">097</FONT> <a name="line.97"></a> |
| <FONT color="green">098</FONT> /**<a name="line.98"></a> |
| <FONT color="green">099</FONT> * Supporting constructor for multiple {@link #setRealms realms}.<a name="line.99"></a> |
| <FONT color="green">100</FONT> *<a name="line.100"></a> |
| <FONT color="green">101</FONT> * @param realms the realm instances backing this SecurityManager.<a name="line.101"></a> |
| <FONT color="green">102</FONT> */<a name="line.102"></a> |
| <FONT color="green">103</FONT> public DefaultSecurityManager(Collection<Realm> realms) {<a name="line.103"></a> |
| <FONT color="green">104</FONT> this();<a name="line.104"></a> |
| <FONT color="green">105</FONT> setRealms(realms);<a name="line.105"></a> |
| <FONT color="green">106</FONT> }<a name="line.106"></a> |
| <FONT color="green">107</FONT> <a name="line.107"></a> |
| <FONT color="green">108</FONT> /**<a name="line.108"></a> |
| <FONT color="green">109</FONT> * Returns the {@code SubjectFactory} responsible for creating {@link Subject} instances exposed to the application.<a name="line.109"></a> |
| <FONT color="green">110</FONT> *<a name="line.110"></a> |
| <FONT color="green">111</FONT> * @return the {@code SubjectFactory} responsible for creating {@link Subject} instances exposed to the application.<a name="line.111"></a> |
| <FONT color="green">112</FONT> */<a name="line.112"></a> |
| <FONT color="green">113</FONT> public SubjectFactory getSubjectFactory() {<a name="line.113"></a> |
| <FONT color="green">114</FONT> return subjectFactory;<a name="line.114"></a> |
| <FONT color="green">115</FONT> }<a name="line.115"></a> |
| <FONT color="green">116</FONT> <a name="line.116"></a> |
| <FONT color="green">117</FONT> /**<a name="line.117"></a> |
| <FONT color="green">118</FONT> * Sets the {@code SubjectFactory} responsible for creating {@link Subject} instances exposed to the application.<a name="line.118"></a> |
| <FONT color="green">119</FONT> *<a name="line.119"></a> |
| <FONT color="green">120</FONT> * @param subjectFactory the {@code SubjectFactory} responsible for creating {@link Subject} instances exposed to the application.<a name="line.120"></a> |
| <FONT color="green">121</FONT> */<a name="line.121"></a> |
| <FONT color="green">122</FONT> public void setSubjectFactory(SubjectFactory subjectFactory) {<a name="line.122"></a> |
| <FONT color="green">123</FONT> this.subjectFactory = subjectFactory;<a name="line.123"></a> |
| <FONT color="green">124</FONT> }<a name="line.124"></a> |
| <FONT color="green">125</FONT> <a name="line.125"></a> |
| <FONT color="green">126</FONT> /**<a name="line.126"></a> |
| <FONT color="green">127</FONT> * Returns the {@code SubjectDAO} responsible for persisting Subject state, typically used after login or when an<a name="line.127"></a> |
| <FONT color="green">128</FONT> * Subject identity is discovered (eg after RememberMe services). Unless configured otherwise, the default<a name="line.128"></a> |
| <FONT color="green">129</FONT> * implementation is a {@link DefaultSubjectDAO}.<a name="line.129"></a> |
| <FONT color="green">130</FONT> *<a name="line.130"></a> |
| <FONT color="green">131</FONT> * @return the {@code SubjectDAO} responsible for persisting Subject state, typically used after login or when an<a name="line.131"></a> |
| <FONT color="green">132</FONT> * Subject identity is discovered (eg after RememberMe services).<a name="line.132"></a> |
| <FONT color="green">133</FONT> * @see DefaultSubjectDAO<a name="line.133"></a> |
| <FONT color="green">134</FONT> * @since 1.2<a name="line.134"></a> |
| <FONT color="green">135</FONT> */<a name="line.135"></a> |
| <FONT color="green">136</FONT> public SubjectDAO getSubjectDAO() {<a name="line.136"></a> |
| <FONT color="green">137</FONT> return subjectDAO;<a name="line.137"></a> |
| <FONT color="green">138</FONT> }<a name="line.138"></a> |
| <FONT color="green">139</FONT> <a name="line.139"></a> |
| <FONT color="green">140</FONT> /**<a name="line.140"></a> |
| <FONT color="green">141</FONT> * Sets the {@code SubjectDAO} responsible for persisting Subject state, typically used after login or when an<a name="line.141"></a> |
| <FONT color="green">142</FONT> * Subject identity is discovered (eg after RememberMe services). Unless configured otherwise, the default<a name="line.142"></a> |
| <FONT color="green">143</FONT> * implementation is a {@link DefaultSubjectDAO}.<a name="line.143"></a> |
| <FONT color="green">144</FONT> *<a name="line.144"></a> |
| <FONT color="green">145</FONT> * @param subjectDAO the {@code SubjectDAO} responsible for persisting Subject state, typically used after login or when an<a name="line.145"></a> |
| <FONT color="green">146</FONT> * Subject identity is discovered (eg after RememberMe services).<a name="line.146"></a> |
| <FONT color="green">147</FONT> * @see DefaultSubjectDAO<a name="line.147"></a> |
| <FONT color="green">148</FONT> * @since 1.2<a name="line.148"></a> |
| <FONT color="green">149</FONT> */<a name="line.149"></a> |
| <FONT color="green">150</FONT> public void setSubjectDAO(SubjectDAO subjectDAO) {<a name="line.150"></a> |
| <FONT color="green">151</FONT> this.subjectDAO = subjectDAO;<a name="line.151"></a> |
| <FONT color="green">152</FONT> }<a name="line.152"></a> |
| <FONT color="green">153</FONT> <a name="line.153"></a> |
| <FONT color="green">154</FONT> public RememberMeManager getRememberMeManager() {<a name="line.154"></a> |
| <FONT color="green">155</FONT> return rememberMeManager;<a name="line.155"></a> |
| <FONT color="green">156</FONT> }<a name="line.156"></a> |
| <FONT color="green">157</FONT> <a name="line.157"></a> |
| <FONT color="green">158</FONT> public void setRememberMeManager(RememberMeManager rememberMeManager) {<a name="line.158"></a> |
| <FONT color="green">159</FONT> this.rememberMeManager = rememberMeManager;<a name="line.159"></a> |
| <FONT color="green">160</FONT> }<a name="line.160"></a> |
| <FONT color="green">161</FONT> <a name="line.161"></a> |
| <FONT color="green">162</FONT> protected SubjectContext createSubjectContext() {<a name="line.162"></a> |
| <FONT color="green">163</FONT> return new DefaultSubjectContext();<a name="line.163"></a> |
| <FONT color="green">164</FONT> }<a name="line.164"></a> |
| <FONT color="green">165</FONT> <a name="line.165"></a> |
| <FONT color="green">166</FONT> /**<a name="line.166"></a> |
| <FONT color="green">167</FONT> * Creates a {@code Subject} instance for the user represented by the given method arguments.<a name="line.167"></a> |
| <FONT color="green">168</FONT> *<a name="line.168"></a> |
| <FONT color="green">169</FONT> * @param token the {@code AuthenticationToken} submitted for the successful authentication.<a name="line.169"></a> |
| <FONT color="green">170</FONT> * @param info the {@code AuthenticationInfo} of a newly authenticated user.<a name="line.170"></a> |
| <FONT color="green">171</FONT> * @param existing the existing {@code Subject} instance that initiated the authentication attempt<a name="line.171"></a> |
| <FONT color="green">172</FONT> * @return the {@code Subject} instance that represents the context and session data for the newly<a name="line.172"></a> |
| <FONT color="green">173</FONT> * authenticated subject.<a name="line.173"></a> |
| <FONT color="green">174</FONT> */<a name="line.174"></a> |
| <FONT color="green">175</FONT> protected Subject createSubject(AuthenticationToken token, AuthenticationInfo info, Subject existing) {<a name="line.175"></a> |
| <FONT color="green">176</FONT> SubjectContext context = createSubjectContext();<a name="line.176"></a> |
| <FONT color="green">177</FONT> context.setAuthenticated(true);<a name="line.177"></a> |
| <FONT color="green">178</FONT> context.setAuthenticationToken(token);<a name="line.178"></a> |
| <FONT color="green">179</FONT> context.setAuthenticationInfo(info);<a name="line.179"></a> |
| <FONT color="green">180</FONT> if (existing != null) {<a name="line.180"></a> |
| <FONT color="green">181</FONT> context.setSubject(existing);<a name="line.181"></a> |
| <FONT color="green">182</FONT> }<a name="line.182"></a> |
| <FONT color="green">183</FONT> return createSubject(context);<a name="line.183"></a> |
| <FONT color="green">184</FONT> }<a name="line.184"></a> |
| <FONT color="green">185</FONT> <a name="line.185"></a> |
| <FONT color="green">186</FONT> /**<a name="line.186"></a> |
| <FONT color="green">187</FONT> * Binds a {@code Subject} instance created after authentication to the application for later use.<a name="line.187"></a> |
| <FONT color="green">188</FONT> * <p/><a name="line.188"></a> |
| <FONT color="green">189</FONT> * As of Shiro 1.2, this method has been deprecated in favor of {@link #save(org.apache.shiro.subject.Subject)},<a name="line.189"></a> |
| <FONT color="green">190</FONT> * which this implementation now calls.<a name="line.190"></a> |
| <FONT color="green">191</FONT> *<a name="line.191"></a> |
| <FONT color="green">192</FONT> * @param subject the {@code Subject} instance created after authentication to be bound to the application<a name="line.192"></a> |
| <FONT color="green">193</FONT> * for later use.<a name="line.193"></a> |
| <FONT color="green">194</FONT> * @see #save(org.apache.shiro.subject.Subject)<a name="line.194"></a> |
| <FONT color="green">195</FONT> * @deprecated in favor of {@link #save(org.apache.shiro.subject.Subject) save(subject)}.<a name="line.195"></a> |
| <FONT color="green">196</FONT> */<a name="line.196"></a> |
| <FONT color="green">197</FONT> @Deprecated<a name="line.197"></a> |
| <FONT color="green">198</FONT> protected void bind(Subject subject) {<a name="line.198"></a> |
| <FONT color="green">199</FONT> save(subject);<a name="line.199"></a> |
| <FONT color="green">200</FONT> }<a name="line.200"></a> |
| <FONT color="green">201</FONT> <a name="line.201"></a> |
| <FONT color="green">202</FONT> protected void rememberMeSuccessfulLogin(AuthenticationToken token, AuthenticationInfo info, Subject subject) {<a name="line.202"></a> |
| <FONT color="green">203</FONT> RememberMeManager rmm = getRememberMeManager();<a name="line.203"></a> |
| <FONT color="green">204</FONT> if (rmm != null) {<a name="line.204"></a> |
| <FONT color="green">205</FONT> try {<a name="line.205"></a> |
| <FONT color="green">206</FONT> rmm.onSuccessfulLogin(subject, token, info);<a name="line.206"></a> |
| <FONT color="green">207</FONT> } catch (Exception e) {<a name="line.207"></a> |
| <FONT color="green">208</FONT> if (log.isWarnEnabled()) {<a name="line.208"></a> |
| <FONT color="green">209</FONT> String msg = "Delegate RememberMeManager instance of type [" + rmm.getClass().getName() +<a name="line.209"></a> |
| <FONT color="green">210</FONT> "] threw an exception during onSuccessfulLogin. RememberMe services will not be " +<a name="line.210"></a> |
| <FONT color="green">211</FONT> "performed for account [" + info + "].";<a name="line.211"></a> |
| <FONT color="green">212</FONT> log.warn(msg, e);<a name="line.212"></a> |
| <FONT color="green">213</FONT> }<a name="line.213"></a> |
| <FONT color="green">214</FONT> }<a name="line.214"></a> |
| <FONT color="green">215</FONT> } else {<a name="line.215"></a> |
| <FONT color="green">216</FONT> if (log.isTraceEnabled()) {<a name="line.216"></a> |
| <FONT color="green">217</FONT> log.trace("This " + getClass().getName() + " instance does not have a " +<a name="line.217"></a> |
| <FONT color="green">218</FONT> "[" + RememberMeManager.class.getName() + "] instance configured. RememberMe services " +<a name="line.218"></a> |
| <FONT color="green">219</FONT> "will not be performed for account [" + info + "].");<a name="line.219"></a> |
| <FONT color="green">220</FONT> }<a name="line.220"></a> |
| <FONT color="green">221</FONT> }<a name="line.221"></a> |
| <FONT color="green">222</FONT> }<a name="line.222"></a> |
| <FONT color="green">223</FONT> <a name="line.223"></a> |
| <FONT color="green">224</FONT> protected void rememberMeFailedLogin(AuthenticationToken token, AuthenticationException ex, Subject subject) {<a name="line.224"></a> |
| <FONT color="green">225</FONT> RememberMeManager rmm = getRememberMeManager();<a name="line.225"></a> |
| <FONT color="green">226</FONT> if (rmm != null) {<a name="line.226"></a> |
| <FONT color="green">227</FONT> try {<a name="line.227"></a> |
| <FONT color="green">228</FONT> rmm.onFailedLogin(subject, token, ex);<a name="line.228"></a> |
| <FONT color="green">229</FONT> } catch (Exception e) {<a name="line.229"></a> |
| <FONT color="green">230</FONT> if (log.isWarnEnabled()) {<a name="line.230"></a> |
| <FONT color="green">231</FONT> String msg = "Delegate RememberMeManager instance of type [" + rmm.getClass().getName() +<a name="line.231"></a> |
| <FONT color="green">232</FONT> "] threw an exception during onFailedLogin for AuthenticationToken [" +<a name="line.232"></a> |
| <FONT color="green">233</FONT> token + "].";<a name="line.233"></a> |
| <FONT color="green">234</FONT> log.warn(msg, e);<a name="line.234"></a> |
| <FONT color="green">235</FONT> }<a name="line.235"></a> |
| <FONT color="green">236</FONT> }<a name="line.236"></a> |
| <FONT color="green">237</FONT> }<a name="line.237"></a> |
| <FONT color="green">238</FONT> }<a name="line.238"></a> |
| <FONT color="green">239</FONT> <a name="line.239"></a> |
| <FONT color="green">240</FONT> protected void rememberMeLogout(Subject subject) {<a name="line.240"></a> |
| <FONT color="green">241</FONT> RememberMeManager rmm = getRememberMeManager();<a name="line.241"></a> |
| <FONT color="green">242</FONT> if (rmm != null) {<a name="line.242"></a> |
| <FONT color="green">243</FONT> try {<a name="line.243"></a> |
| <FONT color="green">244</FONT> rmm.onLogout(subject);<a name="line.244"></a> |
| <FONT color="green">245</FONT> } catch (Exception e) {<a name="line.245"></a> |
| <FONT color="green">246</FONT> if (log.isWarnEnabled()) {<a name="line.246"></a> |
| <FONT color="green">247</FONT> String msg = "Delegate RememberMeManager instance of type [" + rmm.getClass().getName() +<a name="line.247"></a> |
| <FONT color="green">248</FONT> "] threw an exception during onLogout for subject with principals [" +<a name="line.248"></a> |
| <FONT color="green">249</FONT> (subject != null ? subject.getPrincipals() : null) + "]";<a name="line.249"></a> |
| <FONT color="green">250</FONT> log.warn(msg, e);<a name="line.250"></a> |
| <FONT color="green">251</FONT> }<a name="line.251"></a> |
| <FONT color="green">252</FONT> }<a name="line.252"></a> |
| <FONT color="green">253</FONT> }<a name="line.253"></a> |
| <FONT color="green">254</FONT> }<a name="line.254"></a> |
| <FONT color="green">255</FONT> <a name="line.255"></a> |
| <FONT color="green">256</FONT> /**<a name="line.256"></a> |
| <FONT color="green">257</FONT> * First authenticates the {@code AuthenticationToken} argument, and if successful, constructs a<a name="line.257"></a> |
| <FONT color="green">258</FONT> * {@code Subject} instance representing the authenticated account's identity.<a name="line.258"></a> |
| <FONT color="green">259</FONT> * <p/><a name="line.259"></a> |
| <FONT color="green">260</FONT> * Once constructed, the {@code Subject} instance is then {@link #bind bound} to the application for<a name="line.260"></a> |
| <FONT color="green">261</FONT> * subsequent access before being returned to the caller.<a name="line.261"></a> |
| <FONT color="green">262</FONT> *<a name="line.262"></a> |
| <FONT color="green">263</FONT> * @param token the authenticationToken to process for the login attempt.<a name="line.263"></a> |
| <FONT color="green">264</FONT> * @return a Subject representing the authenticated user.<a name="line.264"></a> |
| <FONT color="green">265</FONT> * @throws AuthenticationException if there is a problem authenticating the specified {@code token}.<a name="line.265"></a> |
| <FONT color="green">266</FONT> */<a name="line.266"></a> |
| <FONT color="green">267</FONT> public Subject login(Subject subject, AuthenticationToken token) throws AuthenticationException {<a name="line.267"></a> |
| <FONT color="green">268</FONT> AuthenticationInfo info;<a name="line.268"></a> |
| <FONT color="green">269</FONT> try {<a name="line.269"></a> |
| <FONT color="green">270</FONT> info = authenticate(token);<a name="line.270"></a> |
| <FONT color="green">271</FONT> } catch (AuthenticationException ae) {<a name="line.271"></a> |
| <FONT color="green">272</FONT> try {<a name="line.272"></a> |
| <FONT color="green">273</FONT> onFailedLogin(token, ae, subject);<a name="line.273"></a> |
| <FONT color="green">274</FONT> } catch (Exception e) {<a name="line.274"></a> |
| <FONT color="green">275</FONT> if (log.isInfoEnabled()) {<a name="line.275"></a> |
| <FONT color="green">276</FONT> log.info("onFailedLogin method threw an " +<a name="line.276"></a> |
| <FONT color="green">277</FONT> "exception. Logging and propagating original AuthenticationException.", e);<a name="line.277"></a> |
| <FONT color="green">278</FONT> }<a name="line.278"></a> |
| <FONT color="green">279</FONT> }<a name="line.279"></a> |
| <FONT color="green">280</FONT> throw ae; //propagate<a name="line.280"></a> |
| <FONT color="green">281</FONT> }<a name="line.281"></a> |
| <FONT color="green">282</FONT> <a name="line.282"></a> |
| <FONT color="green">283</FONT> Subject loggedIn = createSubject(token, info, subject);<a name="line.283"></a> |
| <FONT color="green">284</FONT> <a name="line.284"></a> |
| <FONT color="green">285</FONT> onSuccessfulLogin(token, info, loggedIn);<a name="line.285"></a> |
| <FONT color="green">286</FONT> <a name="line.286"></a> |
| <FONT color="green">287</FONT> return loggedIn;<a name="line.287"></a> |
| <FONT color="green">288</FONT> }<a name="line.288"></a> |
| <FONT color="green">289</FONT> <a name="line.289"></a> |
| <FONT color="green">290</FONT> protected void onSuccessfulLogin(AuthenticationToken token, AuthenticationInfo info, Subject subject) {<a name="line.290"></a> |
| <FONT color="green">291</FONT> rememberMeSuccessfulLogin(token, info, subject);<a name="line.291"></a> |
| <FONT color="green">292</FONT> }<a name="line.292"></a> |
| <FONT color="green">293</FONT> <a name="line.293"></a> |
| <FONT color="green">294</FONT> protected void onFailedLogin(AuthenticationToken token, AuthenticationException ae, Subject subject) {<a name="line.294"></a> |
| <FONT color="green">295</FONT> rememberMeFailedLogin(token, ae, subject);<a name="line.295"></a> |
| <FONT color="green">296</FONT> }<a name="line.296"></a> |
| <FONT color="green">297</FONT> <a name="line.297"></a> |
| <FONT color="green">298</FONT> protected void beforeLogout(Subject subject) {<a name="line.298"></a> |
| <FONT color="green">299</FONT> rememberMeLogout(subject);<a name="line.299"></a> |
| <FONT color="green">300</FONT> }<a name="line.300"></a> |
| <FONT color="green">301</FONT> <a name="line.301"></a> |
| <FONT color="green">302</FONT> protected SubjectContext copy(SubjectContext subjectContext) {<a name="line.302"></a> |
| <FONT color="green">303</FONT> return new DefaultSubjectContext(subjectContext);<a name="line.303"></a> |
| <FONT color="green">304</FONT> }<a name="line.304"></a> |
| <FONT color="green">305</FONT> <a name="line.305"></a> |
| <FONT color="green">306</FONT> /**<a name="line.306"></a> |
| <FONT color="green">307</FONT> * This implementation functions as follows:<a name="line.307"></a> |
| <FONT color="green">308</FONT> * <p/><a name="line.308"></a> |
| <FONT color="green">309</FONT> * <ol><a name="line.309"></a> |
| <FONT color="green">310</FONT> * <li>Ensures the {@code SubjectContext} is as populated as it can be, using heuristics to acquire<a name="line.310"></a> |
| <FONT color="green">311</FONT> * data that may not have already been available to it (such as a referenced session or remembered principals).</li><a name="line.311"></a> |
| <FONT color="green">312</FONT> * <li>Calls {@link #doCreateSubject(org.apache.shiro.subject.SubjectContext)} to actually perform the<a name="line.312"></a> |
| <FONT color="green">313</FONT> * {@code Subject} instance creation.</li><a name="line.313"></a> |
| <FONT color="green">314</FONT> * <li>calls {@link #save(org.apache.shiro.subject.Subject) save(subject)} to ensure the constructed<a name="line.314"></a> |
| <FONT color="green">315</FONT> * {@code Subject}'s state is accessible for future requests/invocations if necessary.</li><a name="line.315"></a> |
| <FONT color="green">316</FONT> * <li>returns the constructed {@code Subject} instance.</li><a name="line.316"></a> |
| <FONT color="green">317</FONT> * </ol><a name="line.317"></a> |
| <FONT color="green">318</FONT> *<a name="line.318"></a> |
| <FONT color="green">319</FONT> * @param subjectContext any data needed to direct how the Subject should be constructed.<a name="line.319"></a> |
| <FONT color="green">320</FONT> * @return the {@code Subject} instance reflecting the specified contextual data.<a name="line.320"></a> |
| <FONT color="green">321</FONT> * @see #ensureSecurityManager(org.apache.shiro.subject.SubjectContext)<a name="line.321"></a> |
| <FONT color="green">322</FONT> * @see #resolveSession(org.apache.shiro.subject.SubjectContext)<a name="line.322"></a> |
| <FONT color="green">323</FONT> * @see #resolvePrincipals(org.apache.shiro.subject.SubjectContext)<a name="line.323"></a> |
| <FONT color="green">324</FONT> * @see #doCreateSubject(org.apache.shiro.subject.SubjectContext)<a name="line.324"></a> |
| <FONT color="green">325</FONT> * @see #save(org.apache.shiro.subject.Subject)<a name="line.325"></a> |
| <FONT color="green">326</FONT> * @since 1.0<a name="line.326"></a> |
| <FONT color="green">327</FONT> */<a name="line.327"></a> |
| <FONT color="green">328</FONT> public Subject createSubject(SubjectContext subjectContext) {<a name="line.328"></a> |
| <FONT color="green">329</FONT> //create a copy so we don't modify the argument's backing map:<a name="line.329"></a> |
| <FONT color="green">330</FONT> SubjectContext context = copy(subjectContext);<a name="line.330"></a> |
| <FONT color="green">331</FONT> <a name="line.331"></a> |
| <FONT color="green">332</FONT> //ensure that the context has a SecurityManager instance, and if not, add one:<a name="line.332"></a> |
| <FONT color="green">333</FONT> context = ensureSecurityManager(context);<a name="line.333"></a> |
| <FONT color="green">334</FONT> <a name="line.334"></a> |
| <FONT color="green">335</FONT> //Resolve an associated Session (usually based on a referenced session ID), and place it in the context before<a name="line.335"></a> |
| <FONT color="green">336</FONT> //sending to the SubjectFactory. The SubjectFactory should not need to know how to acquire sessions as the<a name="line.336"></a> |
| <FONT color="green">337</FONT> //process is often environment specific - better to shield the SF from these details:<a name="line.337"></a> |
| <FONT color="green">338</FONT> context = resolveSession(context);<a name="line.338"></a> |
| <FONT color="green">339</FONT> <a name="line.339"></a> |
| <FONT color="green">340</FONT> //Similarly, the SubjectFactory should not require any concept of RememberMe - translate that here first<a name="line.340"></a> |
| <FONT color="green">341</FONT> //if possible before handing off to the SubjectFactory:<a name="line.341"></a> |
| <FONT color="green">342</FONT> context = resolvePrincipals(context);<a name="line.342"></a> |
| <FONT color="green">343</FONT> <a name="line.343"></a> |
| <FONT color="green">344</FONT> Subject subject = doCreateSubject(context);<a name="line.344"></a> |
| <FONT color="green">345</FONT> <a name="line.345"></a> |
| <FONT color="green">346</FONT> //save this subject for future reference if necessary:<a name="line.346"></a> |
| <FONT color="green">347</FONT> //(this is needed here in case rememberMe principals were resolved and they need to be stored in the<a name="line.347"></a> |
| <FONT color="green">348</FONT> //session, so we don't constantly rehydrate the rememberMe PrincipalCollection on every operation).<a name="line.348"></a> |
| <FONT color="green">349</FONT> //Added in 1.2:<a name="line.349"></a> |
| <FONT color="green">350</FONT> save(subject);<a name="line.350"></a> |
| <FONT color="green">351</FONT> <a name="line.351"></a> |
| <FONT color="green">352</FONT> return subject;<a name="line.352"></a> |
| <FONT color="green">353</FONT> }<a name="line.353"></a> |
| <FONT color="green">354</FONT> <a name="line.354"></a> |
| <FONT color="green">355</FONT> /**<a name="line.355"></a> |
| <FONT color="green">356</FONT> * Actually creates a {@code Subject} instance by delegating to the internal<a name="line.356"></a> |
| <FONT color="green">357</FONT> * {@link #getSubjectFactory() subjectFactory}. By the time this method is invoked, all possible<a name="line.357"></a> |
| <FONT color="green">358</FONT> * {@code SubjectContext} data (session, principals, et. al.) has been made accessible using all known heuristics<a name="line.358"></a> |
| <FONT color="green">359</FONT> * and will be accessible to the {@code subjectFactory} via the {@code subjectContext.resolve*} methods.<a name="line.359"></a> |
| <FONT color="green">360</FONT> *<a name="line.360"></a> |
| <FONT color="green">361</FONT> * @param context the populated context (data map) to be used by the {@code SubjectFactory} when creating a<a name="line.361"></a> |
| <FONT color="green">362</FONT> * {@code Subject} instance.<a name="line.362"></a> |
| <FONT color="green">363</FONT> * @return a {@code Subject} instance reflecting the data in the specified {@code SubjectContext} data map.<a name="line.363"></a> |
| <FONT color="green">364</FONT> * @see #getSubjectFactory()<a name="line.364"></a> |
| <FONT color="green">365</FONT> * @see SubjectFactory#createSubject(org.apache.shiro.subject.SubjectContext)<a name="line.365"></a> |
| <FONT color="green">366</FONT> * @since 1.2<a name="line.366"></a> |
| <FONT color="green">367</FONT> */<a name="line.367"></a> |
| <FONT color="green">368</FONT> protected Subject doCreateSubject(SubjectContext context) {<a name="line.368"></a> |
| <FONT color="green">369</FONT> return getSubjectFactory().createSubject(context);<a name="line.369"></a> |
| <FONT color="green">370</FONT> }<a name="line.370"></a> |
| <FONT color="green">371</FONT> <a name="line.371"></a> |
| <FONT color="green">372</FONT> /**<a name="line.372"></a> |
| <FONT color="green">373</FONT> * Saves the subject's state to a persistent location for future reference if necessary.<a name="line.373"></a> |
| <FONT color="green">374</FONT> * <p/><a name="line.374"></a> |
| <FONT color="green">375</FONT> * This implementation merely delegates to the internal {@link #setSubjectDAO(SubjectDAO) subjectDAO} and calls<a name="line.375"></a> |
| <FONT color="green">376</FONT> * {@link SubjectDAO#save(org.apache.shiro.subject.Subject) subjectDAO.save(subject)}.<a name="line.376"></a> |
| <FONT color="green">377</FONT> *<a name="line.377"></a> |
| <FONT color="green">378</FONT> * @param subject the subject for which state will potentially be persisted<a name="line.378"></a> |
| <FONT color="green">379</FONT> * @see SubjectDAO#save(org.apache.shiro.subject.Subject)<a name="line.379"></a> |
| <FONT color="green">380</FONT> * @since 1.2<a name="line.380"></a> |
| <FONT color="green">381</FONT> */<a name="line.381"></a> |
| <FONT color="green">382</FONT> protected void save(Subject subject) {<a name="line.382"></a> |
| <FONT color="green">383</FONT> this.subjectDAO.save(subject);<a name="line.383"></a> |
| <FONT color="green">384</FONT> }<a name="line.384"></a> |
| <FONT color="green">385</FONT> <a name="line.385"></a> |
| <FONT color="green">386</FONT> /**<a name="line.386"></a> |
| <FONT color="green">387</FONT> * Removes (or 'unbinds') the Subject's state from the application, typically called during {@link #logout}..<a name="line.387"></a> |
| <FONT color="green">388</FONT> * <p/><a name="line.388"></a> |
| <FONT color="green">389</FONT> * This implementation merely delegates to the internal {@link #setSubjectDAO(SubjectDAO) subjectDAO} and calls<a name="line.389"></a> |
| <FONT color="green">390</FONT> * {@link SubjectDAO#delete(org.apache.shiro.subject.Subject) delete(subject)}.<a name="line.390"></a> |
| <FONT color="green">391</FONT> *<a name="line.391"></a> |
| <FONT color="green">392</FONT> * @param subject the subject for which state will be removed<a name="line.392"></a> |
| <FONT color="green">393</FONT> * @see SubjectDAO#delete(org.apache.shiro.subject.Subject)<a name="line.393"></a> |
| <FONT color="green">394</FONT> * @since 1.2<a name="line.394"></a> |
| <FONT color="green">395</FONT> */<a name="line.395"></a> |
| <FONT color="green">396</FONT> protected void delete(Subject subject) {<a name="line.396"></a> |
| <FONT color="green">397</FONT> this.subjectDAO.delete(subject);<a name="line.397"></a> |
| <FONT color="green">398</FONT> }<a name="line.398"></a> |
| <FONT color="green">399</FONT> <a name="line.399"></a> |
| <FONT color="green">400</FONT> /**<a name="line.400"></a> |
| <FONT color="green">401</FONT> * Determines if there is a {@code SecurityManager} instance in the context, and if not, adds 'this' to the<a name="line.401"></a> |
| <FONT color="green">402</FONT> * context. This ensures the SubjectFactory instance will have access to a SecurityManager during Subject<a name="line.402"></a> |
| <FONT color="green">403</FONT> * construction if necessary.<a name="line.403"></a> |
| <FONT color="green">404</FONT> *<a name="line.404"></a> |
| <FONT color="green">405</FONT> * @param context the subject context data that may contain a SecurityManager instance.<a name="line.405"></a> |
| <FONT color="green">406</FONT> * @return The SubjectContext to use to pass to a {@link SubjectFactory} for subject creation.<a name="line.406"></a> |
| <FONT color="green">407</FONT> * @since 1.0<a name="line.407"></a> |
| <FONT color="green">408</FONT> */<a name="line.408"></a> |
| <FONT color="green">409</FONT> @SuppressWarnings({"unchecked"})<a name="line.409"></a> |
| <FONT color="green">410</FONT> protected SubjectContext ensureSecurityManager(SubjectContext context) {<a name="line.410"></a> |
| <FONT color="green">411</FONT> if (context.resolveSecurityManager() != null) {<a name="line.411"></a> |
| <FONT color="green">412</FONT> log.trace("Context already contains a SecurityManager instance. Returning.");<a name="line.412"></a> |
| <FONT color="green">413</FONT> return context;<a name="line.413"></a> |
| <FONT color="green">414</FONT> }<a name="line.414"></a> |
| <FONT color="green">415</FONT> log.trace("No SecurityManager found in context. Adding self reference.");<a name="line.415"></a> |
| <FONT color="green">416</FONT> context.setSecurityManager(this);<a name="line.416"></a> |
| <FONT color="green">417</FONT> return context;<a name="line.417"></a> |
| <FONT color="green">418</FONT> }<a name="line.418"></a> |
| <FONT color="green">419</FONT> <a name="line.419"></a> |
| <FONT color="green">420</FONT> /**<a name="line.420"></a> |
| <FONT color="green">421</FONT> * Attempts to resolve any associated session based on the context and returns a<a name="line.421"></a> |
| <FONT color="green">422</FONT> * context that represents this resolved {@code Session} to ensure it may be referenced if necessary by the<a name="line.422"></a> |
| <FONT color="green">423</FONT> * invoked {@link SubjectFactory} that performs actual {@link Subject} construction.<a name="line.423"></a> |
| <FONT color="green">424</FONT> * <p/><a name="line.424"></a> |
| <FONT color="green">425</FONT> * If there is a {@code Session} already in the context because that is what the caller wants to be used for<a name="line.425"></a> |
| <FONT color="green">426</FONT> * {@code Subject} construction, or if no session is resolved, this method effectively does nothing<a name="line.426"></a> |
| <FONT color="green">427</FONT> * returns the context method argument unaltered.<a name="line.427"></a> |
| <FONT color="green">428</FONT> *<a name="line.428"></a> |
| <FONT color="green">429</FONT> * @param context the subject context data that may resolve a Session instance.<a name="line.429"></a> |
| <FONT color="green">430</FONT> * @return The context to use to pass to a {@link SubjectFactory} for subject creation.<a name="line.430"></a> |
| <FONT color="green">431</FONT> * @since 1.0<a name="line.431"></a> |
| <FONT color="green">432</FONT> */<a name="line.432"></a> |
| <FONT color="green">433</FONT> @SuppressWarnings({"unchecked"})<a name="line.433"></a> |
| <FONT color="green">434</FONT> protected SubjectContext resolveSession(SubjectContext context) {<a name="line.434"></a> |
| <FONT color="green">435</FONT> if (context.resolveSession() != null) {<a name="line.435"></a> |
| <FONT color="green">436</FONT> log.debug("Context already contains a session. Returning.");<a name="line.436"></a> |
| <FONT color="green">437</FONT> return context;<a name="line.437"></a> |
| <FONT color="green">438</FONT> }<a name="line.438"></a> |
| <FONT color="green">439</FONT> try {<a name="line.439"></a> |
| <FONT color="green">440</FONT> //Context couldn't resolve it directly, let's see if we can since we have direct access to <a name="line.440"></a> |
| <FONT color="green">441</FONT> //the session manager:<a name="line.441"></a> |
| <FONT color="green">442</FONT> Session session = resolveContextSession(context);<a name="line.442"></a> |
| <FONT color="green">443</FONT> if (session != null) {<a name="line.443"></a> |
| <FONT color="green">444</FONT> context.setSession(session);<a name="line.444"></a> |
| <FONT color="green">445</FONT> }<a name="line.445"></a> |
| <FONT color="green">446</FONT> } catch (InvalidSessionException e) {<a name="line.446"></a> |
| <FONT color="green">447</FONT> log.debug("Resolved SubjectContext context session is invalid. Ignoring and creating an anonymous " +<a name="line.447"></a> |
| <FONT color="green">448</FONT> "(session-less) Subject instance.", e);<a name="line.448"></a> |
| <FONT color="green">449</FONT> }<a name="line.449"></a> |
| <FONT color="green">450</FONT> return context;<a name="line.450"></a> |
| <FONT color="green">451</FONT> }<a name="line.451"></a> |
| <FONT color="green">452</FONT> <a name="line.452"></a> |
| <FONT color="green">453</FONT> protected Session resolveContextSession(SubjectContext context) throws InvalidSessionException {<a name="line.453"></a> |
| <FONT color="green">454</FONT> SessionKey key = getSessionKey(context);<a name="line.454"></a> |
| <FONT color="green">455</FONT> if (key != null) {<a name="line.455"></a> |
| <FONT color="green">456</FONT> return getSession(key);<a name="line.456"></a> |
| <FONT color="green">457</FONT> }<a name="line.457"></a> |
| <FONT color="green">458</FONT> return null;<a name="line.458"></a> |
| <FONT color="green">459</FONT> }<a name="line.459"></a> |
| <FONT color="green">460</FONT> <a name="line.460"></a> |
| <FONT color="green">461</FONT> protected SessionKey getSessionKey(SubjectContext context) {<a name="line.461"></a> |
| <FONT color="green">462</FONT> Serializable sessionId = context.getSessionId();<a name="line.462"></a> |
| <FONT color="green">463</FONT> if (sessionId != null) {<a name="line.463"></a> |
| <FONT color="green">464</FONT> return new DefaultSessionKey(sessionId);<a name="line.464"></a> |
| <FONT color="green">465</FONT> }<a name="line.465"></a> |
| <FONT color="green">466</FONT> return null;<a name="line.466"></a> |
| <FONT color="green">467</FONT> }<a name="line.467"></a> |
| <FONT color="green">468</FONT> <a name="line.468"></a> |
| <FONT color="green">469</FONT> /**<a name="line.469"></a> |
| <FONT color="green">470</FONT> * Attempts to resolve an identity (a {@link PrincipalCollection}) for the context using heuristics. This<a name="line.470"></a> |
| <FONT color="green">471</FONT> * implementation functions as follows:<a name="line.471"></a> |
| <FONT color="green">472</FONT> * <ol><a name="line.472"></a> |
| <FONT color="green">473</FONT> * <li>Check the context to see if it can already {@link SubjectContext#resolvePrincipals resolve an identity}. If<a name="line.473"></a> |
| <FONT color="green">474</FONT> * so, this method does nothing and returns the method argument unaltered.</li><a name="line.474"></a> |
| <FONT color="green">475</FONT> * <li>Check for a RememberMe identity by calling {@link #getRememberedIdentity}. If that method returns a<a name="line.475"></a> |
| <FONT color="green">476</FONT> * non-null value, place the remembered {@link PrincipalCollection} in the context.</li><a name="line.476"></a> |
| <FONT color="green">477</FONT> * </ol><a name="line.477"></a> |
| <FONT color="green">478</FONT> *<a name="line.478"></a> |
| <FONT color="green">479</FONT> * @param context the subject context data that may provide (directly or indirectly through one of its values) a<a name="line.479"></a> |
| <FONT color="green">480</FONT> * {@link PrincipalCollection} identity.<a name="line.480"></a> |
| <FONT color="green">481</FONT> * @return The Subject context to use to pass to a {@link SubjectFactory} for subject creation.<a name="line.481"></a> |
| <FONT color="green">482</FONT> * @since 1.0<a name="line.482"></a> |
| <FONT color="green">483</FONT> */<a name="line.483"></a> |
| <FONT color="green">484</FONT> @SuppressWarnings({"unchecked"})<a name="line.484"></a> |
| <FONT color="green">485</FONT> protected SubjectContext resolvePrincipals(SubjectContext context) {<a name="line.485"></a> |
| <FONT color="green">486</FONT> <a name="line.486"></a> |
| <FONT color="green">487</FONT> PrincipalCollection principals = context.resolvePrincipals();<a name="line.487"></a> |
| <FONT color="green">488</FONT> <a name="line.488"></a> |
| <FONT color="green">489</FONT> if (CollectionUtils.isEmpty(principals)) {<a name="line.489"></a> |
| <FONT color="green">490</FONT> log.trace("No identity (PrincipalCollection) found in the context. Looking for a remembered identity.");<a name="line.490"></a> |
| <FONT color="green">491</FONT> <a name="line.491"></a> |
| <FONT color="green">492</FONT> principals = getRememberedIdentity(context);<a name="line.492"></a> |
| <FONT color="green">493</FONT> <a name="line.493"></a> |
| <FONT color="green">494</FONT> if (!CollectionUtils.isEmpty(principals)) {<a name="line.494"></a> |
| <FONT color="green">495</FONT> log.debug("Found remembered PrincipalCollection. Adding to the context to be used " +<a name="line.495"></a> |
| <FONT color="green">496</FONT> "for subject construction by the SubjectFactory.");<a name="line.496"></a> |
| <FONT color="green">497</FONT> <a name="line.497"></a> |
| <FONT color="green">498</FONT> context.setPrincipals(principals);<a name="line.498"></a> |
| <FONT color="green">499</FONT> <a name="line.499"></a> |
| <FONT color="green">500</FONT> // The following call was removed (commented out) in Shiro 1.2 because it uses the session as an<a name="line.500"></a> |
| <FONT color="green">501</FONT> // implementation strategy. Session use for Shiro's own needs should be controlled in a single place<a name="line.501"></a> |
| <FONT color="green">502</FONT> // to be more manageable for end-users: there are a number of stateless (e.g. REST) applications that<a name="line.502"></a> |
| <FONT color="green">503</FONT> // use Shiro that need to ensure that sessions are only used when desirable. If Shiro's internal<a name="line.503"></a> |
| <FONT color="green">504</FONT> // implementations used Subject sessions (setting attributes) whenever we wanted, it would be much<a name="line.504"></a> |
| <FONT color="green">505</FONT> // harder for end-users to control when/where that occurs.<a name="line.505"></a> |
| <FONT color="green">506</FONT> //<a name="line.506"></a> |
| <FONT color="green">507</FONT> // Because of this, the SubjectDAO was created as the single point of control, and session state logic<a name="line.507"></a> |
| <FONT color="green">508</FONT> // has been moved to the DefaultSubjectDAO implementation.<a name="line.508"></a> |
| <FONT color="green">509</FONT> <a name="line.509"></a> |
| <FONT color="green">510</FONT> // Removed in Shiro 1.2. SHIRO-157 is still satisfied by the new DefaultSubjectDAO implementation<a name="line.510"></a> |
| <FONT color="green">511</FONT> // introduced in 1.2<a name="line.511"></a> |
| <FONT color="green">512</FONT> // Satisfies SHIRO-157:<a name="line.512"></a> |
| <FONT color="green">513</FONT> // bindPrincipalsToSession(principals, context);<a name="line.513"></a> |
| <FONT color="green">514</FONT> <a name="line.514"></a> |
| <FONT color="green">515</FONT> } else {<a name="line.515"></a> |
| <FONT color="green">516</FONT> log.trace("No remembered identity found. Returning original context.");<a name="line.516"></a> |
| <FONT color="green">517</FONT> }<a name="line.517"></a> |
| <FONT color="green">518</FONT> }<a name="line.518"></a> |
| <FONT color="green">519</FONT> <a name="line.519"></a> |
| <FONT color="green">520</FONT> return context;<a name="line.520"></a> |
| <FONT color="green">521</FONT> }<a name="line.521"></a> |
| <FONT color="green">522</FONT> <a name="line.522"></a> |
| <FONT color="green">523</FONT> protected SessionContext createSessionContext(SubjectContext subjectContext) {<a name="line.523"></a> |
| <FONT color="green">524</FONT> DefaultSessionContext sessionContext = new DefaultSessionContext();<a name="line.524"></a> |
| <FONT color="green">525</FONT> if (!CollectionUtils.isEmpty(subjectContext)) {<a name="line.525"></a> |
| <FONT color="green">526</FONT> sessionContext.putAll(subjectContext);<a name="line.526"></a> |
| <FONT color="green">527</FONT> }<a name="line.527"></a> |
| <FONT color="green">528</FONT> Serializable sessionId = subjectContext.getSessionId();<a name="line.528"></a> |
| <FONT color="green">529</FONT> if (sessionId != null) {<a name="line.529"></a> |
| <FONT color="green">530</FONT> sessionContext.setSessionId(sessionId);<a name="line.530"></a> |
| <FONT color="green">531</FONT> }<a name="line.531"></a> |
| <FONT color="green">532</FONT> String host = subjectContext.resolveHost();<a name="line.532"></a> |
| <FONT color="green">533</FONT> if (host != null) {<a name="line.533"></a> |
| <FONT color="green">534</FONT> sessionContext.setHost(host);<a name="line.534"></a> |
| <FONT color="green">535</FONT> }<a name="line.535"></a> |
| <FONT color="green">536</FONT> return sessionContext;<a name="line.536"></a> |
| <FONT color="green">537</FONT> }<a name="line.537"></a> |
| <FONT color="green">538</FONT> <a name="line.538"></a> |
| <FONT color="green">539</FONT> public void logout(Subject subject) {<a name="line.539"></a> |
| <FONT color="green">540</FONT> <a name="line.540"></a> |
| <FONT color="green">541</FONT> if (subject == null) {<a name="line.541"></a> |
| <FONT color="green">542</FONT> throw new IllegalArgumentException("Subject method argument cannot be null.");<a name="line.542"></a> |
| <FONT color="green">543</FONT> }<a name="line.543"></a> |
| <FONT color="green">544</FONT> <a name="line.544"></a> |
| <FONT color="green">545</FONT> beforeLogout(subject);<a name="line.545"></a> |
| <FONT color="green">546</FONT> <a name="line.546"></a> |
| <FONT color="green">547</FONT> PrincipalCollection principals = subject.getPrincipals();<a name="line.547"></a> |
| <FONT color="green">548</FONT> if (principals != null && !principals.isEmpty()) {<a name="line.548"></a> |
| <FONT color="green">549</FONT> if (log.isDebugEnabled()) {<a name="line.549"></a> |
| <FONT color="green">550</FONT> log.debug("Logging out subject with primary principal {}", principals.getPrimaryPrincipal());<a name="line.550"></a> |
| <FONT color="green">551</FONT> }<a name="line.551"></a> |
| <FONT color="green">552</FONT> Authenticator authc = getAuthenticator();<a name="line.552"></a> |
| <FONT color="green">553</FONT> if (authc instanceof LogoutAware) {<a name="line.553"></a> |
| <FONT color="green">554</FONT> ((LogoutAware) authc).onLogout(principals);<a name="line.554"></a> |
| <FONT color="green">555</FONT> }<a name="line.555"></a> |
| <FONT color="green">556</FONT> }<a name="line.556"></a> |
| <FONT color="green">557</FONT> <a name="line.557"></a> |
| <FONT color="green">558</FONT> try {<a name="line.558"></a> |
| <FONT color="green">559</FONT> delete(subject);<a name="line.559"></a> |
| <FONT color="green">560</FONT> } catch (Exception e) {<a name="line.560"></a> |
| <FONT color="green">561</FONT> if (log.isDebugEnabled()) {<a name="line.561"></a> |
| <FONT color="green">562</FONT> String msg = "Unable to cleanly unbind Subject. Ignoring (logging out).";<a name="line.562"></a> |
| <FONT color="green">563</FONT> log.debug(msg, e);<a name="line.563"></a> |
| <FONT color="green">564</FONT> }<a name="line.564"></a> |
| <FONT color="green">565</FONT> } finally {<a name="line.565"></a> |
| <FONT color="green">566</FONT> try {<a name="line.566"></a> |
| <FONT color="green">567</FONT> stopSession(subject);<a name="line.567"></a> |
| <FONT color="green">568</FONT> } catch (Exception e) {<a name="line.568"></a> |
| <FONT color="green">569</FONT> if (log.isDebugEnabled()) {<a name="line.569"></a> |
| <FONT color="green">570</FONT> String msg = "Unable to cleanly stop Session for Subject [" + subject.getPrincipal() + "] " +<a name="line.570"></a> |
| <FONT color="green">571</FONT> "Ignoring (logging out).";<a name="line.571"></a> |
| <FONT color="green">572</FONT> log.debug(msg, e);<a name="line.572"></a> |
| <FONT color="green">573</FONT> }<a name="line.573"></a> |
| <FONT color="green">574</FONT> }<a name="line.574"></a> |
| <FONT color="green">575</FONT> }<a name="line.575"></a> |
| <FONT color="green">576</FONT> }<a name="line.576"></a> |
| <FONT color="green">577</FONT> <a name="line.577"></a> |
| <FONT color="green">578</FONT> protected void stopSession(Subject subject) {<a name="line.578"></a> |
| <FONT color="green">579</FONT> Session s = subject.getSession(false);<a name="line.579"></a> |
| <FONT color="green">580</FONT> if (s != null) {<a name="line.580"></a> |
| <FONT color="green">581</FONT> s.stop();<a name="line.581"></a> |
| <FONT color="green">582</FONT> }<a name="line.582"></a> |
| <FONT color="green">583</FONT> }<a name="line.583"></a> |
| <FONT color="green">584</FONT> <a name="line.584"></a> |
| <FONT color="green">585</FONT> /**<a name="line.585"></a> |
| <FONT color="green">586</FONT> * Unbinds or removes the Subject's state from the application, typically called during {@link #logout}.<a name="line.586"></a> |
| <FONT color="green">587</FONT> * <p/><a name="line.587"></a> |
| <FONT color="green">588</FONT> * This has been deprecated in Shiro 1.2 in favor of the {@link #delete(org.apache.shiro.subject.Subject) delete}<a name="line.588"></a> |
| <FONT color="green">589</FONT> * method. The implementation has been updated to invoke that method.<a name="line.589"></a> |
| <FONT color="green">590</FONT> *<a name="line.590"></a> |
| <FONT color="green">591</FONT> * @param subject the subject to unbind from the application as it will no longer be used.<a name="line.591"></a> |
| <FONT color="green">592</FONT> * @deprecated in Shiro 1.2 in favor of {@link #delete(org.apache.shiro.subject.Subject)}<a name="line.592"></a> |
| <FONT color="green">593</FONT> */<a name="line.593"></a> |
| <FONT color="green">594</FONT> @Deprecated<a name="line.594"></a> |
| <FONT color="green">595</FONT> @SuppressWarnings({"UnusedDeclaration"})<a name="line.595"></a> |
| <FONT color="green">596</FONT> protected void unbind(Subject subject) {<a name="line.596"></a> |
| <FONT color="green">597</FONT> delete(subject);<a name="line.597"></a> |
| <FONT color="green">598</FONT> }<a name="line.598"></a> |
| <FONT color="green">599</FONT> <a name="line.599"></a> |
| <FONT color="green">600</FONT> protected PrincipalCollection getRememberedIdentity(SubjectContext subjectContext) {<a name="line.600"></a> |
| <FONT color="green">601</FONT> RememberMeManager rmm = getRememberMeManager();<a name="line.601"></a> |
| <FONT color="green">602</FONT> if (rmm != null) {<a name="line.602"></a> |
| <FONT color="green">603</FONT> try {<a name="line.603"></a> |
| <FONT color="green">604</FONT> return rmm.getRememberedPrincipals(subjectContext);<a name="line.604"></a> |
| <FONT color="green">605</FONT> } catch (Exception e) {<a name="line.605"></a> |
| <FONT color="green">606</FONT> if (log.isWarnEnabled()) {<a name="line.606"></a> |
| <FONT color="green">607</FONT> String msg = "Delegate RememberMeManager instance of type [" + rmm.getClass().getName() +<a name="line.607"></a> |
| <FONT color="green">608</FONT> "] threw an exception during getRememberedPrincipals().";<a name="line.608"></a> |
| <FONT color="green">609</FONT> log.warn(msg, e);<a name="line.609"></a> |
| <FONT color="green">610</FONT> }<a name="line.610"></a> |
| <FONT color="green">611</FONT> }<a name="line.611"></a> |
| <FONT color="green">612</FONT> }<a name="line.612"></a> |
| <FONT color="green">613</FONT> return null;<a name="line.613"></a> |
| <FONT color="green">614</FONT> }<a name="line.614"></a> |
| <FONT color="green">615</FONT> }<a name="line.615"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
