blob: 5681d2127ef67a0888a58373b539158fbb95c1a6 [file] [log] [blame]
<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.authc.pam;<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.AuthenticationException;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.shiro.authc.AuthenticationInfo;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.shiro.authc.AuthenticationToken;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.shiro.util.CollectionUtils;<a name="line.24"></a>
<FONT color="green">025</FONT> <a name="line.25"></a>
<FONT color="green">026</FONT> /**<a name="line.26"></a>
<FONT color="green">027</FONT> * &lt;tt&gt;AuthenticationStrategy&lt;/tt&gt; implementation that requires &lt;em&gt;at least one&lt;/em&gt; configured realm to<a name="line.27"></a>
<FONT color="green">028</FONT> * successfully process the submitted &lt;tt&gt;AuthenticationToken&lt;/tt&gt; during the log-in attempt.<a name="line.28"></a>
<FONT color="green">029</FONT> * &lt;p/&gt;<a name="line.29"></a>
<FONT color="green">030</FONT> * &lt;p&gt;This means any number of configured realms do not have to support the submitted log-in token, or they may<a name="line.30"></a>
<FONT color="green">031</FONT> * be unable to acquire &lt;tt&gt;AuthenticationInfo&lt;/tt&gt; for the token, but as long as at least one can do both, this<a name="line.31"></a>
<FONT color="green">032</FONT> * Strategy implementation will allow the log-in process to be successful.<a name="line.32"></a>
<FONT color="green">033</FONT> * &lt;p/&gt;<a name="line.33"></a>
<FONT color="green">034</FONT> * &lt;p&gt;Note that this implementation will aggregate the account data from &lt;em&gt;all&lt;/em&gt; successfully consulted<a name="line.34"></a>
<FONT color="green">035</FONT> * realms during the authentication attempt. If you want only the account data from the first successfully<a name="line.35"></a>
<FONT color="green">036</FONT> * consulted realm and want to ignore all subsequent realms, use the<a name="line.36"></a>
<FONT color="green">037</FONT> * {@link FirstSuccessfulStrategy FirstSuccessfulAuthenticationStrategy} instead.<a name="line.37"></a>
<FONT color="green">038</FONT> *<a name="line.38"></a>
<FONT color="green">039</FONT> * @see FirstSuccessfulStrategy FirstSuccessfulAuthenticationStrategy<a name="line.39"></a>
<FONT color="green">040</FONT> * @since 0.2<a name="line.40"></a>
<FONT color="green">041</FONT> */<a name="line.41"></a>
<FONT color="green">042</FONT> public class AtLeastOneSuccessfulStrategy extends AbstractAuthenticationStrategy {<a name="line.42"></a>
<FONT color="green">043</FONT> <a name="line.43"></a>
<FONT color="green">044</FONT> /**<a name="line.44"></a>
<FONT color="green">045</FONT> * Ensures that the &lt;code&gt;aggregate&lt;/code&gt; method argument is not &lt;code&gt;null&lt;/code&gt; and<a name="line.45"></a>
<FONT color="green">046</FONT> * &lt;code&gt;aggregate.{@link org.apache.shiro.authc.AuthenticationInfo#getPrincipals() getPrincipals()}&lt;/code&gt;<a name="line.46"></a>
<FONT color="green">047</FONT> * is not &lt;code&gt;null&lt;/code&gt;, and if either is &lt;code&gt;null&lt;/code&gt;, throws an AuthenticationException to indicate<a name="line.47"></a>
<FONT color="green">048</FONT> * that none of the realms authenticated successfully.<a name="line.48"></a>
<FONT color="green">049</FONT> */<a name="line.49"></a>
<FONT color="green">050</FONT> public AuthenticationInfo afterAllAttempts(AuthenticationToken token, AuthenticationInfo aggregate) throws AuthenticationException {<a name="line.50"></a>
<FONT color="green">051</FONT> //we know if one or more were able to succesfully authenticate if the aggregated account object does not<a name="line.51"></a>
<FONT color="green">052</FONT> //contain null or empty data:<a name="line.52"></a>
<FONT color="green">053</FONT> if (aggregate == null || CollectionUtils.isEmpty(aggregate.getPrincipals())) {<a name="line.53"></a>
<FONT color="green">054</FONT> throw new AuthenticationException("Authentication token of type [" + token.getClass() + "] " +<a name="line.54"></a>
<FONT color="green">055</FONT> "could not be authenticated by any configured realms. Please ensure that at least one realm can " +<a name="line.55"></a>
<FONT color="green">056</FONT> "authenticate these tokens.");<a name="line.56"></a>
<FONT color="green">057</FONT> }<a name="line.57"></a>
<FONT color="green">058</FONT> <a name="line.58"></a>
<FONT color="green">059</FONT> return aggregate;<a name="line.59"></a>
<FONT color="green">060</FONT> }<a name="line.60"></a>
<FONT color="green">061</FONT> }<a name="line.61"></a>
</PRE>
</BODY>
</HTML>