| <!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.authc;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.shiro.subject.PrincipalCollection;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.slf4j.Logger;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.slf4j.LoggerFactory;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.ArrayList;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.Collection;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span><a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>/**<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * Superclass for almost all {@link Authenticator} implementations that performs the common work around authentication<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * attempts.<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * <p/><a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * This class delegates the actual authentication attempt to subclasses but supports notification for<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * successful and failed logins as well as logouts. Notification is sent to one or more registered<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * {@link AuthenticationListener AuthenticationListener}s to allow for custom processing logic<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * when these conditions occur.<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * <p/><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * In most cases, the only thing a subclass needs to do (via its {@link #doAuthenticate} implementation)<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * is perform the actual principal/credential verification process for the submitted {@code AuthenticationToken}.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> *<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * @since 0.1<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> */<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>public abstract class AbstractAuthenticator implements Authenticator, LogoutAware {<a name="line.43"></a> |
| <span class="sourceLineNo">044</span><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> /*-------------------------------------------<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> | C O N S T A N T S |<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> ============================================*/<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> /**<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * Private class log instance.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> */<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> private static final Logger log = LoggerFactory.getLogger(AbstractAuthenticator.class);<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> /*-------------------------------------------<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> | I N S T A N C E V A R I A B L E S |<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> ============================================*/<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> /**<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * Any registered listeners that wish to know about things during the authentication process.<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> */<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> private Collection<AuthenticationListener> listeners;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> /*-------------------------------------------<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> | C O N S T R U C T O R S |<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> ============================================*/<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> /**<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * Default no-argument constructor. Ensures the internal<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * {@link AuthenticationListener AuthenticationListener} collection is a non-null {@code ArrayList}.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> */<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> public AbstractAuthenticator() {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> listeners = new ArrayList<AuthenticationListener>();<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> }<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> /*--------------------------------------------<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> | A C C E S S O R S / M O D I F I E R S |<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> ============================================*/<a name="line.75"></a> |
| <span class="sourceLineNo">076</span><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> /**<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * Sets the {@link AuthenticationListener AuthenticationListener}s that should be notified during authentication<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * attempts.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> *<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * @param listeners one or more {@code AuthenticationListener}s that should be notified due to an<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * authentication attempt.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> */<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> public void setAuthenticationListeners(Collection<AuthenticationListener> listeners) {<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> if (listeners == null) {<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> this.listeners = new ArrayList<AuthenticationListener>();<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> } else {<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> this.listeners = listeners;<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> }<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> }<a name="line.91"></a> |
| <span class="sourceLineNo">092</span><a name="line.92"></a> |
| <span class="sourceLineNo">093</span> /**<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * Returns the {@link AuthenticationListener AuthenticationListener}s that should be notified during authentication<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * attempts.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> *<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * @return the {@link AuthenticationListener AuthenticationListener}s that should be notified during authentication<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * attempts.<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> */<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> public Collection<AuthenticationListener> getAuthenticationListeners() {<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> return this.listeners;<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> }<a name="line.103"></a> |
| <span class="sourceLineNo">104</span><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> /*-------------------------------------------<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> | M E T H O D S |<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> ============================================*/<a name="line.107"></a> |
| <span class="sourceLineNo">108</span><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> /**<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * Notifies any registered {@link AuthenticationListener AuthenticationListener}s that<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * authentication was successful for the specified {@code token} which resulted in the specified<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * {@code info}. This implementation merely iterates over the internal {@code listeners} collection and<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * calls {@link AuthenticationListener#onSuccess(AuthenticationToken, AuthenticationInfo) onSuccess}<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * for each.<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> *<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * @param token the submitted {@code AuthenticationToken} that resulted in a successful authentication.<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * @param info the returned {@code AuthenticationInfo} resulting from the successful authentication.<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> */<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> protected void notifySuccess(AuthenticationToken token, AuthenticationInfo info) {<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> for (AuthenticationListener listener : this.listeners) {<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> listener.onSuccess(token, info);<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><a name="line.124"></a> |
| <span class="sourceLineNo">125</span> /**<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * Notifies any registered {@link AuthenticationListener AuthenticationListener}s that<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * authentication failed for the<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * specified {@code token} which resulted in the specified {@code ae} exception. This implementation merely<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * iterates over the internal {@code listeners} collection and calls<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * {@link AuthenticationListener#onFailure(AuthenticationToken, AuthenticationException) onFailure}<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * for each.<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> *<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * @param token the submitted {@code AuthenticationToken} that resulted in a failed authentication.<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * @param ae the resulting {@code AuthenticationException} that caused the authentication to fail.<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> */<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> protected void notifyFailure(AuthenticationToken token, AuthenticationException ae) {<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> for (AuthenticationListener listener : this.listeners) {<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> listener.onFailure(token, ae);<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> }<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> }<a name="line.140"></a> |
| <span class="sourceLineNo">141</span><a name="line.141"></a> |
| <span class="sourceLineNo">142</span> /**<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * Notifies any registered {@link AuthenticationListener AuthenticationListener}s that a<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * {@code Subject} has logged-out. This implementation merely<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * iterates over the internal {@code listeners} collection and calls<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * {@link AuthenticationListener#onLogout(org.apache.shiro.subject.PrincipalCollection) onLogout}<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * for each.<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> *<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * @param principals the identifying principals of the {@code Subject}/account logging out.<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> */<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> protected void notifyLogout(PrincipalCollection principals) {<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> for (AuthenticationListener listener : this.listeners) {<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> listener.onLogout(principals);<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> /**<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * This implementation merely calls<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * {@link #notifyLogout(org.apache.shiro.subject.PrincipalCollection) notifyLogout} to allow any registered listeners<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * to react to the logout.<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> *<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * @param principals the identifying principals of the {@code Subject}/account logging out.<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> */<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> public void onLogout(PrincipalCollection principals) {<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> notifyLogout(principals);<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> }<a name="line.166"></a> |
| <span class="sourceLineNo">167</span><a name="line.167"></a> |
| <span class="sourceLineNo">168</span> /**<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * Implementation of the {@link Authenticator} interface that functions in the following manner:<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * <ol><a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * <li>Calls template {@link #doAuthenticate doAuthenticate} method for subclass execution of the actual<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * authentication behavior.</li><a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * <li>If an {@code AuthenticationException} is thrown during {@code doAuthenticate},<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * {@link #notifyFailure(AuthenticationToken, AuthenticationException) notify} any registered<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * {@link AuthenticationListener AuthenticationListener}s of the exception and then propogate the exception<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * for the caller to handle.</li><a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * <li>If no exception is thrown (indicating a successful login),<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * {@link #notifySuccess(AuthenticationToken, AuthenticationInfo) notify} any registered<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * {@link AuthenticationListener AuthenticationListener}s of the successful attempt.</li><a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * <li>Return the {@code AuthenticationInfo}</li><a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * </ol><a name="line.181"></a> |
| <span class="sourceLineNo">182</span> *<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * @param token the submitted token representing the subject's (user's) login principals and credentials.<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * @return the AuthenticationInfo referencing the authenticated user's account data.<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * @throws AuthenticationException if there is any problem during the authentication process - see the<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * interface's JavaDoc for a more detailed explanation.<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> */<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> public final AuthenticationInfo authenticate(AuthenticationToken token) throws AuthenticationException {<a name="line.188"></a> |
| <span class="sourceLineNo">189</span><a name="line.189"></a> |
| <span class="sourceLineNo">190</span> if (token == null) {<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> throw new IllegalArgumentException("Method argument (authentication token) cannot be null.");<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> }<a name="line.192"></a> |
| <span class="sourceLineNo">193</span><a name="line.193"></a> |
| <span class="sourceLineNo">194</span> log.trace("Authentication attempt received for token [{}]", token);<a name="line.194"></a> |
| <span class="sourceLineNo">195</span><a name="line.195"></a> |
| <span class="sourceLineNo">196</span> AuthenticationInfo info;<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> try {<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> info = doAuthenticate(token);<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> if (info == null) {<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> String msg = "No account information found for authentication token [" + token + "] by this " +<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> "Authenticator instance. Please check that it is configured correctly.";<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> throw new AuthenticationException(msg);<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> }<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> } catch (Throwable t) {<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> AuthenticationException ae = null;<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> if (t instanceof AuthenticationException) {<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> ae = (AuthenticationException) t;<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> }<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> if (ae == null) {<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> //Exception thrown was not an expected AuthenticationException. Therefore it is probably a little more<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> //severe or unexpected. So, wrap in an AuthenticationException, log to warn, and propagate:<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> String msg = "Authentication failed for token submission [" + token + "]. Possible unexpected " +<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> "error? (Typical or expected login exceptions should extend from AuthenticationException).";<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> ae = new AuthenticationException(msg, t);<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> if (log.isWarnEnabled())<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> log.warn(msg, t);<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> }<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> try {<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> notifyFailure(token, ae);<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> } catch (Throwable t2) {<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> if (log.isWarnEnabled()) {<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> String msg = "Unable to send notification for failed authentication attempt - listener error?. " +<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> "Please check your AuthenticationListener implementation(s). Logging sending exception " +<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> "and propagating original AuthenticationException instead...";<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> log.warn(msg, t2);<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> }<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> }<a name="line.227"></a> |
| <span class="sourceLineNo">228</span><a name="line.228"></a> |
| <span class="sourceLineNo">229</span><a name="line.229"></a> |
| <span class="sourceLineNo">230</span> throw ae;<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> }<a name="line.231"></a> |
| <span class="sourceLineNo">232</span><a name="line.232"></a> |
| <span class="sourceLineNo">233</span> log.debug("Authentication successful for token [{}]. Returned account [{}]", token, info);<a name="line.233"></a> |
| <span class="sourceLineNo">234</span><a name="line.234"></a> |
| <span class="sourceLineNo">235</span> notifySuccess(token, info);<a name="line.235"></a> |
| <span class="sourceLineNo">236</span><a name="line.236"></a> |
| <span class="sourceLineNo">237</span> return info;<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> }<a name="line.238"></a> |
| <span class="sourceLineNo">239</span><a name="line.239"></a> |
| <span class="sourceLineNo">240</span> /**<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> * Template design pattern hook for subclasses to implement specific authentication behavior.<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> * <p/><a name="line.242"></a> |
| <span class="sourceLineNo">243</span> * Common behavior for most authentication attempts is encapsulated in the<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * {@link #authenticate} method and that method invokes this one for custom behavior.<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * <p/><a name="line.245"></a> |
| <span class="sourceLineNo">246</span> * <b>N.B.</b> Subclasses <em>should</em> throw some kind of<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * {@code AuthenticationException} if there is a problem during<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * authentication instead of returning {@code null}. A {@code null} return value indicates<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> * a configuration or programming error, since {@code AuthenticationException}s should<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> * indicate any expected problem (such as an unknown account or username, or invalid password, etc).<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> *<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> * @param token the authentication token encapsulating the user's login information.<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> * @return an {@code AuthenticationInfo} object encapsulating the user's account information<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> * important to Shiro.<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> * @throws AuthenticationException if there is a problem logging in the user.<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> */<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> protected abstract AuthenticationInfo doAuthenticate(AuthenticationToken token)<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> throws AuthenticationException;<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
