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