Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.9.1 / shiro-core / xref / org / apache / shiro / authc / pam / ModularRealmAuthenticator.html
blob: 4417e48e8a19e95d0aceee0805b4797db4c28561 [file] [log] [blame]
<!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>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 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.apache.shiro.authc.*;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.realm.Realm;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.PrincipalCollection;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.CollectionUtils;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a class="jxr_linenumber" name="L27" href="#L27">27</a>
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.Collection;
<a class="jxr_linenumber" name="L29" href="#L29">29</a>
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * A {@code ModularRealmAuthenticator} delegates account lookups to a pluggable (modular) collection of</em>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * {@link Realm}s. This enables PAM (Pluggable Authentication Module) behavior in Shiro.</em>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * In addition to authorization duties, a Shiro Realm can also be thought of a PAM 'module'.</em>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * Using this Authenticator allows you to &amp;quot;plug-in&amp;quot; your own</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * {@code Realm}s as you see fit. Common realms are those based on accessing</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * LDAP, relational databases, file systems, etc.</em>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L39" href="#L39">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 class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * only dependent upon invoking this one Realm's</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * {@link Realm#getAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)} method.</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L43" href="#L43">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 class="jxr_linenumber" name="L44" href="#L44">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 class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * authenticator allows customized behavior for interpreting what happens when interacting with multiple realms - for</em>
<a class="jxr_linenumber" name="L46" href="#L46">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 class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * successful, or some other interpretation. This customized behavior can be performed via the use of a</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * {@link #setAuthenticationStrategy(AuthenticationStrategy) AuthenticationStrategy}, which</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * you can inject as a property of this class.</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * The strategy object provides callback methods that allow you to</em>
<a class="jxr_linenumber" name="L52" href="#L52">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 class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * in a multi-realm scenario, the strategy object is only utilized when more than one Realm is configured.</em>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * As most multi-realm applications require at least one Realm authenticates successfully, the default</em>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * implementation is the {@link AtLeastOneSuccessfulStrategy}.</em>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * @see #setRealms</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * @see AtLeastOneSuccessfulStrategy</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * @see AllSuccessfulStrategy</em>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * @see FirstSuccessfulStrategy</em>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * @since 0.1</em>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="ModularRealmAuthenticator" href="../../../../../org/apache/shiro/authc/pam/ModularRealmAuthenticator.html#ModularRealmAuthenticator">ModularRealmAuthenticator</a> <strong class="jxr_keyword">extends</strong> <a name="AbstractAuthenticator" href="../../../../../org/apache/shiro/authc/AbstractAuthenticator.html#AbstractAuthenticator">AbstractAuthenticator</a> {
<a class="jxr_linenumber" name="L65" href="#L65">65</a>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_comment"> | C O N S T A N T S |</em>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L69" href="#L69">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 class="jxr_linenumber" name="L70" href="#L70">70</a>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L72" href="#L72">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 class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_comment"> ============================================*/</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> <em class="jxr_javadoccomment"> * List of realms that will be iterated through when a user authenticates.</em>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">private</strong> Collection&lt;Realm&gt; realms;
<a class="jxr_linenumber" name="L78" href="#L78">78</a>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * The authentication strategy to use during authentication attempts, defaults to a</em>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authc.pam.AtLeastOneSuccessfulStrategy} instance.</em>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">private</strong> <a name="AuthenticationStrategy" href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html#AuthenticationStrategy">AuthenticationStrategy</a> authenticationStrategy;
<a class="jxr_linenumber" name="L84" href="#L84">84</a>
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_comment"> | C O N S T R U C T O R S |</em>
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L88" href="#L88">88</a>
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * Default no-argument constructor which</em>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * {@link #setAuthenticationStrategy(AuthenticationStrategy) enables} an</em>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authc.pam.AtLeastOneSuccessfulStrategy} by default.</em>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">public</strong> <a name="ModularRealmAuthenticator" href="../../../../../org/apache/shiro/authc/pam/ModularRealmAuthenticator.html#ModularRealmAuthenticator">ModularRealmAuthenticator</a>() {
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">this</strong>.authenticationStrategy = <strong class="jxr_keyword">new</strong> <a name="AtLeastOneSuccessfulStrategy" href="../../../../../org/apache/shiro/authc/pam/AtLeastOneSuccessfulStrategy.html#AtLeastOneSuccessfulStrategy">AtLeastOneSuccessfulStrategy</a>();
<a class="jxr_linenumber" name="L96" href="#L96">96</a> }
<a class="jxr_linenumber" name="L97" href="#L97">97</a>
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L99" href="#L99">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 class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L101" href="#L101">101</a>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * Sets all realms used by this Authenticator, providing PAM (Pluggable Authentication Module) configuration.</em>
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * @param realms the realms to consult during authentication attempts.</em>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setRealms(Collection&lt;Realm&gt; realms) {
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">this</strong>.realms = realms;
<a class="jxr_linenumber" name="L109" href="#L109">109</a> }
<a class="jxr_linenumber" name="L110" href="#L110">110</a>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * Returns the realm(s) used by this {@code Authenticator} during an authentication attempt.</em>
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * @return the realm(s) used by this {@code Authenticator} during an authentication attempt.</em>
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">protected</strong> Collection&lt;Realm&gt; getRealms() {
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.realms;
<a class="jxr_linenumber" name="L118" href="#L118">118</a> }
<a class="jxr_linenumber" name="L119" href="#L119">119</a>
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * Returns the {@code AuthenticationStrategy} utilized by this modular authenticator during a multi-realm</em>
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * log-in attempt. This object is only used when two or more Realms are configured.</em>
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * Unless overridden by</em>
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * the {@link #setAuthenticationStrategy(AuthenticationStrategy)} method, the default implementation</em>
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * is the {@link org.apache.shiro.authc.pam.AtLeastOneSuccessfulStrategy}.</em>
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * @return the {@code AuthenticationStrategy} utilized by this modular authenticator during a log-in attempt.</em>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * @since 0.2</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">public</strong> <a name="AuthenticationStrategy" href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html#AuthenticationStrategy">AuthenticationStrategy</a> getAuthenticationStrategy() {
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">return</strong> authenticationStrategy;
<a class="jxr_linenumber" name="L133" href="#L133">133</a> }
<a class="jxr_linenumber" name="L134" href="#L134">134</a>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * Allows overriding the default {@code AuthenticationStrategy} utilized during multi-realm log-in attempts.</em>
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * This object is only used when two or more Realms are configured.</em>
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * @param authenticationStrategy the strategy implementation to use during log-in attempts.</em>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * @since 0.2</em>
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setAuthenticationStrategy(<a name="AuthenticationStrategy" href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html#AuthenticationStrategy">AuthenticationStrategy</a> authenticationStrategy) {
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">this</strong>.authenticationStrategy = authenticationStrategy;
<a class="jxr_linenumber" name="L144" href="#L144">144</a> }
<a class="jxr_linenumber" name="L145" href="#L145">145</a>
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_comment"> | M E T H O D S |</em>
<a class="jxr_linenumber" name="L148" href="#L148">148</a>
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_comment"> /**</em>
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_comment"> * Used by the internal {@link #doAuthenticate} implementation to ensure that the {@code realms} property</em>
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_comment"> * has been set. The default implementation ensures the property is not null and not empty.</em>
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_comment"> * @throws IllegalStateException if the {@code realms} property is configured incorrectly.</em>
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L155" href="#L155">155</a>
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> assertRealmsConfigured() <strong class="jxr_keyword">throws</strong> IllegalStateException {
<a class="jxr_linenumber" name="L157" href="#L157">157</a> Collection&lt;Realm&gt; realms = getRealms();
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">if</strong> (CollectionUtils.isEmpty(realms)) {
<a class="jxr_linenumber" name="L159" href="#L159">159</a> String msg = <span class="jxr_string">"Configuration error: No realms have been configured! One or more realms must be "</span> +
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <span class="jxr_string">"present to execute an authentication attempt."</span>;
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(msg);
<a class="jxr_linenumber" name="L162" href="#L162">162</a> }
<a class="jxr_linenumber" name="L163" href="#L163">163</a> }
<a class="jxr_linenumber" name="L164" href="#L164">164</a>
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * Performs the authentication attempt by interacting with the single configured realm, which is significantly</em>
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * simpler than performing multi-realm logic.</em>
<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * @param realm the realm to consult for AuthenticationInfo.</em>
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * @param token the submitted AuthenticationToken representing the subject's (user's) log-in principals and credentials.</em>
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * @return the AuthenticationInfo associated with the user account corresponding to the specified {@code token}</em>
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">protected</strong> <a name="AuthenticationInfo" href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html#AuthenticationInfo">AuthenticationInfo</a> doSingleRealmAuthentication(<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 class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">if</strong> (!realm.supports(token)) {
<a class="jxr_linenumber" name="L175" href="#L175">175</a> String msg = <span class="jxr_string">"Realm ["</span> + realm + <span class="jxr_string">"] does not support authentication token ["</span> +
<a class="jxr_linenumber" name="L176" href="#L176">176</a> token + <span class="jxr_string">"]. Please ensure that the appropriate Realm implementation is "</span> +
<a class="jxr_linenumber" name="L177" href="#L177">177</a> <span class="jxr_string">"configured correctly or that the realm accepts AuthenticationTokens of this type."</span>;
<a class="jxr_linenumber" name="L178" href="#L178">178</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="L179" href="#L179">179</a> }
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <a name="AuthenticationInfo" href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html#AuthenticationInfo">AuthenticationInfo</a> info = realm.getAuthenticationInfo(token);
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">if</strong> (info == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L182" href="#L182">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 class="jxr_linenumber" name="L183" href="#L183">183</a> <span class="jxr_string">"submitted AuthenticationToken ["</span> + token + <span class="jxr_string">"]."</span>;
<a class="jxr_linenumber" name="L184" href="#L184">184</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="L185" href="#L185">185</a> }
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">return</strong> info;
<a class="jxr_linenumber" name="L187" href="#L187">187</a> }
<a class="jxr_linenumber" name="L188" href="#L188">188</a>
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * Performs the multi-realm authentication attempt by calling back to a {@link AuthenticationStrategy} object</em>
<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * as each realm is consulted for {@code AuthenticationInfo} for the specified {@code token}.</em>
<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * @param realms the multiple realms configured on this Authenticator instance.</em>
<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * @param token the submitted AuthenticationToken representing the subject's (user's) log-in principals and credentials.</em>
<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> * @return an aggregated AuthenticationInfo instance representing account data across all the successfully</em>
<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> * consulted realms.</em>
<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">protected</strong> <a name="AuthenticationInfo" href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html#AuthenticationInfo">AuthenticationInfo</a> doMultiRealmAuthentication(Collection&lt;Realm&gt; realms, <a name="AuthenticationToken" href="../../../../../org/apache/shiro/authc/AuthenticationToken.html#AuthenticationToken">AuthenticationToken</a> token) {
<a class="jxr_linenumber" name="L199" href="#L199">199</a>
<a class="jxr_linenumber" name="L200" href="#L200">200</a> <a name="AuthenticationStrategy" href="../../../../../org/apache/shiro/authc/pam/AuthenticationStrategy.html#AuthenticationStrategy">AuthenticationStrategy</a> strategy = getAuthenticationStrategy();
<a class="jxr_linenumber" name="L201" href="#L201">201</a>
<a class="jxr_linenumber" name="L202" href="#L202">202</a> <a name="AuthenticationInfo" href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html#AuthenticationInfo">AuthenticationInfo</a> aggregate = strategy.beforeAllAttempts(realms, token);
<a class="jxr_linenumber" name="L203" href="#L203">203</a>
<a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) {
<a class="jxr_linenumber" name="L205" href="#L205">205</a> log.trace(<span class="jxr_string">"Iterating through {} realms for PAM authentication"</span>, realms.size());
<a class="jxr_linenumber" name="L206" href="#L206">206</a> }
<a class="jxr_linenumber" name="L207" href="#L207">207</a>
<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">for</strong> (<a name="Realm" href="../../../../../org/apache/shiro/realm/Realm.html#Realm">Realm</a> realm : realms) {
<a class="jxr_linenumber" name="L209" href="#L209">209</a>
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L211" href="#L211">211</a> aggregate = strategy.beforeAttempt(realm, token, aggregate);
<a class="jxr_linenumber" name="L212" href="#L212">212</a> } <strong class="jxr_keyword">catch</strong> (<a name="ShortCircuitIterationException" href="../../../../../org/apache/shiro/authc/pam/ShortCircuitIterationException.html#ShortCircuitIterationException">ShortCircuitIterationException</a> shortCircuitSignal) {
<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_comment">// Break from continuing with subsequnet realms on receiving </em>
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_comment">// short circuit signal from strategy</em>
<a class="jxr_linenumber" name="L215" href="#L215">215</a> <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="L216" href="#L216">216</a> }
<a class="jxr_linenumber" name="L217" href="#L217">217</a>
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">if</strong> (realm.supports(token)) {
<a class="jxr_linenumber" name="L219" href="#L219">219</a>
<a class="jxr_linenumber" name="L220" href="#L220">220</a> log.trace(<span class="jxr_string">"Attempting to authenticate token [{}] using realm [{}]"</span>, token, realm);
<a class="jxr_linenumber" name="L221" href="#L221">221</a>
<a class="jxr_linenumber" name="L222" href="#L222">222</a> <a name="AuthenticationInfo" href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html#AuthenticationInfo">AuthenticationInfo</a> info = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L223" href="#L223">223</a> Throwable t = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L225" href="#L225">225</a> info = realm.getAuthenticationInfo(token);
<a class="jxr_linenumber" name="L226" href="#L226">226</a> } <strong class="jxr_keyword">catch</strong> (Throwable throwable) {
<a class="jxr_linenumber" name="L227" href="#L227">227</a> t = throwable;
<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a class="jxr_linenumber" name="L229" href="#L229">229</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 class="jxr_linenumber" name="L230" href="#L230">230</a> log.debug(msg, t);
<a class="jxr_linenumber" name="L231" href="#L231">231</a> }
<a class="jxr_linenumber" name="L232" href="#L232">232</a> }
<a class="jxr_linenumber" name="L233" href="#L233">233</a>
<a class="jxr_linenumber" name="L234" href="#L234">234</a> aggregate = strategy.afterAttempt(realm, token, info, aggregate, t);
<a class="jxr_linenumber" name="L235" href="#L235">235</a>
<a class="jxr_linenumber" name="L236" href="#L236">236</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L237" href="#L237">237</a> log.debug(<span class="jxr_string">"Realm [{}] does not support token {}. Skipping realm."</span>, realm, token);
<a class="jxr_linenumber" name="L238" href="#L238">238</a> }
<a class="jxr_linenumber" name="L239" href="#L239">239</a> }
<a class="jxr_linenumber" name="L240" href="#L240">240</a>
<a class="jxr_linenumber" name="L241" href="#L241">241</a> aggregate = strategy.afterAllAttempts(token, aggregate);
<a class="jxr_linenumber" name="L242" href="#L242">242</a>
<a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">return</strong> aggregate;
<a class="jxr_linenumber" name="L244" href="#L244">244</a> }
<a class="jxr_linenumber" name="L245" href="#L245">245</a>
<a class="jxr_linenumber" name="L246" href="#L246">246</a>
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> * Attempts to authenticate the given token by iterating over the internal collection of</em>
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment"> * {@link Realm}s. For each realm, first the {@link Realm#supports(org.apache.shiro.authc.AuthenticationToken)}</em>
<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment"> * method will be called to determine if the realm supports the {@code authenticationToken} method argument.</em>
<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment"> * If a realm does support</em>
<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment"> * the token, its {@link Realm#getAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)}</em>
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment"> * method will be called. If the realm returns a non-null account, the token will be</em>
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * considered authenticated for that realm and the account data recorded. If the realm returns {@code null},</em>
<a class="jxr_linenumber" name="L256" href="#L256">256</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 class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> * an {@link AuthenticationException} will be thrown to indicate that the user could not be authenticated.</em>
<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> * After all realms have been consulted, the information from each realm is aggregated into a single</em>
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment"> * {@link AuthenticationInfo} object and returned.</em>
<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_javadoccomment"> * @param authenticationToken the token containing the authentication principal and credentials for the</em>
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> * user being authenticated.</em>
<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> * @return account information attributed to the authenticated user.</em>
<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> * @throws IllegalStateException if no realms have been configured at the time this method is invoked</em>
<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> * @throws AuthenticationException if the user could not be authenticated or the user is denied authentication</em>
<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> * for the given principal and credentials.</em>
<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong class="jxr_keyword">protected</strong> <a name="AuthenticationInfo" href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html#AuthenticationInfo">AuthenticationInfo</a> doAuthenticate(<a name="AuthenticationToken" href="../../../../../org/apache/shiro/authc/AuthenticationToken.html#AuthenticationToken">AuthenticationToken</a> authenticationToken) <strong class="jxr_keyword">throws</strong> <a name="AuthenticationException" href="../../../../../org/apache/shiro/authc/AuthenticationException.html#AuthenticationException">AuthenticationException</a> {
<a class="jxr_linenumber" name="L270" href="#L270">270</a> assertRealmsConfigured();
<a class="jxr_linenumber" name="L271" href="#L271">271</a> Collection&lt;Realm&gt; realms = getRealms();
<a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">if</strong> (realms.size() == 1) {
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">return</strong> doSingleRealmAuthentication(realms.iterator().next(), authenticationToken);
<a class="jxr_linenumber" name="L274" href="#L274">274</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">return</strong> doMultiRealmAuthentication(realms, authenticationToken);
<a class="jxr_linenumber" name="L276" href="#L276">276</a> }
<a class="jxr_linenumber" name="L277" href="#L277">277</a> }
<a class="jxr_linenumber" name="L278" href="#L278">278</a>
<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment"> * First calls &lt;code&gt;super.onLogout(principals)&lt;/code&gt; to ensure a logout notification is issued, and for each</em>
<a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_javadoccomment"> * wrapped {@code Realm} that implements the {@link LogoutAware LogoutAware} interface, calls</em>
<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_javadoccomment"> * &lt;code&gt;((LogoutAware)realm).onLogout(principals)&lt;/code&gt; to allow each realm the opportunity to perform</em>
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment"> * logout/cleanup operations during an user-logout.</em>
<a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> * Shiro's Realm implementations all implement the {@code LogoutAware} interface by default and can be</em>
<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> * overridden for realm-specific logout logic.</em>
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> * @param principals the application-specific Subject/user identifier.</em>
<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onLogout(<a name="PrincipalCollection" href="../../../../../org/apache/shiro/subject/PrincipalCollection.html#PrincipalCollection">PrincipalCollection</a> principals) {
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">super</strong>.onLogout(principals);
<a class="jxr_linenumber" name="L292" href="#L292">292</a> Collection&lt;Realm&gt; realms = getRealms();
<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(realms)) {
<a class="jxr_linenumber" name="L294" href="#L294">294</a> <strong class="jxr_keyword">for</strong> (<a name="Realm" href="../../../../../org/apache/shiro/realm/Realm.html#Realm">Realm</a> realm : realms) {
<a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">if</strong> (realm instanceof <a name="LogoutAware" href="../../../../../org/apache/shiro/authc/LogoutAware.html#LogoutAware">LogoutAware</a>) {
<a class="jxr_linenumber" name="L296" href="#L296">296</a> ((<a name="LogoutAware" href="../../../../../org/apache/shiro/authc/LogoutAware.html#LogoutAware">LogoutAware</a>) realm).onLogout(principals);
<a class="jxr_linenumber" name="L297" href="#L297">297</a> }
<a class="jxr_linenumber" name="L298" href="#L298">298</a> }
<a class="jxr_linenumber" name="L299" href="#L299">299</a> }
<a class="jxr_linenumber" name="L300" href="#L300">300</a> }
<a class="jxr_linenumber" name="L301" href="#L301">301</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>