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