| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
| <title>AllSuccessfulStrategy xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/authc/pam/AllSuccessfulStrategy.html">View Javadoc</a></div><pre> |
| <a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> |
| <a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> |
| <a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.authc.pam; |
| <a class="jxr_linenumber" name="L20" href="#L20">20</a> |
| <a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationException; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationInfo; |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationToken; |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.UnknownAccountException; |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.realm.Realm; |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * <tt>AuthenticationStrategy</tt> implementation that requires <em>all</em> configured realms to</em> |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * <b>successfully</b> process the submitted <tt>AuthenticationToken</tt> during the log-in attempt.</em> |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * <p>If one or more realms do not support the submitted token, or one or more are unable to acquire</em> |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * <tt>AuthenticationInfo</tt> for the token, this implementation will immediately fail the log-in attempt for the</em> |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * associated subject (user).</em> |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * @since 0.2</em> |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="AllSuccessfulStrategy" href="../../../../../org/apache/shiro/authc/pam/AllSuccessfulStrategy.html#AllSuccessfulStrategy">AllSuccessfulStrategy</a> <strong class="jxr_keyword">extends</strong> <a name="AbstractAuthenticationStrategy" href="../../../../../org/apache/shiro/authc/pam/AbstractAuthenticationStrategy.html#AbstractAuthenticationStrategy">AbstractAuthenticationStrategy</a> { |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment">/** Private class log instance. */</em> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(AllSuccessfulStrategy.<strong class="jxr_keyword">class</strong>); |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * Because all realms in this strategy must complete successfully, this implementation ensures that the given</em> |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * <code>Realm</code> {@link org.apache.shiro.realm.Realm#supports(org.apache.shiro.authc.AuthenticationToken) supports} the given</em> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * <code>token</code> argument. If it does not, this method throws an</em> |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * {@link UnsupportedTokenException UnsupportedTokenException} to end the authentication</em> |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * process immediately. If the realm does support the token, the <code>info</code> argument is returned immediately.</em> |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">public</strong> <a name="AuthenticationInfo" href="../../../../../org/apache/shiro/authc/<a name="AuthenticationInfo" href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html#AuthenticationInfo">AuthenticationInfo</a>.html#AuthenticationInfo">AuthenticationInfo</a> beforeAttempt(<a name="Realm" href="../../../../../org/apache/shiro/realm/Realm.html#Realm">Realm</a> realm, <a name="AuthenticationToken" href="../../../../../org/apache/shiro/authc/AuthenticationToken.html#AuthenticationToken">AuthenticationToken</a> token, <a name="AuthenticationInfo" href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html#AuthenticationInfo">AuthenticationInfo</a> info) <strong class="jxr_keyword">throws</strong> <a name="AuthenticationException" href="../../../../../org/apache/shiro/authc/AuthenticationException.html#AuthenticationException">AuthenticationException</a> { |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">if</strong> (!realm.supports(token)) { |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> String msg = <span class="jxr_string">"Realm ["</span> + realm + <span class="jxr_string">"] of type ["</span> + realm.getClass().getName() + <span class="jxr_string">"] does not support "</span> + |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> <span class="jxr_string">" the submitted AuthenticationToken ["</span> + token + <span class="jxr_string">"]. The ["</span> + getClass().getName() + |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <span class="jxr_string">"] implementation requires all configured realm(s) to support and be able to process the submitted "</span> + |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <span class="jxr_string">"AuthenticationToken."</span>; |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="UnsupportedTokenException" href="../../../../../org/apache/shiro/authc/pam/UnsupportedTokenException.html#UnsupportedTokenException">UnsupportedTokenException</a>(msg); |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> } |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">return</strong> info; |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> } |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * Merges the specified <code>info</code> into the <code>aggregate</code> argument and returns it (just as the</em> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * parent implementation does), but additionally ensures the following:</em> |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * <li>if the <code>Throwable</code> argument is not <code>null</code>, re-throws it to immediately cancel the</em> |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * authentication process, since this strategy requires all realms to authenticate successfully.</li></em> |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * <li>neither the <code>info</code> or <code>aggregate</code> argument is <code>null</code> to ensure that each</em> |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * realm did in fact authenticate successfully</li></em> |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">public</strong> <a name="AuthenticationInfo" href="../../../../../org/apache/shiro/authc<a name="AuthenticationIn<a name="AuthenticationInfo" href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html#AuthenticationInfo">AuthenticationInfo</a>/../../org/apache/shiro/authc/AuthenticationInfo.html#AuthenticationInfo">AuthenticationInfo</a>o.html#AuthenticationInfo">AuthenticationInfo</a> afterAttempt(<a name="Realm" href="../../../../../org/apache/shiro/realm/Realm.html#Realm">Realm</a> realm, <a name="AuthenticationToken" href="../../../../../org/apache/shiro/authc/AuthenticationToken.html#AuthenticationToken">AuthenticationToken</a> token, <a name="AuthenticationIn<a name="AuthenticationInfo" href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html#AuthenticationInfo">AuthenticationInfo</a>/../../org/apache/shiro/authc/AuthenticationInfo.html#AuthenticationInfo">AuthenticationInfo</a> info, <a name="AuthenticationInfo" href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html#AuthenticationInfo">AuthenticationInfo</a> aggregate, Throwable t) |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">throws</strong> <a name="AuthenticationException" href="../../../../../org/apache/shiro/authc/AuthenticationException.html#AuthenticationException">AuthenticationException</a> { |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">if</strong> (t != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">if</strong> (t instanceof <a name="AuthenticationException" href="../../../../../org/apache/shiro/authc/AuthenticationException.html#AuthenticationException">AuthenticationException</a>) { |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_comment">//propagate:</em> |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">throw</strong> ((<a name="AuthenticationException" href="../../../../../org/apache/shiro/authc/AuthenticationException.html#AuthenticationException">AuthenticationException</a>) t); |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> String msg = <span class="jxr_string">"Unable to acquire account data from realm ["</span> + realm + <span class="jxr_string">"]. The ["</span> + |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> getClass().getName() + <span class="jxr_string">" implementation requires all configured realm(s) to operate successfully "</span> + |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <span class="jxr_string">"for a successful authentication."</span>; |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="AuthenticationException" href="../../../../../org/apache/shiro/authc/AuthenticationException.html#AuthenticationException">AuthenticationException</a>(msg, t); |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> } |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> } |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">if</strong> (info == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> String msg = <span class="jxr_string">"Realm ["</span> + realm + <span class="jxr_string">"] could not find any associated account data for the submitted "</span> + |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> <span class="jxr_string">"AuthenticationToken ["</span> + token + <span class="jxr_string">"]. The ["</span> + getClass().getName() + <span class="jxr_string">"] implementation requires "</span> + |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> <span class="jxr_string">"all configured realm(s) to acquire valid account data for a submitted token during the "</span> + |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> <span class="jxr_string">"log-in process."</span>; |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="UnknownAccountException" href="../../../../../org/apache/shiro/authc/UnknownAccountException.html#UnknownAccountException">UnknownAccountException</a>(msg); |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> } |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> log.debug(<span class="jxr_string">"Account successfully authenticated using realm [{}]"</span>, realm); |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_comment">// If non-null account is returned, then the realm was able to authenticate the</em> |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_comment">// user - so merge the account with any accumulated before:</em> |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> merge(info, aggregate); |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">return</strong> aggregate; |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> } |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 2004–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
