blob: 47f28a2e67bb5c993961e1391c68667c14ea37ac [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en"><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../../jacoco-resources/report.gif" type="image/gif"/><title>AtLeastOneSuccessfulStrategy.java</title><link rel="stylesheet" href="../../jacoco-resources/prettify.css" type="text/css"/><script type="text/javascript" src="../../jacoco-resources/prettify.js"></script></head><body onload="window['PR_TAB_WIDTH']=4;prettyPrint()"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../../index.html" class="el_report">Apache Shiro :: All (aggregate jar)</a> &gt; <a href="../index.html" class="el_bundle">shiro-core</a> &gt; <a href="index.source.html" class="el_package">org.apache.shiro.authc.pam</a> &gt; <span class="el_source">AtLeastOneSuccessfulStrategy.java</span></div><h1>AtLeastOneSuccessfulStrategy.java</h1><pre class="source lang-java linenums">/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* &quot;License&quot;); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.shiro.authc.pam;
import org.apache.shiro.authc.AuthenticationException;
import org.apache.shiro.authc.AuthenticationInfo;
import org.apache.shiro.authc.AuthenticationToken;
import org.apache.shiro.subject.PrincipalCollection;
/**
* &lt;tt&gt;AuthenticationStrategy&lt;/tt&gt; implementation that requires &lt;em&gt;at least one&lt;/em&gt; configured realm to
* successfully process the submitted &lt;tt&gt;AuthenticationToken&lt;/tt&gt; during the log-in attempt.
* &lt;p/&gt;
* &lt;p&gt;This means any number of configured realms do not have to support the submitted log-in token, or they may
* 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
* Strategy implementation will allow the log-in process to be successful.
* &lt;p/&gt;
* &lt;p&gt;Note that this implementation will aggregate the account data from &lt;em&gt;all&lt;/em&gt; successfully consulted
* realms during the authentication attempt. If you want only the account data from the first successfully
* consulted realm and want to ignore all subsequent realms, use the
* {@link FirstSuccessfulStrategy FirstSuccessfulAuthenticationStrategy} instead.
*
* @see FirstSuccessfulStrategy FirstSuccessfulAuthenticationStrategy
* @since 0.2
*/
<span class="fc" id="L42">public class AtLeastOneSuccessfulStrategy extends AbstractAuthenticationStrategy {</span>
private static boolean isEmpty(PrincipalCollection pc) {
<span class="nc bnc" id="L45" title="All 4 branches missed."> return pc == null || pc.isEmpty();</span>
}
/**
* Ensures that the &lt;code&gt;aggregate&lt;/code&gt; method argument is not &lt;code&gt;null&lt;/code&gt; and
* &lt;code&gt;aggregate.{@link org.apache.shiro.authc.AuthenticationInfo#getPrincipals() getPrincipals()}&lt;/code&gt;
* 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
* that none of the realms authenticated successfully.
*/
public AuthenticationInfo afterAllAttempts(AuthenticationToken token, AuthenticationInfo aggregate) throws AuthenticationException {
//we know if one or more were able to successfully authenticate if the aggregated account object does not
//contain null or empty data:
<span class="nc bnc" id="L57" title="All 4 branches missed."> if (aggregate == null || isEmpty(aggregate.getPrincipals())) {</span>
<span class="nc" id="L58"> throw new AuthenticationException(&quot;Authentication token of type [&quot; + token.getClass() + &quot;] &quot; +</span>
&quot;could not be authenticated by any configured realms. Please ensure that at least one realm can &quot; +
&quot;authenticate these tokens.&quot;);
}
<span class="nc" id="L63"> return aggregate;</span>
}
}
</pre><div class="footer"><span class="right">Created with <a href="http://www.eclemma.org/jacoco">JaCoCo</a> 0.7.7.201606060606</span></div></body></html>