blob: 5f56f45d275758bd12182e0f4e2384cf0925a076 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="fr">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a>
<span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">009</span><a id="line.9"> *</a>
<span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">011</span><a id="line.11"> *</a>
<span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a>
<span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a>
<span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a>
<span class="sourceLineNo">018</span><a id="line.18"> */</a>
<span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.authc.pam;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.authc.*;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.realm.Realm;</a>
<span class="sourceLineNo">023</span><a id="line.23"></a>
<span class="sourceLineNo">024</span><a id="line.24">import java.util.Collection;</a>
<span class="sourceLineNo">025</span><a id="line.25"></a>
<span class="sourceLineNo">026</span><a id="line.26"></a>
<span class="sourceLineNo">027</span><a id="line.27">/**</a>
<span class="sourceLineNo">028</span><a id="line.28"> * Abstract base implementation for Shiro's concrete &lt;code&gt;AuthenticationStrategy&lt;/code&gt;</a>
<span class="sourceLineNo">029</span><a id="line.29"> * implementations.</a>
<span class="sourceLineNo">030</span><a id="line.30"> *</a>
<span class="sourceLineNo">031</span><a id="line.31"> * @since 0.9</a>
<span class="sourceLineNo">032</span><a id="line.32"> */</a>
<span class="sourceLineNo">033</span><a id="line.33">public abstract class AbstractAuthenticationStrategy implements AuthenticationStrategy {</a>
<span class="sourceLineNo">034</span><a id="line.34"></a>
<span class="sourceLineNo">035</span><a id="line.35"> /**</a>
<span class="sourceLineNo">036</span><a id="line.36"> * Simply returns &lt;code&gt;new {@link org.apache.shiro.authc.SimpleAuthenticationInfo SimpleAuthenticationInfo}();&lt;/code&gt;, which supports</a>
<span class="sourceLineNo">037</span><a id="line.37"> * aggregating account data across realms.</a>
<span class="sourceLineNo">038</span><a id="line.38"> */</a>
<span class="sourceLineNo">039</span><a id="line.39"> public AuthenticationInfo beforeAllAttempts(Collection&lt;? extends Realm&gt; realms, AuthenticationToken token) throws AuthenticationException {</a>
<span class="sourceLineNo">040</span><a id="line.40"> return new SimpleAuthenticationInfo();</a>
<span class="sourceLineNo">041</span><a id="line.41"> }</a>
<span class="sourceLineNo">042</span><a id="line.42"></a>
<span class="sourceLineNo">043</span><a id="line.43"> /**</a>
<span class="sourceLineNo">044</span><a id="line.44"> * Simply returns the &lt;code&gt;aggregate&lt;/code&gt; method argument, without modification.</a>
<span class="sourceLineNo">045</span><a id="line.45"> */</a>
<span class="sourceLineNo">046</span><a id="line.46"> public AuthenticationInfo beforeAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo aggregate) throws AuthenticationException {</a>
<span class="sourceLineNo">047</span><a id="line.47"> return aggregate;</a>
<span class="sourceLineNo">048</span><a id="line.48"> }</a>
<span class="sourceLineNo">049</span><a id="line.49"></a>
<span class="sourceLineNo">050</span><a id="line.50"> /**</a>
<span class="sourceLineNo">051</span><a id="line.51"> * Base implementation that will aggregate the specified &lt;code&gt;singleRealmInfo&lt;/code&gt; into the</a>
<span class="sourceLineNo">052</span><a id="line.52"> * &lt;code&gt;aggregateInfo&lt;/code&gt; and then returns the aggregate. Can be overridden by subclasses for custom behavior.</a>
<span class="sourceLineNo">053</span><a id="line.53"> */</a>
<span class="sourceLineNo">054</span><a id="line.54"> public AuthenticationInfo afterAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo singleRealmInfo, AuthenticationInfo aggregateInfo, Throwable t) throws AuthenticationException {</a>
<span class="sourceLineNo">055</span><a id="line.55"> AuthenticationInfo info;</a>
<span class="sourceLineNo">056</span><a id="line.56"> if (singleRealmInfo == null) {</a>
<span class="sourceLineNo">057</span><a id="line.57"> info = aggregateInfo;</a>
<span class="sourceLineNo">058</span><a id="line.58"> } else {</a>
<span class="sourceLineNo">059</span><a id="line.59"> if (aggregateInfo == null) {</a>
<span class="sourceLineNo">060</span><a id="line.60"> info = singleRealmInfo;</a>
<span class="sourceLineNo">061</span><a id="line.61"> } else {</a>
<span class="sourceLineNo">062</span><a id="line.62"> info = merge(singleRealmInfo, aggregateInfo);</a>
<span class="sourceLineNo">063</span><a id="line.63"> }</a>
<span class="sourceLineNo">064</span><a id="line.64"> }</a>
<span class="sourceLineNo">065</span><a id="line.65"></a>
<span class="sourceLineNo">066</span><a id="line.66"> return info;</a>
<span class="sourceLineNo">067</span><a id="line.67"> }</a>
<span class="sourceLineNo">068</span><a id="line.68"></a>
<span class="sourceLineNo">069</span><a id="line.69"> /**</a>
<span class="sourceLineNo">070</span><a id="line.70"> * 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>
<span class="sourceLineNo">071</span><a id="line.71"> * aggregate for continued use throughout the login process.</a>
<span class="sourceLineNo">072</span><a id="line.72"> * &lt;p/&gt;</a>
<span class="sourceLineNo">073</span><a id="line.73"> * This implementation merely checks to see if the specified &lt;code&gt;aggregate&lt;/code&gt; argument is an instance of</a>
<span class="sourceLineNo">074</span><a id="line.74"> * {@link org.apache.shiro.authc.MergableAuthenticationInfo MergableAuthenticationInfo}, and if so, calls</a>
<span class="sourceLineNo">075</span><a id="line.75"> * &lt;code&gt;aggregate.merge(info)&lt;/code&gt; If it is &lt;em&gt;not&lt;/em&gt; an instance of</a>
<span class="sourceLineNo">076</span><a id="line.76"> * &lt;code&gt;MergableAuthenticationInfo&lt;/code&gt;, an {@link IllegalArgumentException IllegalArgumentException} is thrown.</a>
<span class="sourceLineNo">077</span><a id="line.77"> * Can be overridden by subclasses for custom merging behavior if implementing the</a>
<span class="sourceLineNo">078</span><a id="line.78"> * {@link org.apache.shiro.authc.MergableAuthenticationInfo MergableAuthenticationInfo} is not desired for some reason.</a>
<span class="sourceLineNo">079</span><a id="line.79"> */</a>
<span class="sourceLineNo">080</span><a id="line.80"> protected AuthenticationInfo merge(AuthenticationInfo info, AuthenticationInfo aggregate) {</a>
<span class="sourceLineNo">081</span><a id="line.81"> if( aggregate instanceof MergableAuthenticationInfo ) {</a>
<span class="sourceLineNo">082</span><a id="line.82"> ((MergableAuthenticationInfo)aggregate).merge(info);</a>
<span class="sourceLineNo">083</span><a id="line.83"> return aggregate;</a>
<span class="sourceLineNo">084</span><a id="line.84"> } else {</a>
<span class="sourceLineNo">085</span><a id="line.85"> throw new IllegalArgumentException( "Attempt to merge authentication info from multiple realms, but aggregate " +</a>
<span class="sourceLineNo">086</span><a id="line.86"> "AuthenticationInfo is not of type MergableAuthenticationInfo." );</a>
<span class="sourceLineNo">087</span><a id="line.87"> }</a>
<span class="sourceLineNo">088</span><a id="line.88"> }</a>
<span class="sourceLineNo">089</span><a id="line.89"></a>
<span class="sourceLineNo">090</span><a id="line.90"> /**</a>
<span class="sourceLineNo">091</span><a id="line.91"> * Simply returns the &lt;code&gt;aggregate&lt;/code&gt; argument without modification. Can be overridden for custom behavior.</a>
<span class="sourceLineNo">092</span><a id="line.92"> */</a>
<span class="sourceLineNo">093</span><a id="line.93"> public AuthenticationInfo afterAllAttempts(AuthenticationToken token, AuthenticationInfo aggregate) throws AuthenticationException {</a>
<span class="sourceLineNo">094</span><a id="line.94"> return aggregate;</a>
<span class="sourceLineNo">095</span><a id="line.95"> }</a>
<span class="sourceLineNo">096</span><a id="line.96">}</a>
</pre>
</div>
</main>
</body>
</html>