| <!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>AuthenticatingRealm xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/shiro/realm/AuthenticatingRealm.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.realm; |
| <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.authc.credential.AllowAllCredentialsMatcher; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.credential.CredentialsMatcher; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.credential.SimpleCredentialsMatcher; |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.cache.Cache; |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.cache.CacheManager; |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.PrincipalCollection; |
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.CollectionUtils; |
| <a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.Initializable; |
| <a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; |
| <a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a name="32" href="#32">32</a> |
| <a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.atomic.AtomicInteger; |
| <a name="34" href="#34">34</a> |
| <a name="35" href="#35">35</a> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * A top-level abstract implementation of the <tt>Realm</tt> interface that only implements authentication support</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * (log-in) operations and leaves authorization (access control) behavior to subclasses.</em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * <h2>Authentication Caching</h2></em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * For applications that perform frequent repeated authentication of the same accounts (e.g. as is often done in</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * REST or Soap applications that authenticate on every request), it might be prudent to enable authentication</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * caching to alleviate constant load on any back-end data sources.</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * This feature is disabled by default to retain backwards-compatibility with Shiro 1.1 and earlier. It may be</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * enabled by setting {@link #setAuthenticationCachingEnabled(boolean) authenticationCachingEnabled} = {@code true}</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * (and configuring Shiro with a {@link CacheManager} of course), but <b>NOTE:</b></em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * <b>ONLY enable authentication caching if either of the following is true for your realm implementation:</b></em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * <li>The {@link #doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken) doGetAuthenticationInfo}</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * implementation returns {@code AuthenticationInfo} instances where the</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authc.AuthenticationInfo#getCredentials() credentials} are securely obfuscated and NOT</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * plaintext (raw) credentials. For example,</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * if your realm references accounts with passwords, that the {@code AuthenticationInfo}'s</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authc.AuthenticationInfo#getCredentials() credentials} are safely hashed and salted or otherwise</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * fully encrypted.<br/><br/></li></em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * <li>The {@link #doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken) doGetAuthenticationInfo}</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * implementation returns {@code AuthenticationInfo} instances where the</em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authc.AuthenticationInfo#getCredentials() credentials} are plaintext (raw) <b>AND</b> the</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * cache region storing the {@code AuthenticationInfo} instances WILL NOT overflow to disk and WILL NOT transmit cache</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * entries over an unprotected (non TLS/SSL) network (as might be the case with a networked/distributed enterprise cache).</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * This should be the case even in private/trusted/corporate networks.</li></em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * These points are very important because if authentication caching is enabled, this abstract class implementation</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * will place AuthenticationInfo instances returned from the subclass implementations directly into the cache, for</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * example:</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * cache.put(cacheKey, subclassAuthenticationInfoInstance);</em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * Enabling authentication caching is ONLY safe to do if the above two scenarios apply. It is NOT safe to enable under</em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * any other scenario.</em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * When possible, always represent and store credentials in a safe form (hash+salt or encrypted) to eliminate plaintext</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * visibility.</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * <h3>Authentication Cache Invalidation on Logout</h3></em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * If authentication caching is enabled, this implementation will attempt to evict (remove) cached authentication data</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * for an account during logout. This can only occur if the</em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * {@link #getAuthenticationCacheKey(org.apache.shiro.authc.AuthenticationToken)} and</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * {@link #getAuthenticationCacheKey(org.apache.shiro.subject.PrincipalCollection)} methods return the exact same value.</em> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * The default implementations of these methods expect that the</em> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authc.AuthenticationToken#getPrincipal()} (what the user submits during login) and</em> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * {@link #getAvailablePrincipal(org.apache.shiro.subject.PrincipalCollection) getAvailablePrincipal} (what is returned</em> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * by the realm after account lookup) return</em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * the same exact value. For example, the user submitted username is also the primary account identifier.</em> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * However, if your application uses, say, a username for end-user login, but returns a primary key ID as the</em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * primary principal after authentication, then you will need to override either</em> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * {@link #getAuthenticationCacheKey(org.apache.shiro.authc.AuthenticationToken) getAuthenticationCacheKey(token)} or</em> |
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * {@link #getAuthenticationCacheKey(org.apache.shiro.subject.PrincipalCollection) getAuthenticationCacheKey(principals)}</em> |
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * (or both) to ensure that the same cache key can be used for either object.</em> |
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * This guarantees that the same cache key used to cache the data during authentication (derived from the</em> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * {@code AuthenticationToken}) will be used to remove the cached data during logout (derived from the</em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * {@code PrincipalCollection}).</em> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * <h4>Unmatching Cache Key Values</h4></em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * If the return values from {@link #getAuthenticationCacheKey(org.apache.shiro.authc.AuthenticationToken)} and</em> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * {@link #getAuthenticationCacheKey(org.apache.shiro.subject.PrincipalCollection)} are not identical, cached</em> |
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * authentication data removal is at the mercy of your cache provider settings. For example, often cache</em> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * implementations will evict cache entries based on a timeToIdle or timeToLive (TTL) value.</em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * If this lazy eviction capability of the cache product is not sufficient and you want discrete behavior</em> |
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * (highly recommended for authentication data), ensure that the return values from those two methods are identical in</em> |
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * the subclass implementation.</em> |
| <a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * @since 0.2</em> |
| <a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="110" href="#110">110</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/shiro/realm/AuthenticatingRealm.html">AuthenticatingRealm</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/apache/shiro/realm/CachingRealm.html">CachingRealm</a> implements <a href="../../../../org/apache/shiro/util/Initializable.html">Initializable</a> { |
| <a name="111" href="#111">111</a> |
| <a name="112" href="#112">112</a> <em class="jxr_comment">//TODO - complete JavaDoc</em> |
| <a name="113" href="#113">113</a> |
| <a name="114" href="#114">114</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(AuthenticatingRealm.<strong class="jxr_keyword">class</strong>); |
| <a name="115" href="#115">115</a> |
| <a name="116" href="#116">116</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> AtomicInteger INSTANCE_COUNT = <strong class="jxr_keyword">new</strong> AtomicInteger(); |
| <a name="117" href="#117">117</a> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * The default suffix appended to the realm name used for caching authentication data.</em> |
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="123" href="#123">123</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_AUTHORIZATION_CACHE_SUFFIX = <span class="jxr_string">".authenticationCache"</span>; |
| <a name="124" href="#124">124</a> |
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * Credentials matcher used to determine if the provided credentials match the credentials stored in the data store.</em> |
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="128" href="#128">128</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/shiro/authc/credential/CredentialsMatcher.html">CredentialsMatcher</a> credentialsMatcher; |
| <a name="129" href="#129">129</a> |
| <a name="130" href="#130">130</a> |
| <a name="131" href="#131">131</a> <strong class="jxr_keyword">private</strong> Cache<Object, AuthenticationInfo> authenticationCache; |
| <a name="132" href="#132">132</a> |
| <a name="133" href="#133">133</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> authenticationCachingEnabled; |
| <a name="134" href="#134">134</a> <strong class="jxr_keyword">private</strong> String authenticationCacheName; |
| <a name="135" href="#135">135</a> |
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * The class that this realm supports for authentication tokens. This is used by the</em> |
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * default implementation of the {@link Realm#supports(org.apache.shiro.authc.AuthenticationToken)} method to</em> |
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * determine whether or not the given authentication token is supported by this realm.</em> |
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="141" href="#141">141</a> <strong class="jxr_keyword">private</strong> Class<? <strong class="jxr_keyword">extends</strong> AuthenticationToken> authenticationTokenClass; |
| <a name="142" href="#142">142</a> |
| <a name="143" href="#143">143</a> <em class="jxr_comment">/*<em class="jxr_comment">-------------------------------------------</em></em> |
| <a name="144" href="#144">144</a> <em class="jxr_comment"> | C O N S T R U C T O R S |</em> |
| <a name="145" href="#145">145</a> <em class="jxr_comment"> ============================================*/</em> |
| <a name="146" href="#146">146</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/realm/AuthenticatingRealm.html">AuthenticatingRealm</a>() { |
| <a name="147" href="#147">147</a> <strong class="jxr_keyword">this</strong>(<strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/shiro/authc/credential/SimpleCredentialsMatcher.html">SimpleCredentialsMatcher</a>()); |
| <a name="148" href="#148">148</a> } |
| <a name="149" href="#149">149</a> |
| <a name="150" href="#150">150</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/realm/AuthenticatingRealm.html">AuthenticatingRealm</a>(<a href="../../../../org/apache/shiro/cache/CacheManager.html">CacheManager</a> cacheManager) { |
| <a name="151" href="#151">151</a> <strong class="jxr_keyword">this</strong>(cacheManager, <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/shiro/authc/credential/SimpleCredentialsMatcher.html">SimpleCredentialsMatcher</a>()); |
| <a name="152" href="#152">152</a> } |
| <a name="153" href="#153">153</a> |
| <a name="154" href="#154">154</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/realm/AuthenticatingRealm.html">AuthenticatingRealm</a>(<a href="../../../../org/apache/shiro/authc/credential/CredentialsMatcher.html">CredentialsMatcher</a> matcher) { |
| <a name="155" href="#155">155</a> <strong class="jxr_keyword">this</strong>(<strong class="jxr_keyword">null</strong>, matcher); |
| <a name="156" href="#156">156</a> } |
| <a name="157" href="#157">157</a> |
| <a name="158" href="#158">158</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/realm/AuthenticatingRealm.html">AuthenticatingRealm</a>(<a href="../../../../org/apache/shiro/cache/CacheManager.html">CacheManager</a> cacheManager, <a href="../../../../org/apache/shiro/authc/credential/CredentialsMatcher.html">CredentialsMatcher</a> matcher) { |
| <a name="159" href="#159">159</a> authenticationTokenClass = UsernamePasswordToken.<strong class="jxr_keyword">class</strong>; |
| <a name="160" href="#160">160</a> |
| <a name="161" href="#161">161</a> <em class="jxr_comment">//retain backwards compatibility for Shiro 1.1 and earlier. Setting to true by default will probably cause</em> |
| <a name="162" href="#162">162</a> <em class="jxr_comment">//unexpected results for existing applications:</em> |
| <a name="163" href="#163">163</a> <strong class="jxr_keyword">this</strong>.authenticationCachingEnabled = false; |
| <a name="164" href="#164">164</a> |
| <a name="165" href="#165">165</a> <strong class="jxr_keyword">int</strong> instanceNumber = INSTANCE_COUNT.getAndIncrement(); |
| <a name="166" href="#166">166</a> <strong class="jxr_keyword">this</strong>.authenticationCacheName = getClass().getName() + DEFAULT_AUTHORIZATION_CACHE_SUFFIX; |
| <a name="167" href="#167">167</a> <strong class="jxr_keyword">if</strong> (instanceNumber > 0) { |
| <a name="168" href="#168">168</a> <strong class="jxr_keyword">this</strong>.authenticationCacheName = <strong class="jxr_keyword">this</strong>.authenticationCacheName + <span class="jxr_string">"."</span> + instanceNumber; |
| <a name="169" href="#169">169</a> } |
| <a name="170" href="#170">170</a> |
| <a name="171" href="#171">171</a> <strong class="jxr_keyword">if</strong> (cacheManager != <strong class="jxr_keyword">null</strong>) { |
| <a name="172" href="#172">172</a> setCacheManager(cacheManager); |
| <a name="173" href="#173">173</a> } |
| <a name="174" href="#174">174</a> <strong class="jxr_keyword">if</strong> (matcher != <strong class="jxr_keyword">null</strong>) { |
| <a name="175" href="#175">175</a> setCredentialsMatcher(matcher); |
| <a name="176" href="#176">176</a> } |
| <a name="177" href="#177">177</a> } |
| <a name="178" href="#178">178</a> |
| <a name="179" href="#179">179</a> <em class="jxr_comment">/*<em class="jxr_comment">--------------------------------------------</em></em> |
| <a name="180" href="#180">180</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="181" href="#181">181</a> <em class="jxr_comment"> ============================================*/</em> |
| <a name="182" href="#182">182</a> |
| <a name="183" href="#183">183</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="184" href="#184">184</a> <em class="jxr_javadoccomment"> * Returns the <code>CredentialsMatcher</code> used during an authentication attempt to verify submitted</em> |
| <a name="185" href="#185">185</a> <em class="jxr_javadoccomment"> * credentials with those stored in the system.</em> |
| <a name="186" href="#186">186</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * <p>Unless overridden by the {@link #setCredentialsMatcher setCredentialsMatcher} method, the default</em> |
| <a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> * value is a {@link org.apache.shiro.authc.credential.SimpleCredentialsMatcher SimpleCredentialsMatcher} instance.</em> |
| <a name="189" href="#189">189</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="190" href="#190">190</a> <em class="jxr_javadoccomment"> * @return the <code>CredentialsMatcher</code> used during an authentication attempt to verify submitted</em> |
| <a name="191" href="#191">191</a> <em class="jxr_javadoccomment"> * credentials with those stored in the system.</em> |
| <a name="192" href="#192">192</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="193" href="#193">193</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/authc/credential/CredentialsMatcher.html">CredentialsMatcher</a> getCredentialsMatcher() { |
| <a name="194" href="#194">194</a> <strong class="jxr_keyword">return</strong> credentialsMatcher; |
| <a name="195" href="#195">195</a> } |
| <a name="196" href="#196">196</a> |
| <a name="197" href="#197">197</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="198" href="#198">198</a> <em class="jxr_javadoccomment"> * Sets the CrendialsMatcher used during an authentication attempt to verify submitted credentials with those</em> |
| <a name="199" href="#199">199</a> <em class="jxr_javadoccomment"> * stored in the system. The implementation of this matcher can be switched via configuration to</em> |
| <a name="200" href="#200">200</a> <em class="jxr_javadoccomment"> * support any number of schemes, including plain text comparisons, hashing comparisons, and others.</em> |
| <a name="201" href="#201">201</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="202" href="#202">202</a> <em class="jxr_javadoccomment"> * <p>Unless overridden by this method, the default value is a</em> |
| <a name="203" href="#203">203</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authc.credential.SimpleCredentialsMatcher} instance.</em> |
| <a name="204" href="#204">204</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="205" href="#205">205</a> <em class="jxr_javadoccomment"> * @param credentialsMatcher the matcher to use.</em> |
| <a name="206" href="#206">206</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="207" href="#207">207</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setCredentialsMatcher(<a href="../../../../org/apache/shiro/authc/credential/CredentialsMatcher.html">CredentialsMatcher</a> credentialsMatcher) { |
| <a name="208" href="#208">208</a> <strong class="jxr_keyword">this</strong>.credentialsMatcher = credentialsMatcher; |
| <a name="209" href="#209">209</a> } |
| <a name="210" href="#210">210</a> |
| <a name="211" href="#211">211</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="212" href="#212">212</a> <em class="jxr_javadoccomment"> * Returns the authenticationToken class supported by this realm.</em> |
| <a name="213" href="#213">213</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="214" href="#214">214</a> <em class="jxr_javadoccomment"> * <p>The default value is <tt>{@link org.apache.shiro.authc.UsernamePasswordToken UsernamePasswordToken.class}</tt>, since</em> |
| <a name="215" href="#215">215</a> <em class="jxr_javadoccomment"> * about 90% of realms use username/password authentication, regardless of their protocol (e.g. over jdbc, ldap,</em> |
| <a name="216" href="#216">216</a> <em class="jxr_javadoccomment"> * kerberos, http, etc).</em> |
| <a name="217" href="#217">217</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="218" href="#218">218</a> <em class="jxr_javadoccomment"> * <p>If subclasses haven't already overridden the {@link Realm#supports Realm.supports(AuthenticationToken)} method,</em> |
| <a name="219" href="#219">219</a> <em class="jxr_javadoccomment"> * they must {@link #setAuthenticationTokenClass(Class) set a new class} if they won't support</em> |
| <a name="220" href="#220">220</a> <em class="jxr_javadoccomment"> * <tt>UsernamePasswordToken</tt> authentication token submissions.</em> |
| <a name="221" href="#221">221</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="222" href="#222">222</a> <em class="jxr_javadoccomment"> * @return the authenticationToken class supported by this realm.</em> |
| <a name="223" href="#223">223</a> <em class="jxr_javadoccomment"> * @see #setAuthenticationTokenClass</em> |
| <a name="224" href="#224">224</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="225" href="#225">225</a> <strong class="jxr_keyword">public</strong> Class getAuthenticationTokenClass() { |
| <a name="226" href="#226">226</a> <strong class="jxr_keyword">return</strong> authenticationTokenClass; |
| <a name="227" href="#227">227</a> } |
| <a name="228" href="#228">228</a> |
| <a name="229" href="#229">229</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * Sets the authenticationToken class supported by this realm.</em> |
| <a name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="232" href="#232">232</a> <em class="jxr_javadoccomment"> * <p>Unless overridden by this method, the default value is</em> |
| <a name="233" href="#233">233</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authc.UsernamePasswordToken UsernamePasswordToken.class} to support the majority of applications.</em> |
| <a name="234" href="#234">234</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="235" href="#235">235</a> <em class="jxr_javadoccomment"> * @param authenticationTokenClass the class of authentication token instances supported by this realm.</em> |
| <a name="236" href="#236">236</a> <em class="jxr_javadoccomment"> * @see #getAuthenticationTokenClass getAuthenticationTokenClass() for more explanation.</em> |
| <a name="237" href="#237">237</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="238" href="#238">238</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setAuthenticationTokenClass(Class<? <strong class="jxr_keyword">extends</strong> AuthenticationToken> authenticationTokenClass) { |
| <a name="239" href="#239">239</a> <strong class="jxr_keyword">this</strong>.authenticationTokenClass = authenticationTokenClass; |
| <a name="240" href="#240">240</a> } |
| <a name="241" href="#241">241</a> |
| <a name="242" href="#242">242</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="243" href="#243">243</a> <em class="jxr_javadoccomment"> * Sets an explicit {@link Cache} instance to use for authentication caching. If not set and authentication</em> |
| <a name="244" href="#244">244</a> <em class="jxr_javadoccomment"> * caching is {@link #isAuthenticationCachingEnabled() enabled}, any available</em> |
| <a name="245" href="#245">245</a> <em class="jxr_javadoccomment"> * {@link #getCacheManager() cacheManager} will be used to acquire the cache instance if available.</em> |
| <a name="246" href="#246">246</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="247" href="#247">247</a> <em class="jxr_javadoccomment"> * <b>WARNING:</b> Only set this property if safe caching conditions apply, as documented at the top</em> |
| <a name="248" href="#248">248</a> <em class="jxr_javadoccomment"> * of this page in the class-level JavaDoc.</em> |
| <a name="249" href="#249">249</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="250" href="#250">250</a> <em class="jxr_javadoccomment"> * @param authenticationCache an explicit {@link Cache} instance to use for authentication caching or</em> |
| <a name="251" href="#251">251</a> <em class="jxr_javadoccomment"> * {@code null} if the cache should possibly be obtained another way.</em> |
| <a name="252" href="#252">252</a> <em class="jxr_javadoccomment"> * @see #isAuthenticationCachingEnabled()</em> |
| <a name="253" href="#253">253</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="254" href="#254">254</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="255" href="#255">255</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setAuthenticationCache(Cache<Object, AuthenticationInfo> authenticationCache) { |
| <a name="256" href="#256">256</a> <strong class="jxr_keyword">this</strong>.authenticationCache = authenticationCache; |
| <a name="257" href="#257">257</a> } |
| <a name="258" href="#258">258</a> |
| <a name="259" href="#259">259</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="260" href="#260">260</a> <em class="jxr_javadoccomment"> * Returns a {@link Cache} instance to use for authentication caching, or {@code null} if no cache has been</em> |
| <a name="261" href="#261">261</a> <em class="jxr_javadoccomment"> * set.</em> |
| <a name="262" href="#262">262</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="263" href="#263">263</a> <em class="jxr_javadoccomment"> * @return a {@link Cache} instance to use for authentication caching, or {@code null} if no cache has been</em> |
| <a name="264" href="#264">264</a> <em class="jxr_javadoccomment"> * set.</em> |
| <a name="265" href="#265">265</a> <em class="jxr_javadoccomment"> * @see #setAuthenticationCache(org.apache.shiro.cache.Cache)</em> |
| <a name="266" href="#266">266</a> <em class="jxr_javadoccomment"> * @see #isAuthenticationCachingEnabled()</em> |
| <a name="267" href="#267">267</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="268" href="#268">268</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="269" href="#269">269</a> <strong class="jxr_keyword">public</strong> Cache<Object, AuthenticationInfo> getAuthenticationCache() { |
| <a name="270" href="#270">270</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.authenticationCache; |
| <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"> * Returns the name of a {@link Cache} to lookup from any available {@link #getCacheManager() cacheManager} if</em> |
| <a name="275" href="#275">275</a> <em class="jxr_javadoccomment"> * a cache is not explicitly configured via {@link #setAuthenticationCache(org.apache.shiro.cache.Cache)}.</em> |
| <a name="276" href="#276">276</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="277" href="#277">277</a> <em class="jxr_javadoccomment"> * This name will only be used to look up a cache if authentication caching is</em> |
| <a name="278" href="#278">278</a> <em class="jxr_javadoccomment"> * {@link #isAuthenticationCachingEnabled() enabled}.</em> |
| <a name="279" href="#279">279</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="280" href="#280">280</a> <em class="jxr_javadoccomment"> * <b>WARNING:</b> Only set this property if safe caching conditions apply, as documented at the top</em> |
| <a name="281" href="#281">281</a> <em class="jxr_javadoccomment"> * of this page in the class-level JavaDoc.</em> |
| <a name="282" href="#282">282</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="283" href="#283">283</a> <em class="jxr_javadoccomment"> * @return the name of a {@link Cache} to lookup from any available {@link #getCacheManager() cacheManager} if</em> |
| <a name="284" href="#284">284</a> <em class="jxr_javadoccomment"> * a cache is not explicitly configured via {@link #setAuthenticationCache(org.apache.shiro.cache.Cache)}.</em> |
| <a name="285" href="#285">285</a> <em class="jxr_javadoccomment"> * @see #isAuthenticationCachingEnabled()</em> |
| <a name="286" href="#286">286</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="287" href="#287">287</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="288" href="#288">288</a> <strong class="jxr_keyword">public</strong> String getAuthenticationCacheName() { |
| <a name="289" href="#289">289</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.authenticationCacheName; |
| <a name="290" href="#290">290</a> } |
| <a name="291" href="#291">291</a> |
| <a name="292" href="#292">292</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="293" href="#293">293</a> <em class="jxr_javadoccomment"> * Sets the name of a {@link Cache} to lookup from any available {@link #getCacheManager() cacheManager} if</em> |
| <a name="294" href="#294">294</a> <em class="jxr_javadoccomment"> * a cache is not explicitly configured via {@link #setAuthenticationCache(org.apache.shiro.cache.Cache)}.</em> |
| <a name="295" href="#295">295</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="296" href="#296">296</a> <em class="jxr_javadoccomment"> * This name will only be used to look up a cache if authentication caching is</em> |
| <a name="297" href="#297">297</a> <em class="jxr_javadoccomment"> * {@link #isAuthenticationCachingEnabled() enabled}.</em> |
| <a name="298" href="#298">298</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="299" href="#299">299</a> <em class="jxr_javadoccomment"> * @param authenticationCacheName the name of a {@link Cache} to lookup from any available</em> |
| <a name="300" href="#300">300</a> <em class="jxr_javadoccomment"> * {@link #getCacheManager() cacheManager} if a cache is not explicitly configured</em> |
| <a name="301" href="#301">301</a> <em class="jxr_javadoccomment"> * via {@link #setAuthenticationCache(org.apache.shiro.cache.Cache)}.</em> |
| <a name="302" href="#302">302</a> <em class="jxr_javadoccomment"> * @see #isAuthenticationCachingEnabled()</em> |
| <a name="303" href="#303">303</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="304" href="#304">304</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="305" href="#305">305</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setAuthenticationCacheName(String authenticationCacheName) { |
| <a name="306" href="#306">306</a> <strong class="jxr_keyword">this</strong>.authenticationCacheName = authenticationCacheName; |
| <a name="307" href="#307">307</a> } |
| <a name="308" href="#308">308</a> |
| <a name="309" href="#309">309</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="310" href="#310">310</a> <em class="jxr_javadoccomment"> * Returns {@code true} if authentication caching should be utilized if a {@link CacheManager} has been</em> |
| <a name="311" href="#311">311</a> <em class="jxr_javadoccomment"> * {@link #setCacheManager(org.apache.shiro.cache.CacheManager) configured}, {@code false} otherwise.</em> |
| <a name="312" href="#312">312</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="313" href="#313">313</a> <em class="jxr_javadoccomment"> * The default value is {@code true}.</em> |
| <a name="314" href="#314">314</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="315" href="#315">315</a> <em class="jxr_javadoccomment"> * @return {@code true} if authentication caching should be utilized, {@code false} otherwise.</em> |
| <a name="316" href="#316">316</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="317" href="#317">317</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isAuthenticationCachingEnabled() { |
| <a name="318" href="#318">318</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.authenticationCachingEnabled && isCachingEnabled(); |
| <a name="319" href="#319">319</a> } |
| <a name="320" href="#320">320</a> |
| <a name="321" href="#321">321</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="322" href="#322">322</a> <em class="jxr_javadoccomment"> * Sets whether or not authentication caching should be utilized if a {@link CacheManager} has been</em> |
| <a name="323" href="#323">323</a> <em class="jxr_javadoccomment"> * {@link #setCacheManager(org.apache.shiro.cache.CacheManager) configured}, {@code false} otherwise.</em> |
| <a name="324" href="#324">324</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="325" href="#325">325</a> <em class="jxr_javadoccomment"> * The default value is {@code false} to retain backwards compatibility with Shiro 1.1 and earlier.</em> |
| <a name="326" href="#326">326</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="327" href="#327">327</a> <em class="jxr_javadoccomment"> * <b>WARNING:</b> Only set this property to {@code true} if safe caching conditions apply, as documented at the top</em> |
| <a name="328" href="#328">328</a> <em class="jxr_javadoccomment"> * of this page in the class-level JavaDoc.</em> |
| <a name="329" href="#329">329</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="330" href="#330">330</a> <em class="jxr_javadoccomment"> * @param authenticationCachingEnabled the value to set</em> |
| <a name="331" href="#331">331</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="332" href="#332">332</a> @SuppressWarnings({<span class="jxr_string">"UnusedDeclaration"</span>}) |
| <a name="333" href="#333">333</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setAuthenticationCachingEnabled(<strong class="jxr_keyword">boolean</strong> authenticationCachingEnabled) { |
| <a name="334" href="#334">334</a> <strong class="jxr_keyword">this</strong>.authenticationCachingEnabled = authenticationCachingEnabled; |
| <a name="335" href="#335">335</a> <strong class="jxr_keyword">if</strong> (authenticationCachingEnabled) { |
| <a name="336" href="#336">336</a> setCachingEnabled(<strong class="jxr_keyword">true</strong>); |
| <a name="337" href="#337">337</a> } |
| <a name="338" href="#338">338</a> } |
| <a name="339" href="#339">339</a> |
| <a name="340" href="#340">340</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setName(String name) { |
| <a name="341" href="#341">341</a> <strong class="jxr_keyword">super</strong>.setName(name); |
| <a name="342" href="#342">342</a> String authcCacheName = <strong class="jxr_keyword">this</strong>.authenticationCacheName; |
| <a name="343" href="#343">343</a> <strong class="jxr_keyword">if</strong> (authcCacheName != <strong class="jxr_keyword">null</strong> && authcCacheName.startsWith(getClass().getName())) { |
| <a name="344" href="#344">344</a> <em class="jxr_comment">//get rid of the default heuristically-created cache name. Create a more meaningful one</em> |
| <a name="345" href="#345">345</a> <em class="jxr_comment">//based on the application-unique Realm name:</em> |
| <a name="346" href="#346">346</a> <strong class="jxr_keyword">this</strong>.authenticationCacheName = name + DEFAULT_AUTHORIZATION_CACHE_SUFFIX; |
| <a name="347" href="#347">347</a> } |
| <a name="348" href="#348">348</a> } |
| <a name="349" href="#349">349</a> |
| <a name="350" href="#350">350</a> |
| <a name="351" href="#351">351</a> <em class="jxr_comment">/*<em class="jxr_comment">--------------------------------------------</em></em> |
| <a name="352" href="#352">352</a> <em class="jxr_comment"> | M E T H O D S |</em> |
| <a name="353" href="#353">353</a> <em class="jxr_comment"> ============================================*/</em> |
| <a name="354" href="#354">354</a> |
| <a name="355" href="#355">355</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="356" href="#356">356</a> <em class="jxr_javadoccomment"> * Convenience implementation that returns</em> |
| <a name="357" href="#357">357</a> <em class="jxr_javadoccomment"> * <tt>getAuthenticationTokenClass().isAssignableFrom( token.getClass() );</tt>. Can be overridden</em> |
| <a name="358" href="#358">358</a> <em class="jxr_javadoccomment"> * by subclasses for more complex token checking.</em> |
| <a name="359" href="#359">359</a> <em class="jxr_javadoccomment"> * <p>Most configurations will only need to set a different class via</em> |
| <a name="360" href="#360">360</a> <em class="jxr_javadoccomment"> * {@link #setAuthenticationTokenClass}, as opposed to overriding this method.</em> |
| <a name="361" href="#361">361</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="362" href="#362">362</a> <em class="jxr_javadoccomment"> * @param token the token being submitted for authentication.</em> |
| <a name="363" href="#363">363</a> <em class="jxr_javadoccomment"> * @return true if this authentication realm can process the submitted token instance of the class, false otherwise.</em> |
| <a name="364" href="#364">364</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="365" href="#365">365</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> supports(<a href="../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token) { |
| <a name="366" href="#366">366</a> <strong class="jxr_keyword">return</strong> token != <strong class="jxr_keyword">null</strong> && getAuthenticationTokenClass().isAssignableFrom(token.getClass()); |
| <a name="367" href="#367">367</a> } |
| <a name="368" href="#368">368</a> |
| <a name="369" href="#369">369</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="370" href="#370">370</a> <em class="jxr_javadoccomment"> * Initializes this realm and potentially enables an authentication cache, depending on configuration. Based on</em> |
| <a name="371" href="#371">371</a> <em class="jxr_javadoccomment"> * the availability of an authentication cache, this class functions as follows:</em> |
| <a name="372" href="#372">372</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a name="373" href="#373">373</a> <em class="jxr_javadoccomment"> * <li>If the {@link #setAuthenticationCache cache} property has been set, it will be</em> |
| <a name="374" href="#374">374</a> <em class="jxr_javadoccomment"> * used to cache the AuthenticationInfo objects returned from {@link #getAuthenticationInfo}</em> |
| <a name="375" href="#375">375</a> <em class="jxr_javadoccomment"> * method invocations.</em> |
| <a name="376" href="#376">376</a> <em class="jxr_javadoccomment"> * All future calls to {@link #getAuthenticationInfo} will attempt to use this cache first</em> |
| <a name="377" href="#377">377</a> <em class="jxr_javadoccomment"> * to alleviate any potentially unnecessary calls to an underlying data store.</li></em> |
| <a name="378" href="#378">378</a> <em class="jxr_javadoccomment"> * <li>If the {@link #setAuthenticationCache cache} property has <b>not</b> been set,</em> |
| <a name="379" href="#379">379</a> <em class="jxr_javadoccomment"> * the {@link #setCacheManager cacheManager} property will be checked.</em> |
| <a name="380" href="#380">380</a> <em class="jxr_javadoccomment"> * If a {@code cacheManager} has been set, it will be used to eagerly acquire an authentication</em> |
| <a name="381" href="#381">381</a> <em class="jxr_javadoccomment"> * {@code cache}, and this cache which will be used as specified in #1.</li></em> |
| <a name="382" href="#382">382</a> <em class="jxr_javadoccomment"> * <li>If neither the {@link #setAuthenticationCache (org.apache.shiro.cache.Cache) authenticationCache}</em> |
| <a name="383" href="#383">383</a> <em class="jxr_javadoccomment"> * or {@link #setCacheManager(org.apache.shiro.cache.CacheManager) cacheManager}</em> |
| <a name="384" href="#384">384</a> <em class="jxr_javadoccomment"> * properties are set, caching will not be utilized and authentication look-ups will be delegated to</em> |
| <a name="385" href="#385">385</a> <em class="jxr_javadoccomment"> * subclass implementations for each authentication attempt.</li></em> |
| <a name="386" href="#386">386</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a name="387" href="#387">387</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="388" href="#388">388</a> <em class="jxr_javadoccomment"> * This method finishes by calling {@link #onInit()} is to allow subclasses to perform any init behavior desired.</em> |
| <a name="389" href="#389">389</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="390" href="#390">390</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="391" href="#391">391</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="392" href="#392">392</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> init() { |
| <a name="393" href="#393">393</a> <em class="jxr_comment">//trigger obtaining the authorization cache if possible</em> |
| <a name="394" href="#394">394</a> getAvailableAuthenticationCache(); |
| <a name="395" href="#395">395</a> onInit(); |
| <a name="396" href="#396">396</a> } |
| <a name="397" href="#397">397</a> |
| <a name="398" href="#398">398</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="399" href="#399">399</a> <em class="jxr_javadoccomment"> * Template method for subclasses to implement any initialization logic. Called from</em> |
| <a name="400" href="#400">400</a> <em class="jxr_javadoccomment"> * {@link #init()}.</em> |
| <a name="401" href="#401">401</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="402" href="#402">402</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="403" href="#403">403</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="404" href="#404">404</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> onInit() { |
| <a name="405" href="#405">405</a> } |
| <a name="406" href="#406">406</a> |
| <a name="407" href="#407">407</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="408" href="#408">408</a> <em class="jxr_javadoccomment"> * This implementation attempts to acquire an authentication cache if one is not already configured.</em> |
| <a name="409" href="#409">409</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="410" href="#410">410</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="411" href="#411">411</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="412" href="#412">412</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> afterCacheManagerSet() { |
| <a name="413" href="#413">413</a> <em class="jxr_comment">//trigger obtaining the authorization cache if possible</em> |
| <a name="414" href="#414">414</a> getAvailableAuthenticationCache(); |
| <a name="415" href="#415">415</a> } |
| <a name="416" href="#416">416</a> |
| <a name="417" href="#417">417</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="418" href="#418">418</a> <em class="jxr_javadoccomment"> * Returns any available {@link Cache} instance to use for authentication caching. This functions as follows:</em> |
| <a name="419" href="#419">419</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a name="420" href="#420">420</a> <em class="jxr_javadoccomment"> * <li>If an {@link #setAuthenticationCache(org.apache.shiro.cache.Cache) authenticationCache} has been explicitly</em> |
| <a name="421" href="#421">421</a> <em class="jxr_javadoccomment"> * configured (it is not null), it is returned.</li></em> |
| <a name="422" href="#422">422</a> <em class="jxr_javadoccomment"> * <li>If there is no {@link #getAuthenticationCache() authenticationCache} configured:</em> |
| <a name="423" href="#423">423</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a name="424" href="#424">424</a> <em class="jxr_javadoccomment"> * <li>If authentication caching is {@link #isAuthenticationCachingEnabled() enabled}, any available</em> |
| <a name="425" href="#425">425</a> <em class="jxr_javadoccomment"> * {@link #getCacheManager() cacheManager} will be consulted to obtain an available authentication cache.</em> |
| <a name="426" href="#426">426</a> <em class="jxr_javadoccomment"> * </li></em> |
| <a name="427" href="#427">427</a> <em class="jxr_javadoccomment"> * <li>If authentication caching is disabled, this implementation does nothing.</li></em> |
| <a name="428" href="#428">428</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a name="429" href="#429">429</a> <em class="jxr_javadoccomment"> * </li></em> |
| <a name="430" href="#430">430</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a name="431" href="#431">431</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="432" href="#432">432</a> <em class="jxr_javadoccomment"> * @return any available {@link Cache} instance to use for authentication caching.</em> |
| <a name="433" href="#433">433</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="434" href="#434">434</a> <strong class="jxr_keyword">private</strong> Cache<Object, AuthenticationInfo> getAvailableAuthenticationCache() { |
| <a name="435" href="#435">435</a> Cache<Object, AuthenticationInfo> cache = getAuthenticationCache(); |
| <a name="436" href="#436">436</a> <strong class="jxr_keyword">boolean</strong> authcCachingEnabled = isAuthenticationCachingEnabled(); |
| <a name="437" href="#437">437</a> <strong class="jxr_keyword">if</strong> (cache == <strong class="jxr_keyword">null</strong> && authcCachingEnabled) { |
| <a name="438" href="#438">438</a> cache = getAuthenticationCacheLazy(); |
| <a name="439" href="#439">439</a> } |
| <a name="440" href="#440">440</a> <strong class="jxr_keyword">return</strong> cache; |
| <a name="441" href="#441">441</a> } |
| <a name="442" href="#442">442</a> |
| <a name="443" href="#443">443</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="444" href="#444">444</a> <em class="jxr_javadoccomment"> * Checks to see if the authenticationCache class attribute is null, and if so, attempts to acquire one from</em> |
| <a name="445" href="#445">445</a> <em class="jxr_javadoccomment"> * any configured {@link #getCacheManager() cacheManager}. If one is acquired, it is set as the class attribute.</em> |
| <a name="446" href="#446">446</a> <em class="jxr_javadoccomment"> * The class attribute is then returned.</em> |
| <a name="447" href="#447">447</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="448" href="#448">448</a> <em class="jxr_javadoccomment"> * @return an available cache instance to be used for authentication caching or {@code null} if one is not available.</em> |
| <a name="449" href="#449">449</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="450" href="#450">450</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="451" href="#451">451</a> <strong class="jxr_keyword">private</strong> Cache<Object, AuthenticationInfo> getAuthenticationCacheLazy() { |
| <a name="452" href="#452">452</a> |
| <a name="453" href="#453">453</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.authenticationCache == <strong class="jxr_keyword">null</strong>) { |
| <a name="454" href="#454">454</a> |
| <a name="455" href="#455">455</a> log.trace(<span class="jxr_string">"No authenticationCache instance set. Checking for a cacheManager..."</span>); |
| <a name="456" href="#456">456</a> |
| <a name="457" href="#457">457</a> <a href="../../../../org/apache/shiro/cache/CacheManager.html">CacheManager</a> cacheManager = getCacheManager(); |
| <a name="458" href="#458">458</a> |
| <a name="459" href="#459">459</a> <strong class="jxr_keyword">if</strong> (cacheManager != <strong class="jxr_keyword">null</strong>) { |
| <a name="460" href="#460">460</a> String cacheName = getAuthenticationCacheName(); |
| <a name="461" href="#461">461</a> log.debug(<span class="jxr_string">"CacheManager [{}] configured. Building authentication cache '{}'"</span>, cacheManager, cacheName); |
| <a name="462" href="#462">462</a> <strong class="jxr_keyword">this</strong>.authenticationCache = cacheManager.getCache(cacheName); |
| <a name="463" href="#463">463</a> } |
| <a name="464" href="#464">464</a> } |
| <a name="465" href="#465">465</a> |
| <a name="466" href="#466">466</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.authenticationCache; |
| <a name="467" href="#467">467</a> } |
| <a name="468" href="#468">468</a> |
| <a name="469" href="#469">469</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="470" href="#470">470</a> <em class="jxr_javadoccomment"> * Returns any cached AuthenticationInfo corresponding to the specified token or {@code null} if there currently</em> |
| <a name="471" href="#471">471</a> <em class="jxr_javadoccomment"> * isn't any cached data.</em> |
| <a name="472" href="#472">472</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="473" href="#473">473</a> <em class="jxr_javadoccomment"> * @param token the token submitted during the authentication attempt.</em> |
| <a name="474" href="#474">474</a> <em class="jxr_javadoccomment"> * @return any cached AuthenticationInfo corresponding to the specified token or {@code null} if there currently</em> |
| <a name="475" href="#475">475</a> <em class="jxr_javadoccomment"> * isn't any cached data.</em> |
| <a name="476" href="#476">476</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="477" href="#477">477</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="478" href="#478">478</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> getCachedAuthenticationInfo(<a href="../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token) { |
| <a name="479" href="#479">479</a> <a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> info = <strong class="jxr_keyword">null</strong>; |
| <a name="480" href="#480">480</a> |
| <a name="481" href="#481">481</a> Cache<Object, AuthenticationInfo> cache = getAvailableAuthenticationCache(); |
| <a name="482" href="#482">482</a> <strong class="jxr_keyword">if</strong> (cache != <strong class="jxr_keyword">null</strong> && token != <strong class="jxr_keyword">null</strong>) { |
| <a name="483" href="#483">483</a> log.trace(<span class="jxr_string">"Attempting to retrieve the AuthenticationInfo from cache."</span>); |
| <a name="484" href="#484">484</a> Object key = getAuthenticationCacheKey(token); |
| <a name="485" href="#485">485</a> info = cache.get(key); |
| <a name="486" href="#486">486</a> <strong class="jxr_keyword">if</strong> (info == <strong class="jxr_keyword">null</strong>) { |
| <a name="487" href="#487">487</a> log.trace(<span class="jxr_string">"No AuthorizationInfo found in cache for key [{}]"</span>, key); |
| <a name="488" href="#488">488</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="489" href="#489">489</a> log.trace(<span class="jxr_string">"Found cached AuthorizationInfo for key [{}]"</span>, key); |
| <a name="490" href="#490">490</a> } |
| <a name="491" href="#491">491</a> } |
| <a name="492" href="#492">492</a> |
| <a name="493" href="#493">493</a> <strong class="jxr_keyword">return</strong> info; |
| <a name="494" href="#494">494</a> } |
| <a name="495" href="#495">495</a> |
| <a name="496" href="#496">496</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="497" href="#497">497</a> <em class="jxr_javadoccomment"> * Caches the specified info if authentication caching</em> |
| <a name="498" href="#498">498</a> <em class="jxr_javadoccomment"> * {@link #isAuthenticationCachingEnabled(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo) isEnabled}</em> |
| <a name="499" href="#499">499</a> <em class="jxr_javadoccomment"> * for the specific token/info pair and a cache instance is available to be used.</em> |
| <a name="500" href="#500">500</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="501" href="#501">501</a> <em class="jxr_javadoccomment"> * @param token the authentication token submitted which resulted in a successful authentication attempt.</em> |
| <a name="502" href="#502">502</a> <em class="jxr_javadoccomment"> * @param info the AuthenticationInfo to cache as a result of the successful authentication attempt.</em> |
| <a name="503" href="#503">503</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="504" href="#504">504</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="505" href="#505">505</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> cacheAuthenticationInfoIfPossible(<a href="../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token, <a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> info) { |
| <a name="506" href="#506">506</a> <strong class="jxr_keyword">if</strong> (!isAuthenticationCachingEnabled(token, info)) { |
| <a name="507" href="#507">507</a> log.debug(<span class="jxr_string">"AuthenticationInfo caching is disabled for info [{}]. Submitted token: [{}]."</span>, info, token); |
| <a name="508" href="#508">508</a> <em class="jxr_comment">//return quietly, caching is disabled for this token/info pair:</em> |
| <a name="509" href="#509">509</a> <strong class="jxr_keyword">return</strong>; |
| <a name="510" href="#510">510</a> } |
| <a name="511" href="#511">511</a> |
| <a name="512" href="#512">512</a> Cache<Object, AuthenticationInfo> cache = getAvailableAuthenticationCache(); |
| <a name="513" href="#513">513</a> <strong class="jxr_keyword">if</strong> (cache != <strong class="jxr_keyword">null</strong>) { |
| <a name="514" href="#514">514</a> Object key = getAuthenticationCacheKey(token); |
| <a name="515" href="#515">515</a> cache.put(key, info); |
| <a name="516" href="#516">516</a> log.trace(<span class="jxr_string">"Cached AuthenticationInfo for continued authentication. key=[{}], value=[{}]."</span>, key, info); |
| <a name="517" href="#517">517</a> } |
| <a name="518" href="#518">518</a> } |
| <a name="519" href="#519">519</a> |
| <a name="520" href="#520">520</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="521" href="#521">521</a> <em class="jxr_javadoccomment"> * Returns {@code true} if authentication caching should be utilized based on the specified</em> |
| <a name="522" href="#522">522</a> <em class="jxr_javadoccomment"> * {@link AuthenticationToken} and/or {@link AuthenticationInfo}, {@code false} otherwise.</em> |
| <a name="523" href="#523">523</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="524" href="#524">524</a> <em class="jxr_javadoccomment"> * The default implementation simply delegates to {@link #isAuthenticationCachingEnabled()}, the general-case</em> |
| <a name="525" href="#525">525</a> <em class="jxr_javadoccomment"> * authentication caching setting. Subclasses can override this to turn on or off caching at runtime</em> |
| <a name="526" href="#526">526</a> <em class="jxr_javadoccomment"> * based on the specific submitted runtime values.</em> |
| <a name="527" href="#527">527</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="528" href="#528">528</a> <em class="jxr_javadoccomment"> * @param token the submitted authentication token</em> |
| <a name="529" href="#529">529</a> <em class="jxr_javadoccomment"> * @param info the {@code AuthenticationInfo} acquired from data source lookup via</em> |
| <a name="530" href="#530">530</a> <em class="jxr_javadoccomment"> * {@link #doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)}</em> |
| <a name="531" href="#531">531</a> <em class="jxr_javadoccomment"> * @return {@code true} if authentication caching should be utilized based on the specified</em> |
| <a name="532" href="#532">532</a> <em class="jxr_javadoccomment"> * {@link AuthenticationToken} and/or {@link AuthenticationInfo}, {@code false} otherwise.</em> |
| <a name="533" href="#533">533</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="534" href="#534">534</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="535" href="#535">535</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isAuthenticationCachingEnabled(<a href="../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token, <a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> info) { |
| <a name="536" href="#536">536</a> <strong class="jxr_keyword">return</strong> isAuthenticationCachingEnabled(); |
| <a name="537" href="#537">537</a> } |
| <a name="538" href="#538">538</a> |
| <a name="539" href="#539">539</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="540" href="#540">540</a> <em class="jxr_javadoccomment"> * This implementation functions as follows:</em> |
| <a name="541" href="#541">541</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a name="542" href="#542">542</a> <em class="jxr_javadoccomment"> * <li>It attempts to acquire any cached {@link AuthenticationInfo} corresponding to the specified</em> |
| <a name="543" href="#543">543</a> <em class="jxr_javadoccomment"> * {@link AuthenticationToken} argument. If a cached value is found, it will be used for credentials matching,</em> |
| <a name="544" href="#544">544</a> <em class="jxr_javadoccomment"> * alleviating the need to perform any lookups with a data source.</li></em> |
| <a name="545" href="#545">545</a> <em class="jxr_javadoccomment"> * <li>If there is no cached {@link AuthenticationInfo} found, delegate to the</em> |
| <a name="546" href="#546">546</a> <em class="jxr_javadoccomment"> * {@link #doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)} method to perform the actual</em> |
| <a name="547" href="#547">547</a> <em class="jxr_javadoccomment"> * lookup. If authentication caching is enabled and possible, any returned info object will be</em> |
| <a name="548" href="#548">548</a> <em class="jxr_javadoccomment"> * {@link #cacheAuthenticationInfoIfPossible(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo) cached}</em> |
| <a name="549" href="#549">549</a> <em class="jxr_javadoccomment"> * to be used in future authentication attempts.</li></em> |
| <a name="550" href="#550">550</a> <em class="jxr_javadoccomment"> * <li>If an AuthenticationInfo instance is not found in the cache or by lookup, {@code null} is returned to</em> |
| <a name="551" href="#551">551</a> <em class="jxr_javadoccomment"> * indicate an account cannot be found.</li></em> |
| <a name="552" href="#552">552</a> <em class="jxr_javadoccomment"> * <li>If an AuthenticationInfo instance is found (either cached or via lookup), ensure the submitted</em> |
| <a name="553" href="#553">553</a> <em class="jxr_javadoccomment"> * AuthenticationToken's credentials match the expected {@code AuthenticationInfo}'s credentials using the</em> |
| <a name="554" href="#554">554</a> <em class="jxr_javadoccomment"> * {@link #getCredentialsMatcher() credentialsMatcher}. This means that credentials are always verified</em> |
| <a name="555" href="#555">555</a> <em class="jxr_javadoccomment"> * for an authentication attempt.</li></em> |
| <a name="556" href="#556">556</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a name="557" href="#557">557</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="558" href="#558">558</a> <em class="jxr_javadoccomment"> * @param token the submitted account principal and credentials.</em> |
| <a name="559" href="#559">559</a> <em class="jxr_javadoccomment"> * @return the AuthenticationInfo corresponding to the given {@code token}, or {@code null} if no</em> |
| <a name="560" href="#560">560</a> <em class="jxr_javadoccomment"> * AuthenticationInfo could be found.</em> |
| <a name="561" href="#561">561</a> <em class="jxr_javadoccomment"> * @throws AuthenticationException if authentication failed.</em> |
| <a name="562" href="#562">562</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="563" href="#563">563</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> getAuthenticationInfo(<a href="../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token) <strong class="jxr_keyword">throws</strong> AuthenticationException { |
| <a name="564" href="#564">564</a> |
| <a name="565" href="#565">565</a> <a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> info = getCachedAuthenticationInfo(token); |
| <a name="566" href="#566">566</a> <strong class="jxr_keyword">if</strong> (info == <strong class="jxr_keyword">null</strong>) { |
| <a name="567" href="#567">567</a> <em class="jxr_comment">//otherwise not cached, perform the lookup:</em> |
| <a name="568" href="#568">568</a> info = doGetAuthenticationInfo(token); |
| <a name="569" href="#569">569</a> log.debug(<span class="jxr_string">"Looked up AuthenticationInfo [{}] from doGetAuthenticationInfo"</span>, info); |
| <a name="570" href="#570">570</a> <strong class="jxr_keyword">if</strong> (token != <strong class="jxr_keyword">null</strong> && info != <strong class="jxr_keyword">null</strong>) { |
| <a name="571" href="#571">571</a> cacheAuthenticationInfoIfPossible(token, info); |
| <a name="572" href="#572">572</a> } |
| <a name="573" href="#573">573</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="574" href="#574">574</a> log.debug(<span class="jxr_string">"Using cached authentication info [{}] to perform credentials matching."</span>, info); |
| <a name="575" href="#575">575</a> } |
| <a name="576" href="#576">576</a> |
| <a name="577" href="#577">577</a> <strong class="jxr_keyword">if</strong> (info != <strong class="jxr_keyword">null</strong>) { |
| <a name="578" href="#578">578</a> assertCredentialsMatch(token, info); |
| <a name="579" href="#579">579</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="580" href="#580">580</a> log.debug(<span class="jxr_string">"No AuthenticationInfo found for submitted AuthenticationToken [{}]. Returning null."</span>, token); |
| <a name="581" href="#581">581</a> } |
| <a name="582" href="#582">582</a> |
| <a name="583" href="#583">583</a> <strong class="jxr_keyword">return</strong> info; |
| <a name="584" href="#584">584</a> } |
| <a name="585" href="#585">585</a> |
| <a name="586" href="#586">586</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="587" href="#587">587</a> <em class="jxr_javadoccomment"> * Asserts that the submitted {@code AuthenticationToken}'s credentials match the stored account</em> |
| <a name="588" href="#588">588</a> <em class="jxr_javadoccomment"> * {@code AuthenticationInfo}'s credentials, and if not, throws an {@link AuthenticationException}.</em> |
| <a name="589" href="#589">589</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="590" href="#590">590</a> <em class="jxr_javadoccomment"> * @param token the submitted authentication token</em> |
| <a name="591" href="#591">591</a> <em class="jxr_javadoccomment"> * @param info the AuthenticationInfo corresponding to the given {@code token}</em> |
| <a name="592" href="#592">592</a> <em class="jxr_javadoccomment"> * @throws AuthenticationException if the token's credentials do not match the stored account credentials.</em> |
| <a name="593" href="#593">593</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="594" href="#594">594</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> assertCredentialsMatch(<a href="../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token, <a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> info) <strong class="jxr_keyword">throws</strong> AuthenticationException { |
| <a name="595" href="#595">595</a> <a href="../../../../org/apache/shiro/authc/credential/CredentialsMatcher.html">CredentialsMatcher</a> cm = getCredentialsMatcher(); |
| <a name="596" href="#596">596</a> <strong class="jxr_keyword">if</strong> (cm != <strong class="jxr_keyword">null</strong>) { |
| <a name="597" href="#597">597</a> <strong class="jxr_keyword">if</strong> (!cm.doCredentialsMatch(token, info)) { |
| <a name="598" href="#598">598</a> <em class="jxr_comment">//not successful - throw an exception to indicate this:</em> |
| <a name="599" href="#599">599</a> String msg = <span class="jxr_string">"Submitted credentials for token ["</span> + token + <span class="jxr_string">"] did not match the expected credentials."</span>; |
| <a name="600" href="#600">600</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/shiro/authc/IncorrectCredentialsException.html">IncorrectCredentialsException</a>(msg); |
| <a name="601" href="#601">601</a> } |
| <a name="602" href="#602">602</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="603" href="#603">603</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/shiro/authc/AuthenticationException.html">AuthenticationException</a>(<span class="jxr_string">"A CredentialsMatcher must be configured in order to verify "</span> + |
| <a name="604" href="#604">604</a> <span class="jxr_string">"credentials during authentication. If you do not wish for credentials to be examined, you "</span> + |
| <a name="605" href="#605">605</a> <span class="jxr_string">"can configure an "</span> + AllowAllCredentialsMatcher.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">" instance."</span>); |
| <a name="606" href="#606">606</a> } |
| <a name="607" href="#607">607</a> } |
| <a name="608" href="#608">608</a> |
| <a name="609" href="#609">609</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="610" href="#610">610</a> <em class="jxr_javadoccomment"> * Returns the key under which {@link AuthenticationInfo} instances are cached if authentication caching is enabled.</em> |
| <a name="611" href="#611">611</a> <em class="jxr_javadoccomment"> * This implementation defaults to returning the token's</em> |
| <a name="612" href="#612">612</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authc.AuthenticationToken#getPrincipal() principal}, which is usually a username in</em> |
| <a name="613" href="#613">613</a> <em class="jxr_javadoccomment"> * most applications.</em> |
| <a name="614" href="#614">614</a> <em class="jxr_javadoccomment"> * <h3>Cache Invalidation on Logout</h3></em> |
| <a name="615" href="#615">615</a> <em class="jxr_javadoccomment"> * <b>NOTE:</b> If you want to be able to invalidate an account's cached {@code AuthenticationInfo} on logout, you</em> |
| <a name="616" href="#616">616</a> <em class="jxr_javadoccomment"> * must ensure the {@link #getAuthenticationCacheKey(org.apache.shiro.subject.PrincipalCollection)} method returns</em> |
| <a name="617" href="#617">617</a> <em class="jxr_javadoccomment"> * the same value as this method.</em> |
| <a name="618" href="#618">618</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="619" href="#619">619</a> <em class="jxr_javadoccomment"> * @param token the authentication token for which any successful authentication will be cached.</em> |
| <a name="620" href="#620">620</a> <em class="jxr_javadoccomment"> * @return the cache key to use to cache the associated {@link AuthenticationInfo} after a successful authentication.</em> |
| <a name="621" href="#621">621</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="622" href="#622">622</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="623" href="#623">623</a> <strong class="jxr_keyword">protected</strong> Object getAuthenticationCacheKey(<a href="../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token) { |
| <a name="624" href="#624">624</a> <strong class="jxr_keyword">return</strong> token != <strong class="jxr_keyword">null</strong> ? token.getPrincipal() : <strong class="jxr_keyword">null</strong>; |
| <a name="625" href="#625">625</a> } |
| <a name="626" href="#626">626</a> |
| <a name="627" href="#627">627</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="628" href="#628">628</a> <em class="jxr_javadoccomment"> * Returns the key under which {@link AuthenticationInfo} instances are cached if authentication caching is enabled.</em> |
| <a name="629" href="#629">629</a> <em class="jxr_javadoccomment"> * This implementation delegates to</em> |
| <a name="630" href="#630">630</a> <em class="jxr_javadoccomment"> * {@link #getAvailablePrincipal(org.apache.shiro.subject.PrincipalCollection)}, which returns the primary principal</em> |
| <a name="631" href="#631">631</a> <em class="jxr_javadoccomment"> * associated with this particular Realm.</em> |
| <a name="632" href="#632">632</a> <em class="jxr_javadoccomment"> * <h3>Cache Invalidation on Logout</h3></em> |
| <a name="633" href="#633">633</a> <em class="jxr_javadoccomment"> * <b>NOTE:</b> If you want to be able to invalidate an account's cached {@code AuthenticationInfo} on logout, you</em> |
| <a name="634" href="#634">634</a> <em class="jxr_javadoccomment"> * must ensure that this method returns the same value as the</em> |
| <a name="635" href="#635">635</a> <em class="jxr_javadoccomment"> * {@link #getAuthenticationCacheKey(org.apache.shiro.authc.AuthenticationToken)} method!</em> |
| <a name="636" href="#636">636</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="637" href="#637">637</a> <em class="jxr_javadoccomment"> * @param principals the principals of the account for which to set or remove cached {@code AuthenticationInfo}.</em> |
| <a name="638" href="#638">638</a> <em class="jxr_javadoccomment"> * @return the cache key to use when looking up cached {@link AuthenticationInfo} instances.</em> |
| <a name="639" href="#639">639</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="640" href="#640">640</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="641" href="#641">641</a> <strong class="jxr_keyword">protected</strong> Object getAuthenticationCacheKey(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals) { |
| <a name="642" href="#642">642</a> <strong class="jxr_keyword">return</strong> getAvailablePrincipal(principals); |
| <a name="643" href="#643">643</a> } |
| <a name="644" href="#644">644</a> |
| <a name="645" href="#645">645</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="646" href="#646">646</a> <em class="jxr_javadoccomment"> * This implementation clears out any cached authentication data by calling</em> |
| <a name="647" href="#647">647</a> <em class="jxr_javadoccomment"> * {@link #clearCachedAuthenticationInfo(org.apache.shiro.subject.PrincipalCollection)}.</em> |
| <a name="648" href="#648">648</a> <em class="jxr_javadoccomment"> * If overriding in a subclass, be sure to call {@code super.doClearCache} to ensure this behavior is maintained.</em> |
| <a name="649" href="#649">649</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="650" href="#650">650</a> <em class="jxr_javadoccomment"> * @param principals principals the principals of the account for which to clear any cached data.</em> |
| <a name="651" href="#651">651</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="652" href="#652">652</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="653" href="#653">653</a> @Override |
| <a name="654" href="#654">654</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> doClearCache(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals) { |
| <a name="655" href="#655">655</a> <strong class="jxr_keyword">super</strong>.doClearCache(principals); |
| <a name="656" href="#656">656</a> clearCachedAuthenticationInfo(principals); |
| <a name="657" href="#657">657</a> } |
| <a name="658" href="#658">658</a> |
| <a name="659" href="#659">659</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="660" href="#660">660</a> <em class="jxr_javadoccomment"> * Clears out the AuthenticationInfo cache entry for the specified account.</em> |
| <a name="661" href="#661">661</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="662" href="#662">662</a> <em class="jxr_javadoccomment"> * This method is provided as a convenience to subclasses so they can invalidate a cache entry when they</em> |
| <a name="663" href="#663">663</a> <em class="jxr_javadoccomment"> * change an account's authentication data (e.g. reset password) during runtime. Because an account's</em> |
| <a name="664" href="#664">664</a> <em class="jxr_javadoccomment"> * AuthenticationInfo can be cached, there needs to be a way to invalidate the cache for only that account so that</em> |
| <a name="665" href="#665">665</a> <em class="jxr_javadoccomment"> * subsequent authentication operations don't used the (old) cached value if account data changes.</em> |
| <a name="666" href="#666">666</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="667" href="#667">667</a> <em class="jxr_javadoccomment"> * After this method is called, the next authentication for that same account will result in a call to</em> |
| <a name="668" href="#668">668</a> <em class="jxr_javadoccomment"> * {@link #doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken) doGetAuthenticationInfo}, and the</em> |
| <a name="669" href="#669">669</a> <em class="jxr_javadoccomment"> * resulting return value will be cached before being returned so it can be reused for later authentications.</em> |
| <a name="670" href="#670">670</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="671" href="#671">671</a> <em class="jxr_javadoccomment"> * If you wish to clear out all associated cached data (and not just authentication data), use the</em> |
| <a name="672" href="#672">672</a> <em class="jxr_javadoccomment"> * {@link #clearCache(org.apache.shiro.subject.PrincipalCollection)} method instead (which will in turn call this</em> |
| <a name="673" href="#673">673</a> <em class="jxr_javadoccomment"> * method by default).</em> |
| <a name="674" href="#674">674</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="675" href="#675">675</a> <em class="jxr_javadoccomment"> * @param principals the principals of the account for which to clear the cached AuthorizationInfo.</em> |
| <a name="676" href="#676">676</a> <em class="jxr_javadoccomment"> * @see #clearCache(org.apache.shiro.subject.PrincipalCollection)</em> |
| <a name="677" href="#677">677</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="678" href="#678">678</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="679" href="#679">679</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> clearCachedAuthenticationInfo(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals) { |
| <a name="680" href="#680">680</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(principals)) { |
| <a name="681" href="#681">681</a> Cache<Object, AuthenticationInfo> cache = getAvailableAuthenticationCache(); |
| <a name="682" href="#682">682</a> <em class="jxr_comment">//cache instance will be non-null if caching is enabled:</em> |
| <a name="683" href="#683">683</a> <strong class="jxr_keyword">if</strong> (cache != <strong class="jxr_keyword">null</strong>) { |
| <a name="684" href="#684">684</a> Object key = getAuthenticationCacheKey(principals); |
| <a name="685" href="#685">685</a> cache.remove(key); |
| <a name="686" href="#686">686</a> } |
| <a name="687" href="#687">687</a> } |
| <a name="688" href="#688">688</a> } |
| <a name="689" href="#689">689</a> |
| <a name="690" href="#690">690</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="691" href="#691">691</a> <em class="jxr_javadoccomment"> * Retrieves authentication data from an implementation-specific datasource (RDBMS, LDAP, etc) for the given</em> |
| <a name="692" href="#692">692</a> <em class="jxr_javadoccomment"> * authentication token.</em> |
| <a name="693" href="#693">693</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="694" href="#694">694</a> <em class="jxr_javadoccomment"> * For most datasources, this means just 'pulling' authentication data for an associated subject/user and nothing</em> |
| <a name="695" href="#695">695</a> <em class="jxr_javadoccomment"> * more and letting Shiro do the rest. But in some systems, this method could actually perform EIS specific</em> |
| <a name="696" href="#696">696</a> <em class="jxr_javadoccomment"> * log-in logic in addition to just retrieving data - it is up to the Realm implementation.</em> |
| <a name="697" href="#697">697</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="698" href="#698">698</a> <em class="jxr_javadoccomment"> * A {@code null} return value means that no account could be associated with the specified token.</em> |
| <a name="699" href="#699">699</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="700" href="#700">700</a> <em class="jxr_javadoccomment"> * @param token the authentication token containing the user's principal and credentials.</em> |
| <a name="701" href="#701">701</a> <em class="jxr_javadoccomment"> * @return an {@link AuthenticationInfo} object containing account data resulting from the</em> |
| <a name="702" href="#702">702</a> <em class="jxr_javadoccomment"> * authentication ONLY if the lookup is successful (i.e. account exists and is valid, etc.)</em> |
| <a name="703" href="#703">703</a> <em class="jxr_javadoccomment"> * @throws AuthenticationException if there is an error acquiring data or performing</em> |
| <a name="704" href="#704">704</a> <em class="jxr_javadoccomment"> * realm-specific authentication logic for the specified <tt>token</tt></em> |
| <a name="705" href="#705">705</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="706" href="#706">706</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> doGetAuthenticationInfo(<a href="../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token) <strong class="jxr_keyword">throws</strong> AuthenticationException; |
| <a name="707" href="#707">707</a> |
| <a name="708" href="#708">708</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
