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