blob: e95f431cc7e23485532618a555dcc6d022bd9c4a [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.*;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.shiro.realm.Realm;<a name="line.22"></a>
<FONT color="green">023</FONT> <a name="line.23"></a>
<FONT color="green">024</FONT> import java.util.Collection;<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> /**<a name="line.27"></a>
<FONT color="green">028</FONT> * Abstract base implementation for Shiro's concrete &lt;code&gt;AuthenticationStrategy&lt;/code&gt;<a name="line.28"></a>
<FONT color="green">029</FONT> * implementations.<a name="line.29"></a>
<FONT color="green">030</FONT> *<a name="line.30"></a>
<FONT color="green">031</FONT> * @since 0.9<a name="line.31"></a>
<FONT color="green">032</FONT> */<a name="line.32"></a>
<FONT color="green">033</FONT> public abstract class AbstractAuthenticationStrategy implements AuthenticationStrategy {<a name="line.33"></a>
<FONT color="green">034</FONT> <a name="line.34"></a>
<FONT color="green">035</FONT> /**<a name="line.35"></a>
<FONT color="green">036</FONT> * Simply returns &lt;code&gt;new {@link org.apache.shiro.authc.SimpleAuthenticationInfo SimpleAuthenticationInfo}();&lt;/code&gt;, which supports<a name="line.36"></a>
<FONT color="green">037</FONT> * aggregating account data across realms.<a name="line.37"></a>
<FONT color="green">038</FONT> */<a name="line.38"></a>
<FONT color="green">039</FONT> public AuthenticationInfo beforeAllAttempts(Collection&lt;? extends Realm&gt; realms, AuthenticationToken token) throws AuthenticationException {<a name="line.39"></a>
<FONT color="green">040</FONT> return new SimpleAuthenticationInfo();<a name="line.40"></a>
<FONT color="green">041</FONT> }<a name="line.41"></a>
<FONT color="green">042</FONT> <a name="line.42"></a>
<FONT color="green">043</FONT> /**<a name="line.43"></a>
<FONT color="green">044</FONT> * Simply returns the &lt;code&gt;aggregate&lt;/code&gt; method argument, without modification.<a name="line.44"></a>
<FONT color="green">045</FONT> */<a name="line.45"></a>
<FONT color="green">046</FONT> public AuthenticationInfo beforeAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo aggregate) throws AuthenticationException {<a name="line.46"></a>
<FONT color="green">047</FONT> return aggregate;<a name="line.47"></a>
<FONT color="green">048</FONT> }<a name="line.48"></a>
<FONT color="green">049</FONT> <a name="line.49"></a>
<FONT color="green">050</FONT> /**<a name="line.50"></a>
<FONT color="green">051</FONT> * Base implementation that will aggregate the specified &lt;code&gt;singleRealmInfo&lt;/code&gt; into the<a name="line.51"></a>
<FONT color="green">052</FONT> * &lt;code&gt;aggregateInfo&lt;/code&gt; and then returns the aggregate. Can be overridden by subclasses for custom behavior.<a name="line.52"></a>
<FONT color="green">053</FONT> */<a name="line.53"></a>
<FONT color="green">054</FONT> public AuthenticationInfo afterAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo singleRealmInfo, AuthenticationInfo aggregateInfo, Throwable t) throws AuthenticationException {<a name="line.54"></a>
<FONT color="green">055</FONT> AuthenticationInfo info;<a name="line.55"></a>
<FONT color="green">056</FONT> if (singleRealmInfo == null) {<a name="line.56"></a>
<FONT color="green">057</FONT> info = aggregateInfo;<a name="line.57"></a>
<FONT color="green">058</FONT> } else {<a name="line.58"></a>
<FONT color="green">059</FONT> if (aggregateInfo == null) {<a name="line.59"></a>
<FONT color="green">060</FONT> info = singleRealmInfo;<a name="line.60"></a>
<FONT color="green">061</FONT> } else {<a name="line.61"></a>
<FONT color="green">062</FONT> info = merge(singleRealmInfo, aggregateInfo);<a name="line.62"></a>
<FONT color="green">063</FONT> }<a name="line.63"></a>
<FONT color="green">064</FONT> }<a name="line.64"></a>
<FONT color="green">065</FONT> <a name="line.65"></a>
<FONT color="green">066</FONT> return info;<a name="line.66"></a>
<FONT color="green">067</FONT> }<a name="line.67"></a>
<FONT color="green">068</FONT> <a name="line.68"></a>
<FONT color="green">069</FONT> /**<a name="line.69"></a>
<FONT color="green">070</FONT> * Merges the specified &lt;code&gt;info&lt;/code&gt; argument into the &lt;code&gt;aggregate&lt;/code&gt; argument and then returns an<a name="line.70"></a>
<FONT color="green">071</FONT> * aggregate for continued use throughout the login process.<a name="line.71"></a>
<FONT color="green">072</FONT> * &lt;p/&gt;<a name="line.72"></a>
<FONT color="green">073</FONT> * This implementation merely checks to see if the specified &lt;code&gt;aggregate&lt;/code&gt; argument is an instance of<a name="line.73"></a>
<FONT color="green">074</FONT> * {@link org.apache.shiro.authc.MergableAuthenticationInfo MergableAuthenticationInfo}, and if so, calls<a name="line.74"></a>
<FONT color="green">075</FONT> * &lt;code&gt;aggregate.merge(info)&lt;/code&gt; If it is &lt;em&gt;not&lt;/em&gt; an instance of<a name="line.75"></a>
<FONT color="green">076</FONT> * &lt;code&gt;MergableAuthenticationInfo&lt;/code&gt;, an {@link IllegalArgumentException IllegalArgumentException} is thrown.<a name="line.76"></a>
<FONT color="green">077</FONT> * Can be overridden by subclasses for custom merging behavior if implementing the<a name="line.77"></a>
<FONT color="green">078</FONT> * {@link org.apache.shiro.authc.MergableAuthenticationInfo MergableAuthenticationInfo} is not desired for some reason.<a name="line.78"></a>
<FONT color="green">079</FONT> */<a name="line.79"></a>
<FONT color="green">080</FONT> protected AuthenticationInfo merge(AuthenticationInfo info, AuthenticationInfo aggregate) {<a name="line.80"></a>
<FONT color="green">081</FONT> if( aggregate instanceof MergableAuthenticationInfo ) {<a name="line.81"></a>
<FONT color="green">082</FONT> ((MergableAuthenticationInfo)aggregate).merge(info);<a name="line.82"></a>
<FONT color="green">083</FONT> return aggregate;<a name="line.83"></a>
<FONT color="green">084</FONT> } else {<a name="line.84"></a>
<FONT color="green">085</FONT> throw new IllegalArgumentException( "Attempt to merge authentication info from multiple realms, but aggregate " +<a name="line.85"></a>
<FONT color="green">086</FONT> "AuthenticationInfo is not of type MergableAuthenticationInfo." );<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> <a name="line.89"></a>
<FONT color="green">090</FONT> /**<a name="line.90"></a>
<FONT color="green">091</FONT> * Simply returns the &lt;code&gt;aggregate&lt;/code&gt; argument without modification. Can be overridden for custom behavior.<a name="line.91"></a>
<FONT color="green">092</FONT> */<a name="line.92"></a>
<FONT color="green">093</FONT> public AuthenticationInfo afterAllAttempts(AuthenticationToken token, AuthenticationInfo aggregate) throws AuthenticationException {<a name="line.93"></a>
<FONT color="green">094</FONT> return aggregate;<a name="line.94"></a>
<FONT color="green">095</FONT> }<a name="line.95"></a>
<FONT color="green">096</FONT> }<a name="line.96"></a>
</PRE>
</BODY>
</HTML>