| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <main role="main"> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span><a id="line.1">/*</a> |
| <span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> *</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> */</a> |
| <span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.realm;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.authc.LogoutAware;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.cache.CacheManager;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.cache.CacheManagerAware;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import org.apache.shiro.subject.PrincipalCollection;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import org.apache.shiro.util.CollectionUtils;</a> |
| <span class="sourceLineNo">026</span><a id="line.26">import org.apache.shiro.util.Nameable;</a> |
| <span class="sourceLineNo">027</span><a id="line.27">import org.slf4j.Logger;</a> |
| <span class="sourceLineNo">028</span><a id="line.28">import org.slf4j.LoggerFactory;</a> |
| <span class="sourceLineNo">029</span><a id="line.29"></a> |
| <span class="sourceLineNo">030</span><a id="line.30">import java.util.Collection;</a> |
| <span class="sourceLineNo">031</span><a id="line.31">import java.util.concurrent.atomic.AtomicInteger;</a> |
| <span class="sourceLineNo">032</span><a id="line.32"></a> |
| <span class="sourceLineNo">033</span><a id="line.33"></a> |
| <span class="sourceLineNo">034</span><a id="line.34">/**</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * A very basic abstract extension point for the {@link Realm} interface that provides caching support for subclasses.</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * <p/></a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * It also provides a convenience method,</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * {@link #getAvailablePrincipal(org.apache.shiro.subject.PrincipalCollection)}, which is useful across all</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * realm subclasses for obtaining a realm-specific principal/identity.</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * <p/></a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * All actual Realm method implementations are left to subclasses.</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> *</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * @see #clearCache(org.apache.shiro.subject.PrincipalCollection)</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * @see #onLogout(org.apache.shiro.subject.PrincipalCollection)</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * @see #getAvailablePrincipal(org.apache.shiro.subject.PrincipalCollection)</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * @since 0.9</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> */</a> |
| <span class="sourceLineNo">048</span><a id="line.48">public abstract class CachingRealm implements Realm, Nameable, CacheManagerAware, LogoutAware {</a> |
| <span class="sourceLineNo">049</span><a id="line.49"></a> |
| <span class="sourceLineNo">050</span><a id="line.50"> private static final Logger log = LoggerFactory.getLogger(CachingRealm.class);</a> |
| <span class="sourceLineNo">051</span><a id="line.51"></a> |
| <span class="sourceLineNo">052</span><a id="line.52"> //TODO - complete JavaDoc</a> |
| <span class="sourceLineNo">053</span><a id="line.53"></a> |
| <span class="sourceLineNo">054</span><a id="line.54"> private static final AtomicInteger INSTANCE_COUNT = new AtomicInteger();</a> |
| <span class="sourceLineNo">055</span><a id="line.55"></a> |
| <span class="sourceLineNo">056</span><a id="line.56"> /*--------------------------------------------</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> | I N S T A N C E V A R I A B L E S |</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> ============================================*/</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> private String name;</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> private boolean cachingEnabled;</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> private CacheManager cacheManager;</a> |
| <span class="sourceLineNo">062</span><a id="line.62"></a> |
| <span class="sourceLineNo">063</span><a id="line.63"> /**</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> * Default no-argument constructor that defaults</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> * {@link #isCachingEnabled() cachingEnabled} (for general caching) to {@code true} and sets a</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> * default {@link #getName() name} based on the class name.</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> * <p/></a> |
| <span class="sourceLineNo">068</span><a id="line.68"> * Note that while in general, caching may be enabled by default, subclasses have control over</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> * if specific caching is enabled.</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> */</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> public CachingRealm() {</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> this.cachingEnabled = true;</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> this.name = getClass().getName() + "_" + INSTANCE_COUNT.getAndIncrement();</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> }</a> |
| <span class="sourceLineNo">075</span><a id="line.75"></a> |
| <span class="sourceLineNo">076</span><a id="line.76"> /**</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> * Returns the <tt>CacheManager</tt> used for data caching to reduce EIS round trips, or <tt>null</tt> if</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> * caching is disabled.</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> *</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> * @return the <tt>CacheManager</tt> used for data caching to reduce EIS round trips, or <tt>null</tt> if</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> * caching is disabled.</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> */</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> public CacheManager getCacheManager() {</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> return this.cacheManager;</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> }</a> |
| <span class="sourceLineNo">086</span><a id="line.86"></a> |
| <span class="sourceLineNo">087</span><a id="line.87"> /**</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> * Sets the <tt>CacheManager</tt> to be used for data caching to reduce EIS round trips.</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> * <p/></a> |
| <span class="sourceLineNo">090</span><a id="line.90"> * This property is <tt>null</tt> by default, indicating that caching is turned off.</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> *</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> * @param cacheManager the <tt>CacheManager</tt> to use for data caching, or <tt>null</tt> to disable caching.</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> */</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> public void setCacheManager(CacheManager cacheManager) {</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> this.cacheManager = cacheManager;</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> afterCacheManagerSet();</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> }</a> |
| <span class="sourceLineNo">098</span><a id="line.98"></a> |
| <span class="sourceLineNo">099</span><a id="line.99"> /**</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> * Returns {@code true} if caching should be used if a {@link CacheManager} has been</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> * {@link #setCacheManager(org.apache.shiro.cache.CacheManager) configured}, {@code false} otherwise.</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> * <p/></a> |
| <span class="sourceLineNo">103</span><a id="line.103"> * The default value is {@code true} since the large majority of Realms will benefit from caching if a CacheManager</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> * has been configured. However, memory-only realms should set this value to {@code false} since they would</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> * manage account data in memory already lookups would already be as efficient as possible.</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> *</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> * @return {@code true} if caching will be globally enabled if a {@link CacheManager} has been</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> * configured, {@code false} otherwise</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> */</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> public boolean isCachingEnabled() {</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> return cachingEnabled;</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> }</a> |
| <span class="sourceLineNo">113</span><a id="line.113"></a> |
| <span class="sourceLineNo">114</span><a id="line.114"> /**</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> * Sets whether or not caching should be used if a {@link CacheManager} has been</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> * {@link #setCacheManager(org.apache.shiro.cache.CacheManager) configured}.</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> *</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> * @param cachingEnabled whether or not to globally enable caching for this realm.</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> */</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> public void setCachingEnabled(boolean cachingEnabled) {</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> this.cachingEnabled = cachingEnabled;</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> }</a> |
| <span class="sourceLineNo">123</span><a id="line.123"></a> |
| <span class="sourceLineNo">124</span><a id="line.124"> public String getName() {</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> return name;</a> |
| <span class="sourceLineNo">126</span><a id="line.126"> }</a> |
| <span class="sourceLineNo">127</span><a id="line.127"></a> |
| <span class="sourceLineNo">128</span><a id="line.128"> public void setName(String name) {</a> |
| <span class="sourceLineNo">129</span><a id="line.129"> this.name = name;</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> }</a> |
| <span class="sourceLineNo">131</span><a id="line.131"></a> |
| <span class="sourceLineNo">132</span><a id="line.132"> /**</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> * Template method that may be implemented by subclasses should they wish to react to a</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> * {@link CacheManager} instance being set on the realm instance via the</a> |
| <span class="sourceLineNo">135</span><a id="line.135"> * {@link #setCacheManager(org.apache.shiro.cache.CacheManager)} mutator.</a> |
| <span class="sourceLineNo">136</span><a id="line.136"> */</a> |
| <span class="sourceLineNo">137</span><a id="line.137"> protected void afterCacheManagerSet() {</a> |
| <span class="sourceLineNo">138</span><a id="line.138"> }</a> |
| <span class="sourceLineNo">139</span><a id="line.139"></a> |
| <span class="sourceLineNo">140</span><a id="line.140"> /**</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> * If caching is enabled, this will clear any cached data associated with the specified account identity.</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> * Subclasses are free to override for additional behavior, but be sure to call {@code super.onLogout} first.</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> * <p/></a> |
| <span class="sourceLineNo">144</span><a id="line.144"> * This default implementation merely calls {@link #clearCache(org.apache.shiro.subject.PrincipalCollection)}.</a> |
| <span class="sourceLineNo">145</span><a id="line.145"> *</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> * @param principals the application-specific Subject/user identifier that is logging out.</a> |
| <span class="sourceLineNo">147</span><a id="line.147"> * @see #clearCache(org.apache.shiro.subject.PrincipalCollection)</a> |
| <span class="sourceLineNo">148</span><a id="line.148"> * @see #getAvailablePrincipal(org.apache.shiro.subject.PrincipalCollection)</a> |
| <span class="sourceLineNo">149</span><a id="line.149"> * @since 1.2</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> */</a> |
| <span class="sourceLineNo">151</span><a id="line.151"> public void onLogout(PrincipalCollection principals) {</a> |
| <span class="sourceLineNo">152</span><a id="line.152"> clearCache(principals);</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> }</a> |
| <span class="sourceLineNo">154</span><a id="line.154"></a> |
| <span class="sourceLineNo">155</span><a id="line.155"> private static boolean isEmpty(PrincipalCollection pc) {</a> |
| <span class="sourceLineNo">156</span><a id="line.156"> return pc == null || pc.isEmpty();</a> |
| <span class="sourceLineNo">157</span><a id="line.157"> }</a> |
| <span class="sourceLineNo">158</span><a id="line.158"></a> |
| <span class="sourceLineNo">159</span><a id="line.159"> /**</a> |
| <span class="sourceLineNo">160</span><a id="line.160"> * Clears out any cached data associated with the specified account identity/identities.</a> |
| <span class="sourceLineNo">161</span><a id="line.161"> * <p/></a> |
| <span class="sourceLineNo">162</span><a id="line.162"> * This implementation will return quietly if the principals argument is null or empty. Otherwise it delegates</a> |
| <span class="sourceLineNo">163</span><a id="line.163"> * to {@link #doClearCache(org.apache.shiro.subject.PrincipalCollection)}.</a> |
| <span class="sourceLineNo">164</span><a id="line.164"> *</a> |
| <span class="sourceLineNo">165</span><a id="line.165"> * @param principals the principals of the account for which to clear any cached data.</a> |
| <span class="sourceLineNo">166</span><a id="line.166"> * @since 1.2</a> |
| <span class="sourceLineNo">167</span><a id="line.167"> */</a> |
| <span class="sourceLineNo">168</span><a id="line.168"> protected void clearCache(PrincipalCollection principals) {</a> |
| <span class="sourceLineNo">169</span><a id="line.169"> if (!isEmpty(principals)) {</a> |
| <span class="sourceLineNo">170</span><a id="line.170"> doClearCache(principals);</a> |
| <span class="sourceLineNo">171</span><a id="line.171"> log.trace("Cleared cache entries for account with principals [{}]", principals);</a> |
| <span class="sourceLineNo">172</span><a id="line.172"> }</a> |
| <span class="sourceLineNo">173</span><a id="line.173"> }</a> |
| <span class="sourceLineNo">174</span><a id="line.174"></a> |
| <span class="sourceLineNo">175</span><a id="line.175"> /**</a> |
| <span class="sourceLineNo">176</span><a id="line.176"> * This implementation does nothing - it is a template to be overridden by subclasses if necessary.</a> |
| <span class="sourceLineNo">177</span><a id="line.177"> *</a> |
| <span class="sourceLineNo">178</span><a id="line.178"> * @param principals principals the principals of the account for which to clear any cached data.</a> |
| <span class="sourceLineNo">179</span><a id="line.179"> * @since 1.2</a> |
| <span class="sourceLineNo">180</span><a id="line.180"> */</a> |
| <span class="sourceLineNo">181</span><a id="line.181"> protected void doClearCache(PrincipalCollection principals) {</a> |
| <span class="sourceLineNo">182</span><a id="line.182"> }</a> |
| <span class="sourceLineNo">183</span><a id="line.183"></a> |
| <span class="sourceLineNo">184</span><a id="line.184"> /**</a> |
| <span class="sourceLineNo">185</span><a id="line.185"> * A utility method for subclasses that returns the first available principal of interest to this particular realm.</a> |
| <span class="sourceLineNo">186</span><a id="line.186"> * The heuristic used to acquire the principal is as follows:</a> |
| <span class="sourceLineNo">187</span><a id="line.187"> * <ul></a> |
| <span class="sourceLineNo">188</span><a id="line.188"> * <li>Attempt to get <em>this particular Realm's</em> 'primary' principal in the {@code PrincipalCollection} via a</a> |
| <span class="sourceLineNo">189</span><a id="line.189"> * <code>principals.{@link PrincipalCollection#fromRealm(String) fromRealm}({@link #getName() getName()})</code></a> |
| <span class="sourceLineNo">190</span><a id="line.190"> * call.</li></a> |
| <span class="sourceLineNo">191</span><a id="line.191"> * <li>If the previous call does not result in any principals, attempt to get the overall 'primary' principal</a> |
| <span class="sourceLineNo">192</span><a id="line.192"> * from the PrincipalCollection via {@link org.apache.shiro.subject.PrincipalCollection#getPrimaryPrincipal()}.</li></a> |
| <span class="sourceLineNo">193</span><a id="line.193"> * <li>If there are no principals from that call (or the PrincipalCollection argument was null to begin with),</a> |
| <span class="sourceLineNo">194</span><a id="line.194"> * return {@code null}</li></a> |
| <span class="sourceLineNo">195</span><a id="line.195"> * </ul></a> |
| <span class="sourceLineNo">196</span><a id="line.196"> *</a> |
| <span class="sourceLineNo">197</span><a id="line.197"> * @param principals the PrincipalCollection holding all principals (from all realms) associated with a single Subject.</a> |
| <span class="sourceLineNo">198</span><a id="line.198"> * @return the 'primary' principal attributed to this particular realm, or the fallback 'master' principal if it</a> |
| <span class="sourceLineNo">199</span><a id="line.199"> * exists, or if not {@code null}.</a> |
| <span class="sourceLineNo">200</span><a id="line.200"> * @since 1.2</a> |
| <span class="sourceLineNo">201</span><a id="line.201"> */</a> |
| <span class="sourceLineNo">202</span><a id="line.202"> protected Object getAvailablePrincipal(PrincipalCollection principals) {</a> |
| <span class="sourceLineNo">203</span><a id="line.203"> Object primary = null;</a> |
| <span class="sourceLineNo">204</span><a id="line.204"> if (!isEmpty(principals)) {</a> |
| <span class="sourceLineNo">205</span><a id="line.205"> Collection thisPrincipals = principals.fromRealm(getName());</a> |
| <span class="sourceLineNo">206</span><a id="line.206"> if (!CollectionUtils.isEmpty(thisPrincipals)) {</a> |
| <span class="sourceLineNo">207</span><a id="line.207"> primary = thisPrincipals.iterator().next();</a> |
| <span class="sourceLineNo">208</span><a id="line.208"> } else {</a> |
| <span class="sourceLineNo">209</span><a id="line.209"> //no principals attributed to this particular realm. Fall back to the 'master' primary:</a> |
| <span class="sourceLineNo">210</span><a id="line.210"> primary = principals.getPrimaryPrincipal();</a> |
| <span class="sourceLineNo">211</span><a id="line.211"> }</a> |
| <span class="sourceLineNo">212</span><a id="line.212"> }</a> |
| <span class="sourceLineNo">213</span><a id="line.213"></a> |
| <span class="sourceLineNo">214</span><a id="line.214"> return primary;</a> |
| <span class="sourceLineNo">215</span><a id="line.215"> }</a> |
| <span class="sourceLineNo">216</span><a id="line.216">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
