| <!DOCTYPE HTML> |
| <html lang="en"> |
| <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.AuthenticationException;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.authc.AuthenticationInfo;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.authc.AuthenticationToken;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import org.apache.shiro.realm.Realm;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import org.apache.shiro.subject.PrincipalCollection;</a> |
| <span class="sourceLineNo">026</span><a id="line.26"></a> |
| <span class="sourceLineNo">027</span><a id="line.27">import java.util.Collection;</a> |
| <span class="sourceLineNo">028</span><a id="line.28"></a> |
| <span class="sourceLineNo">029</span><a id="line.29">/**</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * {@link AuthenticationStrategy} implementation that only accepts the account data from</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * the first successfully consulted Realm and ignores all subsequent realms. This is slightly</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * different behavior than {@link AtLeastOneSuccessfulStrategy}, so please review both to see</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * which one meets your needs better.</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> *</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * @see AtLeastOneSuccessfulStrategy AtLeastOneSuccessfulAuthenticationStrategy</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * @since 0.9</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> */</a> |
| <span class="sourceLineNo">038</span><a id="line.38">public class FirstSuccessfulStrategy extends AbstractAuthenticationStrategy {</a> |
| <span class="sourceLineNo">039</span><a id="line.39"></a> |
| <span class="sourceLineNo">040</span><a id="line.40"> private boolean stopAfterFirstSuccess;</a> |
| <span class="sourceLineNo">041</span><a id="line.41"></a> |
| <span class="sourceLineNo">042</span><a id="line.42"> public void setStopAfterFirstSuccess (boolean stopAfterFirstSuccess ) {</a> |
| <span class="sourceLineNo">043</span><a id="line.43"></a> |
| <span class="sourceLineNo">044</span><a id="line.44"> this.stopAfterFirstSuccess = stopAfterFirstSuccess ;</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> }</a> |
| <span class="sourceLineNo">046</span><a id="line.46"></a> |
| <span class="sourceLineNo">047</span><a id="line.47"> public boolean getStopAfterFirstSuccess() {</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> return stopAfterFirstSuccess ;</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"> /**</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> * Returns {@code null} immediately, relying on this class's {@link #merge merge} implementation to return</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * only the first {@code info} object it encounters, ignoring all subsequent ones.</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> */</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> public AuthenticationInfo beforeAllAttempts(Collection<? extends Realm> realms, AuthenticationToken token) throws AuthenticationException {</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> return null;</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> }</a> |
| <span class="sourceLineNo">058</span><a id="line.58"></a> |
| <span class="sourceLineNo">059</span><a id="line.59"></a> |
| <span class="sourceLineNo">060</span><a id="line.60"> /**</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> * Throws ShortCircuitIterationException if stopAfterFirstSuccess is set and authentication is </a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * successful with a previously consulted realm. </a> |
| <span class="sourceLineNo">063</span><a id="line.63"> * Returns the <code>aggregate</code> method argument, without modification</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> * otherwise.</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> */</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> public AuthenticationInfo beforeAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo aggregate) throws AuthenticationException {</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> if (getStopAfterFirstSuccess() && aggregate != null && !isEmpty(aggregate.getPrincipals())) {</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> throw new ShortCircuitIterationException();</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> }</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> return aggregate;</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> }</a> |
| <span class="sourceLineNo">072</span><a id="line.72"></a> |
| <span class="sourceLineNo">073</span><a id="line.73"> </a> |
| <span class="sourceLineNo">074</span><a id="line.74"></a> |
| <span class="sourceLineNo">075</span><a id="line.75"> private static boolean isEmpty(PrincipalCollection pc) {</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> return pc == null || pc.isEmpty();</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> }</a> |
| <span class="sourceLineNo">078</span><a id="line.78"></a> |
| <span class="sourceLineNo">079</span><a id="line.79"> /**</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> * Returns the specified {@code aggregate} instance if is non null and valid (that is, has principals and they are</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> * not empty) immediately, or, if it is null or not valid, the {@code info} argument is returned instead.</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> * <p/></a> |
| <span class="sourceLineNo">083</span><a id="line.83"> * This logic ensures that the first valid info encountered is the one retained and all subsequent ones are ignored,</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> * since this strategy mandates that only the info from the first successfully authenticated realm be used.</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> */</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> protected AuthenticationInfo merge(AuthenticationInfo info, AuthenticationInfo aggregate) {</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> if (aggregate != null && !isEmpty(aggregate.getPrincipals())) {</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> return aggregate;</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> }</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> return info != null ? info : aggregate;</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> }</a> |
| <span class="sourceLineNo">092</span><a id="line.92">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
