| <!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=ISO-8859-1" /> |
| <title>ModularRealmAuthenticator xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/authc/pam/ModularRealmAuthenticator.html">View Javadoc</a></div><pre> |
| |
| <a name="1" href="#1">1</a> <em class="jxr_comment">/*</em> |
| <a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a name="9" href="#9">9</a> <em class="jxr_comment"> *</em> |
| <a name="10" href="#10">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 name="11" href="#11">11</a> <em class="jxr_comment"> *</em> |
| <a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a name="18" href="#18">18</a> <em class="jxr_comment"> */</em> |
| <a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.authc.pam; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.*; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.realm.Realm; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.PrincipalCollection; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.CollectionUtils; |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a name="27" href="#27">27</a> |
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.Collection; |
| <a name="29" href="#29">29</a> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * A {@code ModularRealmAuthenticator} delgates account lookups to a pluggable (modular) collection of</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * {@link Realm}s. This enables PAM (Pluggable Authentication Module) behavior in Shiro.</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * In addition to authorization duties, a Shiro Realm can also be thought of a PAM 'module'.</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * Using this Authenticator allows you to &quot;plug-in&quot; your own</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * {@code Realm}s as you see fit. Common realms are those based on accessing</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * LDAP, relational databases, file systems, etc.</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * If only one realm is configured (this is often the case for most applications), authentication success is naturally</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * only dependent upon invoking this one Realm's</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * {@link Realm#getAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)} method.</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * But if two or more realms are configured, PAM behavior is implemented by iterating over the collection of realms</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * and interacting with each over the course of the authentication attempt. As this is more complicated, this</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * authenticator allows customized behavior for interpreting what happens when interacting with multiple realms - for</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * example, you might require all realms to be successful during the attempt, or perhaps only at least one must be</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * successful, or some other interpretation. This customized behavior can be performed via the use of a</em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * {@link #setAuthenticationStrategy(AuthenticationStrategy) AuthenticationStrategy}, which</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * you can inject as a property of this class.</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * The strategy object provides callback methods that allow you to</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * determine what constitutes a success or failure in a multi-realm (PAM) scenario. And because this only makes sense</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * in a mult-realm scenario, the strategy object is only utilized when more than one Realm is configured.</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * As most multi-realm applications require at least one Realm authenticates successfully, the default</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * implementation is the {@link AtLeastOneSuccessfulStrategy}.</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * @see #setRealms</em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * @see AtLeastOneSuccessfulStrategy</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * @see AllSuccessfulStrategy</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * @see FirstSuccessfulStrategy</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * @since 0.1</em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="64" href="#64">64</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/authc/pam/ModularRealmAuthenticator.html">ModularRealmAuthenticator</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/authc/AbstractAuthenticator.html">AbstractAuthenticator</a> { |
| <a name="65" href="#65">65</a> |
| <a name="66" href="#66">66</a> <em class="jxr_comment">/*<em class="jxr_comment">--------------------------------------------</em></em> |
| <a name="67" href="#67">67</a> <em class="jxr_comment"> | C O N S T A N T S |</em> |
| <a name="68" href="#68">68</a> <em class="jxr_comment"> ============================================*/</em> |
| <a name="69" href="#69">69</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(ModularRealmAuthenticator.<strong class="jxr_keyword">class</strong>); |
| <a name="70" href="#70">70</a> |
| <a name="71" href="#71">71</a> <em class="jxr_comment">/*<em class="jxr_comment">--------------------------------------------</em></em> |
| <a name="72" href="#72">72</a> <em class="jxr_comment"> | I N S T A N C E V A R I A B L E S |</em> |
| <a name="73" href="#73">73</a> <em class="jxr_comment"> ============================================*/</em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * List of realms that will be iterated through when a user authenticates.</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="77" href="#77">77</a> <strong class="jxr_keyword">private</strong> Collection<Realm> realms; |
| <a name="78" href="#78">78</a> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * The authentication strategy to use during authentication attempts, defaults to a</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authc.pam.AtLeastOneSuccessfulStrategy} instance.</em> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="83" href="#83">83</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html">AuthenticationStrategy</a> authenticationStrategy; |
| <a name="84" href="#84">84</a> |
| <a name="85" href="#85">85</a> <em class="jxr_comment">/*<em class="jxr_comment">--------------------------------------------</em></em> |
| <a name="86" href="#86">86</a> <em class="jxr_comment"> | C O N S T R U C T O R S |</em> |
| <a name="87" href="#87">87</a> <em class="jxr_comment"> ============================================*/</em> |
| <a name="88" href="#88">88</a> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * Default no-argument constructor which</em> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * {@link #setAuthenticationStrategy(AuthenticationStrategy) enables} an</em> |
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authc.pam.AtLeastOneSuccessfulStrategy} by default.</em> |
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="94" href="#94">94</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/authc/pam/ModularRealmAuthenticator.html">ModularRealmAuthenticator</a>() { |
| <a name="95" href="#95">95</a> <strong class="jxr_keyword">this</strong>.authenticationStrategy = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/authc/pam/AtLeastOneSuccessfulStrategy.html">AtLeastOneSuccessfulStrategy</a>(); |
| <a name="96" href="#96">96</a> } |
| <a name="97" href="#97">97</a> |
| <a name="98" href="#98">98</a> <em class="jxr_comment">/*<em class="jxr_comment">--------------------------------------------</em></em> |
| <a name="99" href="#99">99</a> <em class="jxr_comment"> | A C C E S S O R S / M O D I F I E R S |</em> |
| <a name="100" href="#100">100</a> <em class="jxr_comment"> ============================================*/</em> |
| <a name="101" href="#101">101</a> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * Sets all realms used by this Authenticator, providing PAM (Pluggable Authentication Module) configuration.</em> |
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * @param realms the realms to consult during authentication attempts.</em> |
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="107" href="#107">107</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setRealms(Collection<Realm> realms) { |
| <a name="108" href="#108">108</a> <strong class="jxr_keyword">this</strong>.realms = realms; |
| <a name="109" href="#109">109</a> } |
| <a name="110" href="#110">110</a> |
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * Returns the realm(s) used by this {@code Authenticator} during an authentication attempt.</em> |
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * @return the realm(s) used by this {@code Authenticator} during an authentication attempt.</em> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="116" href="#116">116</a> <strong class="jxr_keyword">protected</strong> Collection<Realm> getRealms() { |
| <a name="117" href="#117">117</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.realms; |
| <a name="118" href="#118">118</a> } |
| <a name="119" href="#119">119</a> |
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * Returns the {@code AuthenticationStrategy} utilized by this modular authenticator during a multi-realm</em> |
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * log-in attempt. This object is only used when two or more Realms are configured.</em> |
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * Unless overridden by</em> |
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * the {@link #setAuthenticationStrategy(AuthenticationStrategy)} method, the default implementation</em> |
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * is the {@link org.apache.shiro.authc.pam.AtLeastOneSuccessfulStrategy}.</em> |
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * @return the {@code AuthenticationStrategy} utilized by this modular authenticator during a log-in attempt.</em> |
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * @since 0.2</em> |
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="131" href="#131">131</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html">AuthenticationStrategy</a> getAuthenticationStrategy() { |
| <a name="132" href="#132">132</a> <strong class="jxr_keyword">return</strong> authenticationStrategy; |
| <a name="133" href="#133">133</a> } |
| <a name="134" href="#134">134</a> |
| <a name="135" href="#135">135</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * Allows overriding the default {@code AuthenticationStrategy} utilized during multi-realm log-in attempts.</em> |
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * This object is only used when two or more Realms are configured.</em> |
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * @param authenticationStrategy the strategy implementation to use during log-in attempts.</em> |
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * @since 0.2</em> |
| <a name="141" href="#141">141</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="142" href="#142">142</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setAuthenticationStrategy(<a href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html">AuthenticationStrategy</a> authenticationStrategy) { |
| <a name="143" href="#143">143</a> <strong class="jxr_keyword">this</strong>.authenticationStrategy = authenticationStrategy; |
| <a name="144" href="#144">144</a> } |
| <a name="145" href="#145">145</a> |
| <a name="146" href="#146">146</a> <em class="jxr_comment">/*<em class="jxr_comment">--------------------------------------------</em></em> |
| <a name="147" href="#147">147</a> <em class="jxr_comment"> | M E T H O D S |</em> |
| <a name="148" href="#148">148</a> |
| <a name="149" href="#149">149</a> <em class="jxr_comment"> /**</em> |
| <a name="150" href="#150">150</a> <em class="jxr_comment"> * Used by the internal {@link #doAuthenticate} implementation to ensure that the {@code realms} property</em> |
| <a name="151" href="#151">151</a> <em class="jxr_comment"> * has been set. The default implementation ensures the property is not null and not empty.</em> |
| <a name="152" href="#152">152</a> <em class="jxr_comment"> *</em> |
| <a name="153" href="#153">153</a> <em class="jxr_comment"> * @throws IllegalStateException if the {@code realms} property is configured incorrectly.</em> |
| <a name="154" href="#154">154</a> <em class="jxr_comment"> */</em> |
| <a name="155" href="#155">155</a> |
| <a name="156" href="#156">156</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> assertRealmsConfigured() <strong class="jxr_keyword">throws</strong> IllegalStateException { |
| <a name="157" href="#157">157</a> Collection<Realm> realms = getRealms(); |
| <a name="158" href="#158">158</a> <strong class="jxr_keyword">if</strong> (CollectionUtils.isEmpty(realms)) { |
| <a name="159" href="#159">159</a> String msg = <span class="jxr_string">"Configuration error: No realms have been configured! One or more realms must be "</span> + |
| <a name="160" href="#160">160</a> <span class="jxr_string">"present to execute an authentication attempt."</span>; |
| <a name="161" href="#161">161</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(msg); |
| <a name="162" href="#162">162</a> } |
| <a name="163" href="#163">163</a> } |
| <a name="164" href="#164">164</a> |
| <a name="165" href="#165">165</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> * Performs the authentication attempt by interacting with the single configured realm, which is significantly</em> |
| <a name="167" href="#167">167</a> <em class="jxr_javadoccomment"> * simpler than performing multi-realm logic.</em> |
| <a name="168" href="#168">168</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="169" href="#169">169</a> <em class="jxr_javadoccomment"> * @param realm the realm to consult for AuthenticationInfo.</em> |
| <a name="170" href="#170">170</a> <em class="jxr_javadoccomment"> * @param token the submitted AuthenticationToken representing the subject's (user's) log-in principals and credentials.</em> |
| <a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * @return the AuthenticationInfo associated with the user account corresponding to the specified {@code token}</em> |
| <a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="173" href="#173">173</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> doSingleRealmAuthentication(<a href="../../../../../org/apache/shiro/realm/Realm.html">Realm</a> realm, <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token) { |
| <a name="174" href="#174">174</a> <strong class="jxr_keyword">if</strong> (!realm.supports(token)) { |
| <a name="175" href="#175">175</a> String msg = <span class="jxr_string">"Realm ["</span> + realm + <span class="jxr_string">"] does not support authentication token ["</span> + |
| <a name="176" href="#176">176</a> token + <span class="jxr_string">"]. Please ensure that the appropriate Realm implementation is "</span> + |
| <a name="177" href="#177">177</a> <span class="jxr_string">"configured correctly or that the realm accepts AuthenticationTokens of this type."</span>; |
| <a name="178" href="#178">178</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/authc/pam/UnsupportedTokenException.html">UnsupportedTokenException</a>(msg); |
| <a name="179" href="#179">179</a> } |
| <a name="180" href="#180">180</a> <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> info = realm.getAuthenticationInfo(token); |
| <a name="181" href="#181">181</a> <strong class="jxr_keyword">if</strong> (info == <strong class="jxr_keyword">null</strong>) { |
| <a name="182" href="#182">182</a> String msg = <span class="jxr_string">"Realm ["</span> + realm + <span class="jxr_string">"] was unable to find account data for the "</span> + |
| <a name="183" href="#183">183</a> <span class="jxr_string">"submitted AuthenticationToken ["</span> + token + <span class="jxr_string">"]."</span>; |
| <a name="184" href="#184">184</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/authc/UnknownAccountException.html">UnknownAccountException</a>(msg); |
| <a name="185" href="#185">185</a> } |
| <a name="186" href="#186">186</a> <strong class="jxr_keyword">return</strong> info; |
| <a name="187" href="#187">187</a> } |
| <a name="188" href="#188">188</a> |
| <a name="189" href="#189">189</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="190" href="#190">190</a> <em class="jxr_javadoccomment"> * Performs the multi-realm authentication attempt by calling back to a {@link AuthenticationStrategy} object</em> |
| <a name="191" href="#191">191</a> <em class="jxr_javadoccomment"> * as each realm is consulted for {@code AuthenticationInfo} for the specified {@code token}.</em> |
| <a name="192" href="#192">192</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="193" href="#193">193</a> <em class="jxr_javadoccomment"> * @param realms the multiple realms configured on this Authenticator instance.</em> |
| <a name="194" href="#194">194</a> <em class="jxr_javadoccomment"> * @param token the submitted AuthenticationToken representing the subject's (user's) log-in principals and credentials.</em> |
| <a name="195" href="#195">195</a> <em class="jxr_javadoccomment"> * @return an aggregated AuthenticationInfo instance representing account data across all the successfully</em> |
| <a name="196" href="#196">196</a> <em class="jxr_javadoccomment"> * consulted realms.</em> |
| <a name="197" href="#197">197</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="198" href="#198">198</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> doMultiRealmAuthentication(Collection<Realm> realms, <a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token) { |
| <a name="199" href="#199">199</a> |
| <a name="200" href="#200">200</a> <a href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html">AuthenticationStrategy</a> strategy = getAuthenticationStrategy(); |
| <a name="201" href="#201">201</a> |
| <a name="202" href="#202">202</a> <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> aggregate = strategy.beforeAllAttempts(realms, token); |
| <a name="203" href="#203">203</a> |
| <a name="204" href="#204">204</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) { |
| <a name="205" href="#205">205</a> log.trace(<span class="jxr_string">"Iterating through {} realms for PAM authentication"</span>, realms.size()); |
| <a name="206" href="#206">206</a> } |
| <a name="207" href="#207">207</a> |
| <a name="208" href="#208">208</a> <strong class="jxr_keyword">for</strong> (Realm realm : realms) { |
| <a name="209" href="#209">209</a> |
| <a name="210" href="#210">210</a> aggregate = strategy.beforeAttempt(realm, token, aggregate); |
| <a name="211" href="#211">211</a> |
| <a name="212" href="#212">212</a> <strong class="jxr_keyword">if</strong> (realm.supports(token)) { |
| <a name="213" href="#213">213</a> |
| <a name="214" href="#214">214</a> log.trace(<span class="jxr_string">"Attempting to authenticate token [{}] using realm [{}]"</span>, token, realm); |
| <a name="215" href="#215">215</a> |
| <a name="216" href="#216">216</a> <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> info = <strong class="jxr_keyword">null</strong>; |
| <a name="217" href="#217">217</a> Throwable t = <strong class="jxr_keyword">null</strong>; |
| <a name="218" href="#218">218</a> <strong class="jxr_keyword">try</strong> { |
| <a name="219" href="#219">219</a> info = realm.getAuthenticationInfo(token); |
| <a name="220" href="#220">220</a> } <strong class="jxr_keyword">catch</strong> (Throwable throwable) { |
| <a name="221" href="#221">221</a> t = throwable; |
| <a name="222" href="#222">222</a> <strong class="jxr_keyword">if</strong> (log.isWarnEnabled()) { |
| <a name="223" href="#223">223</a> String msg = <span class="jxr_string">"Realm ["</span> + realm + <span class="jxr_string">"] threw an exception during a multi-realm authentication attempt:"</span>; |
| <a name="224" href="#224">224</a> log.warn(msg, t); |
| <a name="225" href="#225">225</a> } |
| <a name="226" href="#226">226</a> } |
| <a name="227" href="#227">227</a> |
| <a name="228" href="#228">228</a> aggregate = strategy.afterAttempt(realm, token, info, aggregate, t); |
| <a name="229" href="#229">229</a> |
| <a name="230" href="#230">230</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="231" href="#231">231</a> log.debug(<span class="jxr_string">"Realm [{}] does not support token {}. Skipping realm."</span>, realm, token); |
| <a name="232" href="#232">232</a> } |
| <a name="233" href="#233">233</a> } |
| <a name="234" href="#234">234</a> |
| <a name="235" href="#235">235</a> aggregate = strategy.afterAllAttempts(token, aggregate); |
| <a name="236" href="#236">236</a> |
| <a name="237" href="#237">237</a> <strong class="jxr_keyword">return</strong> aggregate; |
| <a name="238" href="#238">238</a> } |
| <a name="239" href="#239">239</a> |
| <a name="240" href="#240">240</a> |
| <a name="241" href="#241">241</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="242" href="#242">242</a> <em class="jxr_javadoccomment"> * Attempts to authenticate the given token by iterating over the internal collection of</em> |
| <a name="243" href="#243">243</a> <em class="jxr_javadoccomment"> * {@link Realm}s. For each realm, first the {@link Realm#supports(org.apache.shiro.authc.AuthenticationToken)}</em> |
| <a name="244" href="#244">244</a> <em class="jxr_javadoccomment"> * method will be called to determine if the realm supports the {@code authenticationToken} method argument.</em> |
| <a name="245" href="#245">245</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="246" href="#246">246</a> <em class="jxr_javadoccomment"> * If a realm does support</em> |
| <a name="247" href="#247">247</a> <em class="jxr_javadoccomment"> * the token, its {@link Realm#getAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)}</em> |
| <a name="248" href="#248">248</a> <em class="jxr_javadoccomment"> * method will be called. If the realm returns a non-null account, the token will be</em> |
| <a name="249" href="#249">249</a> <em class="jxr_javadoccomment"> * considered authenticated for that realm and the account data recorded. If the realm returns {@code null},</em> |
| <a name="250" href="#250">250</a> <em class="jxr_javadoccomment"> * the next realm will be consulted. If no realms support the token or all supporting realms return null,</em> |
| <a name="251" href="#251">251</a> <em class="jxr_javadoccomment"> * an {@link AuthenticationException} will be thrown to indicate that the user could not be authenticated.</em> |
| <a name="252" href="#252">252</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="253" href="#253">253</a> <em class="jxr_javadoccomment"> * After all realms have been consulted, the information from each realm is aggregated into a single</em> |
| <a name="254" href="#254">254</a> <em class="jxr_javadoccomment"> * {@link AuthenticationInfo} object and returned.</em> |
| <a name="255" href="#255">255</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="256" href="#256">256</a> <em class="jxr_javadoccomment"> * @param authenticationToken the token containing the authentication principal and credentials for the</em> |
| <a name="257" href="#257">257</a> <em class="jxr_javadoccomment"> * user being authenticated.</em> |
| <a name="258" href="#258">258</a> <em class="jxr_javadoccomment"> * @return account information attributed to the authenticated user.</em> |
| <a name="259" href="#259">259</a> <em class="jxr_javadoccomment"> * @throws IllegalStateException if no realms have been configured at the time this method is invoked</em> |
| <a name="260" href="#260">260</a> <em class="jxr_javadoccomment"> * @throws AuthenticationException if the user could not be authenticated or the user is denied authentication</em> |
| <a name="261" href="#261">261</a> <em class="jxr_javadoccomment"> * for the given principal and credentials.</em> |
| <a name="262" href="#262">262</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="263" href="#263">263</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> doAuthenticate(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> authenticationToken) <strong class="jxr_keyword">throws</strong> AuthenticationException { |
| <a name="264" href="#264">264</a> assertRealmsConfigured(); |
| <a name="265" href="#265">265</a> Collection<Realm> realms = getRealms(); |
| <a name="266" href="#266">266</a> <strong class="jxr_keyword">if</strong> (realms.size() == 1) { |
| <a name="267" href="#267">267</a> <strong class="jxr_keyword">return</strong> doSingleRealmAuthentication(realms.iterator().next(), authenticationToken); |
| <a name="268" href="#268">268</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="269" href="#269">269</a> <strong class="jxr_keyword">return</strong> doMultiRealmAuthentication(realms, authenticationToken); |
| <a name="270" href="#270">270</a> } |
| <a name="271" href="#271">271</a> } |
| <a name="272" href="#272">272</a> |
| <a name="273" href="#273">273</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="274" href="#274">274</a> <em class="jxr_javadoccomment"> * First calls <code>super.onLogout(principals)</code> to ensure a logout notification is issued, and for each</em> |
| <a name="275" href="#275">275</a> <em class="jxr_javadoccomment"> * wrapped {@code Realm} that implements the {@link LogoutAware LogoutAware} interface, calls</em> |
| <a name="276" href="#276">276</a> <em class="jxr_javadoccomment"> * <code>((LogoutAware)realm).onLogout(principals)</code> to allow each realm the opportunity to perform</em> |
| <a name="277" href="#277">277</a> <em class="jxr_javadoccomment"> * logout/cleanup operations during an user-logout.</em> |
| <a name="278" href="#278">278</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="279" href="#279">279</a> <em class="jxr_javadoccomment"> * Shiro's Realm implementations all implement the {@code LogoutAware} interface by default and can be</em> |
| <a name="280" href="#280">280</a> <em class="jxr_javadoccomment"> * overridden for realm-specific logout logic.</em> |
| <a name="281" href="#281">281</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="282" href="#282">282</a> <em class="jxr_javadoccomment"> * @param principals the application-specific Subject/user identifier.</em> |
| <a name="283" href="#283">283</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="284" href="#284">284</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onLogout(<a href="../../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals) { |
| <a name="285" href="#285">285</a> <strong class="jxr_keyword">super</strong>.onLogout(principals); |
| <a name="286" href="#286">286</a> Collection<Realm> realms = getRealms(); |
| <a name="287" href="#287">287</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(realms)) { |
| <a name="288" href="#288">288</a> <strong class="jxr_keyword">for</strong> (Realm realm : realms) { |
| <a name="289" href="#289">289</a> <strong class="jxr_keyword">if</strong> (realm instanceof LogoutAware) { |
| <a name="290" href="#290">290</a> ((<a href="../../../../../org/apache/shiro/authc/LogoutAware.html">LogoutAware</a>) realm).onLogout(principals); |
| <a name="291" href="#291">291</a> } |
| <a name="292" href="#292">292</a> } |
| <a name="293" href="#293">293</a> } |
| <a name="294" href="#294">294</a> } |
| <a name="295" href="#295">295</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
