| <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.credential.CredentialsMatcher;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.authz.*;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.shiro.authz.permission.*;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.apache.shiro.cache.Cache;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.apache.shiro.cache.CacheManager;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import org.apache.shiro.subject.PrincipalCollection;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import org.apache.shiro.util.CollectionUtils;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import org.apache.shiro.util.Initializable;<a name="line.28"></a> |
| <FONT color="green">029</FONT> import org.slf4j.Logger;<a name="line.29"></a> |
| <FONT color="green">030</FONT> import org.slf4j.LoggerFactory;<a name="line.30"></a> |
| <FONT color="green">031</FONT> <a name="line.31"></a> |
| <FONT color="green">032</FONT> import java.util.*;<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> * An {@code AuthorizingRealm} extends the {@code AuthenticatingRealm}'s capabilities by adding Authorization<a name="line.37"></a> |
| <FONT color="green">038</FONT> * (access control) support.<a name="line.38"></a> |
| <FONT color="green">039</FONT> * <p/><a name="line.39"></a> |
| <FONT color="green">040</FONT> * This implementation will perform all role and permission checks automatically (and subclasses do not have to<a name="line.40"></a> |
| <FONT color="green">041</FONT> * write this logic) as long as the<a name="line.41"></a> |
| <FONT color="green">042</FONT> * {@link #getAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection)} method returns an<a name="line.42"></a> |
| <FONT color="green">043</FONT> * {@link AuthorizationInfo}. Please see that method's JavaDoc for an in-depth explanation.<a name="line.43"></a> |
| <FONT color="green">044</FONT> * <p/><a name="line.44"></a> |
| <FONT color="green">045</FONT> * If you find that you do not want to utilize the {@link AuthorizationInfo AuthorizationInfo} construct,<a name="line.45"></a> |
| <FONT color="green">046</FONT> * you are of course free to subclass the {@link AuthenticatingRealm AuthenticatingRealm} directly instead and<a name="line.46"></a> |
| <FONT color="green">047</FONT> * implement the remaining Realm interface methods directly. You might do this if you want have better control<a name="line.47"></a> |
| <FONT color="green">048</FONT> * over how the Role and Permission checks occur for your specific data source. However, using AuthorizationInfo<a name="line.48"></a> |
| <FONT color="green">049</FONT> * (and its default implementation {@link org.apache.shiro.authz.SimpleAuthorizationInfo SimpleAuthorizationInfo}) is sufficient in the large<a name="line.49"></a> |
| <FONT color="green">050</FONT> * majority of Realm cases.<a name="line.50"></a> |
| <FONT color="green">051</FONT> *<a name="line.51"></a> |
| <FONT color="green">052</FONT> * @see org.apache.shiro.authz.SimpleAuthorizationInfo<a name="line.52"></a> |
| <FONT color="green">053</FONT> * @since 0.2<a name="line.53"></a> |
| <FONT color="green">054</FONT> */<a name="line.54"></a> |
| <FONT color="green">055</FONT> public abstract class AuthorizingRealm extends AuthenticatingRealm<a name="line.55"></a> |
| <FONT color="green">056</FONT> implements Authorizer, Initializable, PermissionResolverAware, RolePermissionResolverAware {<a name="line.56"></a> |
| <FONT color="green">057</FONT> <a name="line.57"></a> |
| <FONT color="green">058</FONT> //TODO - complete JavaDoc<a name="line.58"></a> |
| <FONT color="green">059</FONT> <a name="line.59"></a> |
| <FONT color="green">060</FONT> /*-------------------------------------------<a name="line.60"></a> |
| <FONT color="green">061</FONT> | C O N S T A N T S |<a name="line.61"></a> |
| <FONT color="green">062</FONT> ============================================*/<a name="line.62"></a> |
| <FONT color="green">063</FONT> private static final Logger log = LoggerFactory.getLogger(AuthorizingRealm.class);<a name="line.63"></a> |
| <FONT color="green">064</FONT> <a name="line.64"></a> |
| <FONT color="green">065</FONT> /**<a name="line.65"></a> |
| <FONT color="green">066</FONT> * The default suffix appended to the realm name for caching AuthorizationInfo instances.<a name="line.66"></a> |
| <FONT color="green">067</FONT> */<a name="line.67"></a> |
| <FONT color="green">068</FONT> private static final String DEFAULT_AUTHORIZATION_CACHE_SUFFIX = ".authorizationCache";<a name="line.68"></a> |
| <FONT color="green">069</FONT> <a name="line.69"></a> |
| <FONT color="green">070</FONT> private static final AtomicInteger INSTANCE_COUNT = new AtomicInteger();<a name="line.70"></a> |
| <FONT color="green">071</FONT> <a name="line.71"></a> |
| <FONT color="green">072</FONT> /*-------------------------------------------<a name="line.72"></a> |
| <FONT color="green">073</FONT> | I N S T A N C E V A R I A B L E S |<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> * The cache used by this realm to store AuthorizationInfo instances associated with individual Subject principals.<a name="line.76"></a> |
| <FONT color="green">077</FONT> */<a name="line.77"></a> |
| <FONT color="green">078</FONT> private boolean authorizationCachingEnabled;<a name="line.78"></a> |
| <FONT color="green">079</FONT> private Cache<Object, AuthorizationInfo> authorizationCache;<a name="line.79"></a> |
| <FONT color="green">080</FONT> private String authorizationCacheName;<a name="line.80"></a> |
| <FONT color="green">081</FONT> <a name="line.81"></a> |
| <FONT color="green">082</FONT> private PermissionResolver permissionResolver;<a name="line.82"></a> |
| <FONT color="green">083</FONT> <a name="line.83"></a> |
| <FONT color="green">084</FONT> private RolePermissionResolver permissionRoleResolver;<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> | C O N S T R U C T O R S |<a name="line.87"></a> |
| <FONT color="green">088</FONT> ============================================*/<a name="line.88"></a> |
| <FONT color="green">089</FONT> <a name="line.89"></a> |
| <FONT color="green">090</FONT> public AuthorizingRealm() {<a name="line.90"></a> |
| <FONT color="green">091</FONT> this(null, null);<a name="line.91"></a> |
| <FONT color="green">092</FONT> }<a name="line.92"></a> |
| <FONT color="green">093</FONT> <a name="line.93"></a> |
| <FONT color="green">094</FONT> public AuthorizingRealm(CacheManager cacheManager) {<a name="line.94"></a> |
| <FONT color="green">095</FONT> this(cacheManager, null);<a name="line.95"></a> |
| <FONT color="green">096</FONT> }<a name="line.96"></a> |
| <FONT color="green">097</FONT> <a name="line.97"></a> |
| <FONT color="green">098</FONT> public AuthorizingRealm(CredentialsMatcher matcher) {<a name="line.98"></a> |
| <FONT color="green">099</FONT> this(null, matcher);<a name="line.99"></a> |
| <FONT color="green">100</FONT> }<a name="line.100"></a> |
| <FONT color="green">101</FONT> <a name="line.101"></a> |
| <FONT color="green">102</FONT> public AuthorizingRealm(CacheManager cacheManager, CredentialsMatcher matcher) {<a name="line.102"></a> |
| <FONT color="green">103</FONT> super();<a name="line.103"></a> |
| <FONT color="green">104</FONT> if (cacheManager != null) setCacheManager(cacheManager);<a name="line.104"></a> |
| <FONT color="green">105</FONT> if (matcher != null) setCredentialsMatcher(matcher);<a name="line.105"></a> |
| <FONT color="green">106</FONT> <a name="line.106"></a> |
| <FONT color="green">107</FONT> this.authorizationCachingEnabled = true;<a name="line.107"></a> |
| <FONT color="green">108</FONT> this.permissionResolver = new WildcardPermissionResolver();<a name="line.108"></a> |
| <FONT color="green">109</FONT> <a name="line.109"></a> |
| <FONT color="green">110</FONT> int instanceNumber = INSTANCE_COUNT.getAndIncrement();<a name="line.110"></a> |
| <FONT color="green">111</FONT> this.authorizationCacheName = getClass().getName() + DEFAULT_AUTHORIZATION_CACHE_SUFFIX;<a name="line.111"></a> |
| <FONT color="green">112</FONT> if (instanceNumber > 0) {<a name="line.112"></a> |
| <FONT color="green">113</FONT> this.authorizationCacheName = this.authorizationCacheName + "." + instanceNumber;<a name="line.113"></a> |
| <FONT color="green">114</FONT> }<a name="line.114"></a> |
| <FONT color="green">115</FONT> }<a name="line.115"></a> |
| <FONT color="green">116</FONT> <a name="line.116"></a> |
| <FONT color="green">117</FONT> /*-------------------------------------------<a name="line.117"></a> |
| <FONT color="green">118</FONT> | A C C E S S O R S / M O D I F I E R S |<a name="line.118"></a> |
| <FONT color="green">119</FONT> ============================================*/<a name="line.119"></a> |
| <FONT color="green">120</FONT> <a name="line.120"></a> |
| <FONT color="green">121</FONT> public void setName(String name) {<a name="line.121"></a> |
| <FONT color="green">122</FONT> super.setName(name);<a name="line.122"></a> |
| <FONT color="green">123</FONT> String authzCacheName = this.authorizationCacheName;<a name="line.123"></a> |
| <FONT color="green">124</FONT> if (authzCacheName != null && authzCacheName.startsWith(getClass().getName())) {<a name="line.124"></a> |
| <FONT color="green">125</FONT> //get rid of the default class-name based cache name. Create a more meaningful one<a name="line.125"></a> |
| <FONT color="green">126</FONT> //based on the application-unique Realm name:<a name="line.126"></a> |
| <FONT color="green">127</FONT> this.authorizationCacheName = name + DEFAULT_AUTHORIZATION_CACHE_SUFFIX;<a name="line.127"></a> |
| <FONT color="green">128</FONT> }<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> public void setAuthorizationCache(Cache<Object, AuthorizationInfo> authorizationCache) {<a name="line.131"></a> |
| <FONT color="green">132</FONT> this.authorizationCache = authorizationCache;<a name="line.132"></a> |
| <FONT color="green">133</FONT> }<a name="line.133"></a> |
| <FONT color="green">134</FONT> <a name="line.134"></a> |
| <FONT color="green">135</FONT> public Cache<Object, AuthorizationInfo> getAuthorizationCache() {<a name="line.135"></a> |
| <FONT color="green">136</FONT> return this.authorizationCache;<a name="line.136"></a> |
| <FONT color="green">137</FONT> }<a name="line.137"></a> |
| <FONT color="green">138</FONT> <a name="line.138"></a> |
| <FONT color="green">139</FONT> public String getAuthorizationCacheName() {<a name="line.139"></a> |
| <FONT color="green">140</FONT> return authorizationCacheName;<a name="line.140"></a> |
| <FONT color="green">141</FONT> }<a name="line.141"></a> |
| <FONT color="green">142</FONT> <a name="line.142"></a> |
| <FONT color="green">143</FONT> @SuppressWarnings({"UnusedDeclaration"})<a name="line.143"></a> |
| <FONT color="green">144</FONT> public void setAuthorizationCacheName(String authorizationCacheName) {<a name="line.144"></a> |
| <FONT color="green">145</FONT> this.authorizationCacheName = authorizationCacheName;<a name="line.145"></a> |
| <FONT color="green">146</FONT> }<a name="line.146"></a> |
| <FONT color="green">147</FONT> <a name="line.147"></a> |
| <FONT color="green">148</FONT> /**<a name="line.148"></a> |
| <FONT color="green">149</FONT> * Returns {@code true} if authorization caching should be utilized if a {@link CacheManager} has been<a name="line.149"></a> |
| <FONT color="green">150</FONT> * {@link #setCacheManager(org.apache.shiro.cache.CacheManager) configured}, {@code false} otherwise.<a name="line.150"></a> |
| <FONT color="green">151</FONT> * <p/><a name="line.151"></a> |
| <FONT color="green">152</FONT> * The default value is {@code true}.<a name="line.152"></a> |
| <FONT color="green">153</FONT> *<a name="line.153"></a> |
| <FONT color="green">154</FONT> * @return {@code true} if authorization caching should be utilized, {@code false} otherwise.<a name="line.154"></a> |
| <FONT color="green">155</FONT> */<a name="line.155"></a> |
| <FONT color="green">156</FONT> public boolean isAuthorizationCachingEnabled() {<a name="line.156"></a> |
| <FONT color="green">157</FONT> return isCachingEnabled() && authorizationCachingEnabled;<a name="line.157"></a> |
| <FONT color="green">158</FONT> }<a name="line.158"></a> |
| <FONT color="green">159</FONT> <a name="line.159"></a> |
| <FONT color="green">160</FONT> /**<a name="line.160"></a> |
| <FONT color="green">161</FONT> * Sets whether or not authorization caching should be utilized if a {@link CacheManager} has been<a name="line.161"></a> |
| <FONT color="green">162</FONT> * {@link #setCacheManager(org.apache.shiro.cache.CacheManager) configured}, {@code false} otherwise.<a name="line.162"></a> |
| <FONT color="green">163</FONT> * <p/><a name="line.163"></a> |
| <FONT color="green">164</FONT> * The default value is {@code true}.<a name="line.164"></a> |
| <FONT color="green">165</FONT> *<a name="line.165"></a> |
| <FONT color="green">166</FONT> * @param authenticationCachingEnabled the value to set<a name="line.166"></a> |
| <FONT color="green">167</FONT> */<a name="line.167"></a> |
| <FONT color="green">168</FONT> @SuppressWarnings({"UnusedDeclaration"})<a name="line.168"></a> |
| <FONT color="green">169</FONT> public void setAuthorizationCachingEnabled(boolean authenticationCachingEnabled) {<a name="line.169"></a> |
| <FONT color="green">170</FONT> this.authorizationCachingEnabled = authenticationCachingEnabled;<a name="line.170"></a> |
| <FONT color="green">171</FONT> if (authenticationCachingEnabled) {<a name="line.171"></a> |
| <FONT color="green">172</FONT> setCachingEnabled(true);<a name="line.172"></a> |
| <FONT color="green">173</FONT> }<a name="line.173"></a> |
| <FONT color="green">174</FONT> }<a name="line.174"></a> |
| <FONT color="green">175</FONT> <a name="line.175"></a> |
| <FONT color="green">176</FONT> public PermissionResolver getPermissionResolver() {<a name="line.176"></a> |
| <FONT color="green">177</FONT> return permissionResolver;<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> public void setPermissionResolver(PermissionResolver permissionResolver) {<a name="line.180"></a> |
| <FONT color="green">181</FONT> if (permissionResolver == null) throw new IllegalArgumentException("Null PermissionResolver is not allowed");<a name="line.181"></a> |
| <FONT color="green">182</FONT> this.permissionResolver = permissionResolver;<a name="line.182"></a> |
| <FONT color="green">183</FONT> }<a name="line.183"></a> |
| <FONT color="green">184</FONT> <a name="line.184"></a> |
| <FONT color="green">185</FONT> public RolePermissionResolver getRolePermissionResolver() {<a name="line.185"></a> |
| <FONT color="green">186</FONT> return permissionRoleResolver;<a name="line.186"></a> |
| <FONT color="green">187</FONT> }<a name="line.187"></a> |
| <FONT color="green">188</FONT> <a name="line.188"></a> |
| <FONT color="green">189</FONT> public void setRolePermissionResolver(RolePermissionResolver permissionRoleResolver) {<a name="line.189"></a> |
| <FONT color="green">190</FONT> this.permissionRoleResolver = permissionRoleResolver;<a name="line.190"></a> |
| <FONT color="green">191</FONT> }<a name="line.191"></a> |
| <FONT color="green">192</FONT> <a name="line.192"></a> |
| <FONT color="green">193</FONT> /*--------------------------------------------<a name="line.193"></a> |
| <FONT color="green">194</FONT> | M E T H O D S |<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> * Initializes this realm and potentially enables a cache, depending on configuration.<a name="line.198"></a> |
| <FONT color="green">199</FONT> * <p/><a name="line.199"></a> |
| <FONT color="green">200</FONT> * When this method is called, the following logic is executed:<a name="line.200"></a> |
| <FONT color="green">201</FONT> * <ol><a name="line.201"></a> |
| <FONT color="green">202</FONT> * <li>If the {@link #setAuthorizationCache cache} property has been set, it will be<a name="line.202"></a> |
| <FONT color="green">203</FONT> * used to cache the AuthorizationInfo objects returned from {@link #getAuthorizationInfo}<a name="line.203"></a> |
| <FONT color="green">204</FONT> * method invocations.<a name="line.204"></a> |
| <FONT color="green">205</FONT> * All future calls to {@code getAuthorizationInfo} will attempt to use this cache first<a name="line.205"></a> |
| <FONT color="green">206</FONT> * to alleviate any potentially unnecessary calls to an underlying data store.</li><a name="line.206"></a> |
| <FONT color="green">207</FONT> * <li>If the {@link #setAuthorizationCache cache} property has <b>not</b> been set,<a name="line.207"></a> |
| <FONT color="green">208</FONT> * the {@link #setCacheManager cacheManager} property will be checked.<a name="line.208"></a> |
| <FONT color="green">209</FONT> * If a {@code cacheManager} has been set, it will be used to create an authorization<a name="line.209"></a> |
| <FONT color="green">210</FONT> * {@code cache}, and this newly created cache which will be used as specified in #1.</li><a name="line.210"></a> |
| <FONT color="green">211</FONT> * <li>If neither the {@link #setAuthorizationCache (org.apache.shiro.cache.Cache) cache}<a name="line.211"></a> |
| <FONT color="green">212</FONT> * or {@link #setCacheManager(org.apache.shiro.cache.CacheManager) cacheManager}<a name="line.212"></a> |
| <FONT color="green">213</FONT> * properties are set, caching will be disabled and authorization look-ups will be delegated to<a name="line.213"></a> |
| <FONT color="green">214</FONT> * subclass implementations for each authorization check.</li><a name="line.214"></a> |
| <FONT color="green">215</FONT> * </ol><a name="line.215"></a> |
| <FONT color="green">216</FONT> */<a name="line.216"></a> |
| <FONT color="green">217</FONT> protected void onInit() {<a name="line.217"></a> |
| <FONT color="green">218</FONT> super.onInit();<a name="line.218"></a> |
| <FONT color="green">219</FONT> //trigger obtaining the authorization cache if possible<a name="line.219"></a> |
| <FONT color="green">220</FONT> getAvailableAuthorizationCache();<a name="line.220"></a> |
| <FONT color="green">221</FONT> }<a name="line.221"></a> |
| <FONT color="green">222</FONT> <a name="line.222"></a> |
| <FONT color="green">223</FONT> protected void afterCacheManagerSet() {<a name="line.223"></a> |
| <FONT color="green">224</FONT> super.afterCacheManagerSet();<a name="line.224"></a> |
| <FONT color="green">225</FONT> //trigger obtaining the authorization cache if possible<a name="line.225"></a> |
| <FONT color="green">226</FONT> getAvailableAuthorizationCache();<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> private Cache<Object, AuthorizationInfo> getAuthorizationCacheLazy() {<a name="line.229"></a> |
| <FONT color="green">230</FONT> <a name="line.230"></a> |
| <FONT color="green">231</FONT> if (this.authorizationCache == null) {<a name="line.231"></a> |
| <FONT color="green">232</FONT> <a name="line.232"></a> |
| <FONT color="green">233</FONT> if (log.isDebugEnabled()) {<a name="line.233"></a> |
| <FONT color="green">234</FONT> log.debug("No authorizationCache instance set. Checking for a cacheManager...");<a name="line.234"></a> |
| <FONT color="green">235</FONT> }<a name="line.235"></a> |
| <FONT color="green">236</FONT> <a name="line.236"></a> |
| <FONT color="green">237</FONT> CacheManager cacheManager = getCacheManager();<a name="line.237"></a> |
| <FONT color="green">238</FONT> <a name="line.238"></a> |
| <FONT color="green">239</FONT> if (cacheManager != null) {<a name="line.239"></a> |
| <FONT color="green">240</FONT> String cacheName = getAuthorizationCacheName();<a name="line.240"></a> |
| <FONT color="green">241</FONT> if (log.isDebugEnabled()) {<a name="line.241"></a> |
| <FONT color="green">242</FONT> log.debug("CacheManager [" + cacheManager + "] has been configured. Building " +<a name="line.242"></a> |
| <FONT color="green">243</FONT> "authorization cache named [" + cacheName + "]");<a name="line.243"></a> |
| <FONT color="green">244</FONT> }<a name="line.244"></a> |
| <FONT color="green">245</FONT> this.authorizationCache = cacheManager.getCache(cacheName);<a name="line.245"></a> |
| <FONT color="green">246</FONT> } else {<a name="line.246"></a> |
| <FONT color="green">247</FONT> if (log.isInfoEnabled()) {<a name="line.247"></a> |
| <FONT color="green">248</FONT> log.info("No cache or cacheManager properties have been set. Authorization cache cannot " +<a name="line.248"></a> |
| <FONT color="green">249</FONT> "be obtained.");<a name="line.249"></a> |
| <FONT color="green">250</FONT> }<a name="line.250"></a> |
| <FONT color="green">251</FONT> }<a name="line.251"></a> |
| <FONT color="green">252</FONT> }<a name="line.252"></a> |
| <FONT color="green">253</FONT> <a name="line.253"></a> |
| <FONT color="green">254</FONT> return this.authorizationCache;<a name="line.254"></a> |
| <FONT color="green">255</FONT> }<a name="line.255"></a> |
| <FONT color="green">256</FONT> <a name="line.256"></a> |
| <FONT color="green">257</FONT> private Cache<Object, AuthorizationInfo> getAvailableAuthorizationCache() {<a name="line.257"></a> |
| <FONT color="green">258</FONT> Cache<Object, AuthorizationInfo> cache = getAuthorizationCache();<a name="line.258"></a> |
| <FONT color="green">259</FONT> if (cache == null && isAuthorizationCachingEnabled()) {<a name="line.259"></a> |
| <FONT color="green">260</FONT> cache = getAuthorizationCacheLazy();<a name="line.260"></a> |
| <FONT color="green">261</FONT> }<a name="line.261"></a> |
| <FONT color="green">262</FONT> return cache;<a name="line.262"></a> |
| <FONT color="green">263</FONT> }<a name="line.263"></a> |
| <FONT color="green">264</FONT> <a name="line.264"></a> |
| <FONT color="green">265</FONT> /**<a name="line.265"></a> |
| <FONT color="green">266</FONT> * Returns an account's authorization-specific information for the specified {@code principals},<a name="line.266"></a> |
| <FONT color="green">267</FONT> * or {@code null} if no account could be found. The resulting {@code AuthorizationInfo} object is used<a name="line.267"></a> |
| <FONT color="green">268</FONT> * by the other method implementations in this class to automatically perform access control checks for the<a name="line.268"></a> |
| <FONT color="green">269</FONT> * corresponding {@code Subject}.<a name="line.269"></a> |
| <FONT color="green">270</FONT> * <p/><a name="line.270"></a> |
| <FONT color="green">271</FONT> * This implementation obtains the actual {@code AuthorizationInfo} object from the subclass's<a name="line.271"></a> |
| <FONT color="green">272</FONT> * implementation of<a name="line.272"></a> |
| <FONT color="green">273</FONT> * {@link #doGetAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection) doGetAuthorizationInfo}, and then<a name="line.273"></a> |
| <FONT color="green">274</FONT> * caches it for efficient reuse if caching is enabled (see below).<a name="line.274"></a> |
| <FONT color="green">275</FONT> * <p/><a name="line.275"></a> |
| <FONT color="green">276</FONT> * Invocations of this method should be thought of as completely orthogonal to acquiring<a name="line.276"></a> |
| <FONT color="green">277</FONT> * {@link #getAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken) authenticationInfo}, since either could<a name="line.277"></a> |
| <FONT color="green">278</FONT> * occur in any order.<a name="line.278"></a> |
| <FONT color="green">279</FONT> * <p/><a name="line.279"></a> |
| <FONT color="green">280</FONT> * For example, in &quot;Remember Me&quot; scenarios, the user identity is remembered (and<a name="line.280"></a> |
| <FONT color="green">281</FONT> * assumed) for their current session and an authentication attempt during that session might never occur.<a name="line.281"></a> |
| <FONT color="green">282</FONT> * But because their identity would be remembered, that is sufficient enough information to call this method to<a name="line.282"></a> |
| <FONT color="green">283</FONT> * execute any necessary authorization checks. For this reason, authentication and authorization should be<a name="line.283"></a> |
| <FONT color="green">284</FONT> * loosely coupled and not depend on each other.<a name="line.284"></a> |
| <FONT color="green">285</FONT> * <h3>Caching</h3><a name="line.285"></a> |
| <FONT color="green">286</FONT> * The {@code AuthorizationInfo} values returned from this method are cached for efficient reuse<a name="line.286"></a> |
| <FONT color="green">287</FONT> * if caching is enabled. Caching is enabled automatically when an {@link #setAuthorizationCache authorizationCache}<a name="line.287"></a> |
| <FONT color="green">288</FONT> * instance has been explicitly configured, or if a {@link #setCacheManager cacheManager} has been configured, which<a name="line.288"></a> |
| <FONT color="green">289</FONT> * will be used to lazily create the {@code authorizationCache} as needed.<a name="line.289"></a> |
| <FONT color="green">290</FONT> * <p/><a name="line.290"></a> |
| <FONT color="green">291</FONT> * If caching is enabled, the authorization cache will be checked first and if found, will return the cached<a name="line.291"></a> |
| <FONT color="green">292</FONT> * {@code AuthorizationInfo} immediately. If caching is disabled, or there is a cache miss, the authorization<a name="line.292"></a> |
| <FONT color="green">293</FONT> * info will be looked up from the underlying data store via the<a name="line.293"></a> |
| <FONT color="green">294</FONT> * {@link #doGetAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection)} method, which must be implemented<a name="line.294"></a> |
| <FONT color="green">295</FONT> * by subclasses.<a name="line.295"></a> |
| <FONT color="green">296</FONT> * <h4>Changed Data</h4><a name="line.296"></a> |
| <FONT color="green">297</FONT> * If caching is enabled and if any authorization data for an account is changed at<a name="line.297"></a> |
| <FONT color="green">298</FONT> * runtime, such as adding or removing roles and/or permissions, the subclass implementation should clear the<a name="line.298"></a> |
| <FONT color="green">299</FONT> * cached AuthorizationInfo for that account via the<a name="line.299"></a> |
| <FONT color="green">300</FONT> * {@link #clearCachedAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection) clearCachedAuthorizationInfo}<a name="line.300"></a> |
| <FONT color="green">301</FONT> * method. This ensures that the next call to {@code getAuthorizationInfo(PrincipalCollection)} will<a name="line.301"></a> |
| <FONT color="green">302</FONT> * acquire the account's fresh authorization data, where it will then be cached for efficient reuse. This<a name="line.302"></a> |
| <FONT color="green">303</FONT> * ensures that stale authorization data will not be reused.<a name="line.303"></a> |
| <FONT color="green">304</FONT> *<a name="line.304"></a> |
| <FONT color="green">305</FONT> * @param principals the corresponding Subject's identifying principals with which to look up the Subject's<a name="line.305"></a> |
| <FONT color="green">306</FONT> * {@code AuthorizationInfo}.<a name="line.306"></a> |
| <FONT color="green">307</FONT> * @return the authorization information for the account associated with the specified {@code principals},<a name="line.307"></a> |
| <FONT color="green">308</FONT> * or {@code null} if no account could be found.<a name="line.308"></a> |
| <FONT color="green">309</FONT> */<a name="line.309"></a> |
| <FONT color="green">310</FONT> protected AuthorizationInfo getAuthorizationInfo(PrincipalCollection principals) {<a name="line.310"></a> |
| <FONT color="green">311</FONT> <a name="line.311"></a> |
| <FONT color="green">312</FONT> if (principals == null) {<a name="line.312"></a> |
| <FONT color="green">313</FONT> return null;<a name="line.313"></a> |
| <FONT color="green">314</FONT> }<a name="line.314"></a> |
| <FONT color="green">315</FONT> <a name="line.315"></a> |
| <FONT color="green">316</FONT> AuthorizationInfo info = null;<a name="line.316"></a> |
| <FONT color="green">317</FONT> <a name="line.317"></a> |
| <FONT color="green">318</FONT> if (log.isTraceEnabled()) {<a name="line.318"></a> |
| <FONT color="green">319</FONT> log.trace("Retrieving AuthorizationInfo for principals [" + principals + "]");<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> Cache<Object, AuthorizationInfo> cache = getAvailableAuthorizationCache();<a name="line.322"></a> |
| <FONT color="green">323</FONT> if (cache != null) {<a name="line.323"></a> |
| <FONT color="green">324</FONT> if (log.isTraceEnabled()) {<a name="line.324"></a> |
| <FONT color="green">325</FONT> log.trace("Attempting to retrieve the AuthorizationInfo from cache.");<a name="line.325"></a> |
| <FONT color="green">326</FONT> }<a name="line.326"></a> |
| <FONT color="green">327</FONT> Object key = getAuthorizationCacheKey(principals);<a name="line.327"></a> |
| <FONT color="green">328</FONT> info = cache.get(key);<a name="line.328"></a> |
| <FONT color="green">329</FONT> if (log.isTraceEnabled()) {<a name="line.329"></a> |
| <FONT color="green">330</FONT> if (info == null) {<a name="line.330"></a> |
| <FONT color="green">331</FONT> log.trace("No AuthorizationInfo found in cache for principals [" + principals + "]");<a name="line.331"></a> |
| <FONT color="green">332</FONT> } else {<a name="line.332"></a> |
| <FONT color="green">333</FONT> log.trace("AuthorizationInfo found in cache for principals [" + principals + "]");<a name="line.333"></a> |
| <FONT color="green">334</FONT> }<a name="line.334"></a> |
| <FONT color="green">335</FONT> }<a name="line.335"></a> |
| <FONT color="green">336</FONT> }<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> if (info == null) {<a name="line.339"></a> |
| <FONT color="green">340</FONT> // Call template method if the info was not found in a cache<a name="line.340"></a> |
| <FONT color="green">341</FONT> info = doGetAuthorizationInfo(principals);<a name="line.341"></a> |
| <FONT color="green">342</FONT> // If the info is not null and the cache has been created, then cache the authorization info.<a name="line.342"></a> |
| <FONT color="green">343</FONT> if (info != null && cache != null) {<a name="line.343"></a> |
| <FONT color="green">344</FONT> if (log.isTraceEnabled()) {<a name="line.344"></a> |
| <FONT color="green">345</FONT> log.trace("Caching authorization info for principals: [" + principals + "].");<a name="line.345"></a> |
| <FONT color="green">346</FONT> }<a name="line.346"></a> |
| <FONT color="green">347</FONT> Object key = getAuthorizationCacheKey(principals);<a name="line.347"></a> |
| <FONT color="green">348</FONT> cache.put(key, info);<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> return info;<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> protected Object getAuthorizationCacheKey(PrincipalCollection principals) {<a name="line.355"></a> |
| <FONT color="green">356</FONT> return principals;<a name="line.356"></a> |
| <FONT color="green">357</FONT> }<a name="line.357"></a> |
| <FONT color="green">358</FONT> <a name="line.358"></a> |
| <FONT color="green">359</FONT> /**<a name="line.359"></a> |
| <FONT color="green">360</FONT> * Clears out the AuthorizationInfo cache entry for the specified account.<a name="line.360"></a> |
| <FONT color="green">361</FONT> * <p/><a name="line.361"></a> |
| <FONT color="green">362</FONT> * This method is provided as a convenience to subclasses so they can invalidate a cache entry when they<a name="line.362"></a> |
| <FONT color="green">363</FONT> * change an account's authorization data (add/remove roles or permissions) during runtime. Because an account's<a name="line.363"></a> |
| <FONT color="green">364</FONT> * AuthorizationInfo can be cached, there needs to be a way to invalidate the cache for only that account so that<a name="line.364"></a> |
| <FONT color="green">365</FONT> * subsequent authorization operations don't used the (old) cached value if account data changes.<a name="line.365"></a> |
| <FONT color="green">366</FONT> * <p/><a name="line.366"></a> |
| <FONT color="green">367</FONT> * After this method is called, the next authorization check for that same account will result in a call to<a name="line.367"></a> |
| <FONT color="green">368</FONT> * {@link #getAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection) getAuthorizationInfo}, and the<a name="line.368"></a> |
| <FONT color="green">369</FONT> * resulting return value will be cached before being returned so it can be reused for later authorization checks.<a name="line.369"></a> |
| <FONT color="green">370</FONT> * <p/><a name="line.370"></a> |
| <FONT color="green">371</FONT> * If you wish to clear out all associated cached data (and not just authorization data), use the<a name="line.371"></a> |
| <FONT color="green">372</FONT> * {@link #clearCache(org.apache.shiro.subject.PrincipalCollection)} method instead (which will in turn call this<a name="line.372"></a> |
| <FONT color="green">373</FONT> * method by default).<a name="line.373"></a> |
| <FONT color="green">374</FONT> *<a name="line.374"></a> |
| <FONT color="green">375</FONT> * @param principals the principals of the account for which to clear the cached AuthorizationInfo.<a name="line.375"></a> |
| <FONT color="green">376</FONT> */<a name="line.376"></a> |
| <FONT color="green">377</FONT> protected void clearCachedAuthorizationInfo(PrincipalCollection principals) {<a name="line.377"></a> |
| <FONT color="green">378</FONT> if (principals == null) {<a name="line.378"></a> |
| <FONT color="green">379</FONT> return;<a name="line.379"></a> |
| <FONT color="green">380</FONT> }<a name="line.380"></a> |
| <FONT color="green">381</FONT> <a name="line.381"></a> |
| <FONT color="green">382</FONT> Cache<Object, AuthorizationInfo> cache = getAvailableAuthorizationCache();<a name="line.382"></a> |
| <FONT color="green">383</FONT> //cache instance will be non-null if caching is enabled:<a name="line.383"></a> |
| <FONT color="green">384</FONT> if (cache != null) {<a name="line.384"></a> |
| <FONT color="green">385</FONT> Object key = getAuthorizationCacheKey(principals);<a name="line.385"></a> |
| <FONT color="green">386</FONT> cache.remove(key);<a name="line.386"></a> |
| <FONT color="green">387</FONT> }<a name="line.387"></a> |
| <FONT color="green">388</FONT> }<a name="line.388"></a> |
| <FONT color="green">389</FONT> <a name="line.389"></a> |
| <FONT color="green">390</FONT> /**<a name="line.390"></a> |
| <FONT color="green">391</FONT> * Retrieves the AuthorizationInfo for the given principals from the underlying data store. When returning<a name="line.391"></a> |
| <FONT color="green">392</FONT> * an instance from this method, you might want to consider using an instance of<a name="line.392"></a> |
| <FONT color="green">393</FONT> * {@link org.apache.shiro.authz.SimpleAuthorizationInfo SimpleAuthorizationInfo}, as it is suitable in most cases.<a name="line.393"></a> |
| <FONT color="green">394</FONT> *<a name="line.394"></a> |
| <FONT color="green">395</FONT> * @param principals the primary identifying principals of the AuthorizationInfo that should be retrieved.<a name="line.395"></a> |
| <FONT color="green">396</FONT> * @return the AuthorizationInfo associated with this principals.<a name="line.396"></a> |
| <FONT color="green">397</FONT> * @see org.apache.shiro.authz.SimpleAuthorizationInfo<a name="line.397"></a> |
| <FONT color="green">398</FONT> */<a name="line.398"></a> |
| <FONT color="green">399</FONT> protected abstract AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals);<a name="line.399"></a> |
| <FONT color="green">400</FONT> <a name="line.400"></a> |
| <FONT color="green">401</FONT> private Collection<Permission> getPermissions(AuthorizationInfo info) {<a name="line.401"></a> |
| <FONT color="green">402</FONT> Set<Permission> permissions = new HashSet<Permission>();<a name="line.402"></a> |
| <FONT color="green">403</FONT> <a name="line.403"></a> |
| <FONT color="green">404</FONT> if (info != null) {<a name="line.404"></a> |
| <FONT color="green">405</FONT> Collection<Permission> perms = info.getObjectPermissions();<a name="line.405"></a> |
| <FONT color="green">406</FONT> if (!CollectionUtils.isEmpty(perms)) {<a name="line.406"></a> |
| <FONT color="green">407</FONT> permissions.addAll(perms);<a name="line.407"></a> |
| <FONT color="green">408</FONT> }<a name="line.408"></a> |
| <FONT color="green">409</FONT> perms = resolvePermissions(info.getStringPermissions());<a name="line.409"></a> |
| <FONT color="green">410</FONT> if (!CollectionUtils.isEmpty(perms)) {<a name="line.410"></a> |
| <FONT color="green">411</FONT> permissions.addAll(perms);<a name="line.411"></a> |
| <FONT color="green">412</FONT> }<a name="line.412"></a> |
| <FONT color="green">413</FONT> <a name="line.413"></a> |
| <FONT color="green">414</FONT> perms = resolveRolePermissions(info.getRoles());<a name="line.414"></a> |
| <FONT color="green">415</FONT> if (!CollectionUtils.isEmpty(perms)) {<a name="line.415"></a> |
| <FONT color="green">416</FONT> permissions.addAll(perms);<a name="line.416"></a> |
| <FONT color="green">417</FONT> }<a name="line.417"></a> |
| <FONT color="green">418</FONT> }<a name="line.418"></a> |
| <FONT color="green">419</FONT> <a name="line.419"></a> |
| <FONT color="green">420</FONT> if (permissions.isEmpty()) {<a name="line.420"></a> |
| <FONT color="green">421</FONT> return Collections.emptySet();<a name="line.421"></a> |
| <FONT color="green">422</FONT> } else {<a name="line.422"></a> |
| <FONT color="green">423</FONT> return Collections.unmodifiableSet(permissions);<a name="line.423"></a> |
| <FONT color="green">424</FONT> }<a name="line.424"></a> |
| <FONT color="green">425</FONT> }<a name="line.425"></a> |
| <FONT color="green">426</FONT> <a name="line.426"></a> |
| <FONT color="green">427</FONT> private Collection<Permission> resolvePermissions(Collection<String> stringPerms) {<a name="line.427"></a> |
| <FONT color="green">428</FONT> Collection<Permission> perms = Collections.emptySet();<a name="line.428"></a> |
| <FONT color="green">429</FONT> PermissionResolver resolver = getPermissionResolver();<a name="line.429"></a> |
| <FONT color="green">430</FONT> if (resolver != null && !CollectionUtils.isEmpty(stringPerms)) {<a name="line.430"></a> |
| <FONT color="green">431</FONT> perms = new LinkedHashSet<Permission>(stringPerms.size());<a name="line.431"></a> |
| <FONT color="green">432</FONT> for (String strPermission : stringPerms) {<a name="line.432"></a> |
| <FONT color="green">433</FONT> Permission permission = getPermissionResolver().resolvePermission(strPermission);<a name="line.433"></a> |
| <FONT color="green">434</FONT> perms.add(permission);<a name="line.434"></a> |
| <FONT color="green">435</FONT> }<a name="line.435"></a> |
| <FONT color="green">436</FONT> }<a name="line.436"></a> |
| <FONT color="green">437</FONT> return perms;<a name="line.437"></a> |
| <FONT color="green">438</FONT> }<a name="line.438"></a> |
| <FONT color="green">439</FONT> <a name="line.439"></a> |
| <FONT color="green">440</FONT> private Collection<Permission> resolveRolePermissions(Collection<String> roleNames) {<a name="line.440"></a> |
| <FONT color="green">441</FONT> Collection<Permission> perms = Collections.emptySet();<a name="line.441"></a> |
| <FONT color="green">442</FONT> RolePermissionResolver resolver = getRolePermissionResolver();<a name="line.442"></a> |
| <FONT color="green">443</FONT> if (resolver != null && !CollectionUtils.isEmpty(roleNames)) {<a name="line.443"></a> |
| <FONT color="green">444</FONT> perms = new LinkedHashSet<Permission>(roleNames.size());<a name="line.444"></a> |
| <FONT color="green">445</FONT> for (String roleName : roleNames) {<a name="line.445"></a> |
| <FONT color="green">446</FONT> Collection<Permission> resolved = resolver.resolvePermissionsInRole(roleName);<a name="line.446"></a> |
| <FONT color="green">447</FONT> if (!CollectionUtils.isEmpty(resolved)) {<a name="line.447"></a> |
| <FONT color="green">448</FONT> perms.addAll(resolved);<a name="line.448"></a> |
| <FONT color="green">449</FONT> }<a name="line.449"></a> |
| <FONT color="green">450</FONT> }<a name="line.450"></a> |
| <FONT color="green">451</FONT> }<a name="line.451"></a> |
| <FONT color="green">452</FONT> return perms;<a name="line.452"></a> |
| <FONT color="green">453</FONT> }<a name="line.453"></a> |
| <FONT color="green">454</FONT> <a name="line.454"></a> |
| <FONT color="green">455</FONT> public boolean isPermitted(PrincipalCollection principals, String permission) {<a name="line.455"></a> |
| <FONT color="green">456</FONT> Permission p = getPermissionResolver().resolvePermission(permission);<a name="line.456"></a> |
| <FONT color="green">457</FONT> return isPermitted(principals, p);<a name="line.457"></a> |
| <FONT color="green">458</FONT> }<a name="line.458"></a> |
| <FONT color="green">459</FONT> <a name="line.459"></a> |
| <FONT color="green">460</FONT> public boolean isPermitted(PrincipalCollection principals, Permission permission) {<a name="line.460"></a> |
| <FONT color="green">461</FONT> AuthorizationInfo info = getAuthorizationInfo(principals);<a name="line.461"></a> |
| <FONT color="green">462</FONT> return isPermitted(permission, info);<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> private boolean isPermitted(Permission permission, AuthorizationInfo info) {<a name="line.465"></a> |
| <FONT color="green">466</FONT> Collection<Permission> perms = getPermissions(info);<a name="line.466"></a> |
| <FONT color="green">467</FONT> if (perms != null && !perms.isEmpty()) {<a name="line.467"></a> |
| <FONT color="green">468</FONT> for (Permission perm : perms) {<a name="line.468"></a> |
| <FONT color="green">469</FONT> if (perm.implies(permission)) {<a name="line.469"></a> |
| <FONT color="green">470</FONT> return true;<a name="line.470"></a> |
| <FONT color="green">471</FONT> }<a name="line.471"></a> |
| <FONT color="green">472</FONT> }<a name="line.472"></a> |
| <FONT color="green">473</FONT> }<a name="line.473"></a> |
| <FONT color="green">474</FONT> return false;<a name="line.474"></a> |
| <FONT color="green">475</FONT> }<a name="line.475"></a> |
| <FONT color="green">476</FONT> <a name="line.476"></a> |
| <FONT color="green">477</FONT> public boolean[] isPermitted(PrincipalCollection subjectIdentifier, String... permissions) {<a name="line.477"></a> |
| <FONT color="green">478</FONT> List<Permission> perms = new ArrayList<Permission>(permissions.length);<a name="line.478"></a> |
| <FONT color="green">479</FONT> for (String permString : permissions) {<a name="line.479"></a> |
| <FONT color="green">480</FONT> perms.add(getPermissionResolver().resolvePermission(permString));<a name="line.480"></a> |
| <FONT color="green">481</FONT> }<a name="line.481"></a> |
| <FONT color="green">482</FONT> return isPermitted(subjectIdentifier, perms);<a name="line.482"></a> |
| <FONT color="green">483</FONT> }<a name="line.483"></a> |
| <FONT color="green">484</FONT> <a name="line.484"></a> |
| <FONT color="green">485</FONT> public boolean[] isPermitted(PrincipalCollection principals, List<Permission> permissions) {<a name="line.485"></a> |
| <FONT color="green">486</FONT> AuthorizationInfo info = getAuthorizationInfo(principals);<a name="line.486"></a> |
| <FONT color="green">487</FONT> return isPermitted(permissions, info);<a name="line.487"></a> |
| <FONT color="green">488</FONT> }<a name="line.488"></a> |
| <FONT color="green">489</FONT> <a name="line.489"></a> |
| <FONT color="green">490</FONT> protected boolean[] isPermitted(List<Permission> permissions, AuthorizationInfo info) {<a name="line.490"></a> |
| <FONT color="green">491</FONT> boolean[] result;<a name="line.491"></a> |
| <FONT color="green">492</FONT> if (permissions != null && !permissions.isEmpty()) {<a name="line.492"></a> |
| <FONT color="green">493</FONT> int size = permissions.size();<a name="line.493"></a> |
| <FONT color="green">494</FONT> result = new boolean[size];<a name="line.494"></a> |
| <FONT color="green">495</FONT> int i = 0;<a name="line.495"></a> |
| <FONT color="green">496</FONT> for (Permission p : permissions) {<a name="line.496"></a> |
| <FONT color="green">497</FONT> result[i++] = isPermitted(p, info);<a name="line.497"></a> |
| <FONT color="green">498</FONT> }<a name="line.498"></a> |
| <FONT color="green">499</FONT> } else {<a name="line.499"></a> |
| <FONT color="green">500</FONT> result = new boolean[0];<a name="line.500"></a> |
| <FONT color="green">501</FONT> }<a name="line.501"></a> |
| <FONT color="green">502</FONT> return result;<a name="line.502"></a> |
| <FONT color="green">503</FONT> }<a name="line.503"></a> |
| <FONT color="green">504</FONT> <a name="line.504"></a> |
| <FONT color="green">505</FONT> public boolean isPermittedAll(PrincipalCollection subjectIdentifier, String... permissions) {<a name="line.505"></a> |
| <FONT color="green">506</FONT> if (permissions != null && permissions.length > 0) {<a name="line.506"></a> |
| <FONT color="green">507</FONT> Collection<Permission> perms = new ArrayList<Permission>(permissions.length);<a name="line.507"></a> |
| <FONT color="green">508</FONT> for (String permString : permissions) {<a name="line.508"></a> |
| <FONT color="green">509</FONT> perms.add(getPermissionResolver().resolvePermission(permString));<a name="line.509"></a> |
| <FONT color="green">510</FONT> }<a name="line.510"></a> |
| <FONT color="green">511</FONT> return isPermittedAll(subjectIdentifier, perms);<a name="line.511"></a> |
| <FONT color="green">512</FONT> }<a name="line.512"></a> |
| <FONT color="green">513</FONT> return false;<a name="line.513"></a> |
| <FONT color="green">514</FONT> }<a name="line.514"></a> |
| <FONT color="green">515</FONT> <a name="line.515"></a> |
| <FONT color="green">516</FONT> public boolean isPermittedAll(PrincipalCollection principal, Collection<Permission> permissions) {<a name="line.516"></a> |
| <FONT color="green">517</FONT> AuthorizationInfo info = getAuthorizationInfo(principal);<a name="line.517"></a> |
| <FONT color="green">518</FONT> return info != null && isPermittedAll(permissions, info);<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> protected boolean isPermittedAll(Collection<Permission> permissions, AuthorizationInfo info) {<a name="line.521"></a> |
| <FONT color="green">522</FONT> if (permissions != null && !permissions.isEmpty()) {<a name="line.522"></a> |
| <FONT color="green">523</FONT> for (Permission p : permissions) {<a name="line.523"></a> |
| <FONT color="green">524</FONT> if (!isPermitted(p, info)) {<a name="line.524"></a> |
| <FONT color="green">525</FONT> return false;<a name="line.525"></a> |
| <FONT color="green">526</FONT> }<a name="line.526"></a> |
| <FONT color="green">527</FONT> }<a name="line.527"></a> |
| <FONT color="green">528</FONT> }<a name="line.528"></a> |
| <FONT color="green">529</FONT> return true;<a name="line.529"></a> |
| <FONT color="green">530</FONT> }<a name="line.530"></a> |
| <FONT color="green">531</FONT> <a name="line.531"></a> |
| <FONT color="green">532</FONT> public void checkPermission(PrincipalCollection subjectIdentifier, String permission) throws AuthorizationException {<a name="line.532"></a> |
| <FONT color="green">533</FONT> Permission p = getPermissionResolver().resolvePermission(permission);<a name="line.533"></a> |
| <FONT color="green">534</FONT> checkPermission(subjectIdentifier, p);<a name="line.534"></a> |
| <FONT color="green">535</FONT> }<a name="line.535"></a> |
| <FONT color="green">536</FONT> <a name="line.536"></a> |
| <FONT color="green">537</FONT> public void checkPermission(PrincipalCollection principal, Permission permission) throws AuthorizationException {<a name="line.537"></a> |
| <FONT color="green">538</FONT> AuthorizationInfo info = getAuthorizationInfo(principal);<a name="line.538"></a> |
| <FONT color="green">539</FONT> checkPermission(permission, info);<a name="line.539"></a> |
| <FONT color="green">540</FONT> }<a name="line.540"></a> |
| <FONT color="green">541</FONT> <a name="line.541"></a> |
| <FONT color="green">542</FONT> protected void checkPermission(Permission permission, AuthorizationInfo info) {<a name="line.542"></a> |
| <FONT color="green">543</FONT> if (!isPermitted(permission, info)) {<a name="line.543"></a> |
| <FONT color="green">544</FONT> String msg = "User is not permitted [" + permission + "]";<a name="line.544"></a> |
| <FONT color="green">545</FONT> throw new UnauthorizedException(msg);<a name="line.545"></a> |
| <FONT color="green">546</FONT> }<a name="line.546"></a> |
| <FONT color="green">547</FONT> }<a name="line.547"></a> |
| <FONT color="green">548</FONT> <a name="line.548"></a> |
| <FONT color="green">549</FONT> public void checkPermissions(PrincipalCollection subjectIdentifier, String... permissions) throws AuthorizationException {<a name="line.549"></a> |
| <FONT color="green">550</FONT> if (permissions != null) {<a name="line.550"></a> |
| <FONT color="green">551</FONT> for (String permString : permissions) {<a name="line.551"></a> |
| <FONT color="green">552</FONT> checkPermission(subjectIdentifier, permString);<a name="line.552"></a> |
| <FONT color="green">553</FONT> }<a name="line.553"></a> |
| <FONT color="green">554</FONT> }<a name="line.554"></a> |
| <FONT color="green">555</FONT> }<a name="line.555"></a> |
| <FONT color="green">556</FONT> <a name="line.556"></a> |
| <FONT color="green">557</FONT> public void checkPermissions(PrincipalCollection principal, Collection<Permission> permissions) throws AuthorizationException {<a name="line.557"></a> |
| <FONT color="green">558</FONT> AuthorizationInfo info = getAuthorizationInfo(principal);<a name="line.558"></a> |
| <FONT color="green">559</FONT> checkPermissions(permissions, info);<a name="line.559"></a> |
| <FONT color="green">560</FONT> }<a name="line.560"></a> |
| <FONT color="green">561</FONT> <a name="line.561"></a> |
| <FONT color="green">562</FONT> protected void checkPermissions(Collection<Permission> permissions, AuthorizationInfo info) {<a name="line.562"></a> |
| <FONT color="green">563</FONT> if (permissions != null && !permissions.isEmpty()) {<a name="line.563"></a> |
| <FONT color="green">564</FONT> for (Permission p : permissions) {<a name="line.564"></a> |
| <FONT color="green">565</FONT> checkPermission(p, info);<a name="line.565"></a> |
| <FONT color="green">566</FONT> }<a name="line.566"></a> |
| <FONT color="green">567</FONT> }<a name="line.567"></a> |
| <FONT color="green">568</FONT> }<a name="line.568"></a> |
| <FONT color="green">569</FONT> <a name="line.569"></a> |
| <FONT color="green">570</FONT> public boolean hasRole(PrincipalCollection principal, String roleIdentifier) {<a name="line.570"></a> |
| <FONT color="green">571</FONT> AuthorizationInfo info = getAuthorizationInfo(principal);<a name="line.571"></a> |
| <FONT color="green">572</FONT> return hasRole(roleIdentifier, info);<a name="line.572"></a> |
| <FONT color="green">573</FONT> }<a name="line.573"></a> |
| <FONT color="green">574</FONT> <a name="line.574"></a> |
| <FONT color="green">575</FONT> protected boolean hasRole(String roleIdentifier, AuthorizationInfo info) {<a name="line.575"></a> |
| <FONT color="green">576</FONT> return info != null && info.getRoles() != null && info.getRoles().contains(roleIdentifier);<a name="line.576"></a> |
| <FONT color="green">577</FONT> }<a name="line.577"></a> |
| <FONT color="green">578</FONT> <a name="line.578"></a> |
| <FONT color="green">579</FONT> public boolean[] hasRoles(PrincipalCollection principal, List<String> roleIdentifiers) {<a name="line.579"></a> |
| <FONT color="green">580</FONT> AuthorizationInfo info = getAuthorizationInfo(principal);<a name="line.580"></a> |
| <FONT color="green">581</FONT> boolean[] result = new boolean[roleIdentifiers != null ? roleIdentifiers.size() : 0];<a name="line.581"></a> |
| <FONT color="green">582</FONT> if (info != null) {<a name="line.582"></a> |
| <FONT color="green">583</FONT> result = hasRoles(roleIdentifiers, info);<a name="line.583"></a> |
| <FONT color="green">584</FONT> }<a name="line.584"></a> |
| <FONT color="green">585</FONT> return result;<a name="line.585"></a> |
| <FONT color="green">586</FONT> }<a name="line.586"></a> |
| <FONT color="green">587</FONT> <a name="line.587"></a> |
| <FONT color="green">588</FONT> protected boolean[] hasRoles(List<String> roleIdentifiers, AuthorizationInfo info) {<a name="line.588"></a> |
| <FONT color="green">589</FONT> boolean[] result;<a name="line.589"></a> |
| <FONT color="green">590</FONT> if (roleIdentifiers != null && !roleIdentifiers.isEmpty()) {<a name="line.590"></a> |
| <FONT color="green">591</FONT> int size = roleIdentifiers.size();<a name="line.591"></a> |
| <FONT color="green">592</FONT> result = new boolean[size];<a name="line.592"></a> |
| <FONT color="green">593</FONT> int i = 0;<a name="line.593"></a> |
| <FONT color="green">594</FONT> for (String roleName : roleIdentifiers) {<a name="line.594"></a> |
| <FONT color="green">595</FONT> result[i++] = hasRole(roleName, info);<a name="line.595"></a> |
| <FONT color="green">596</FONT> }<a name="line.596"></a> |
| <FONT color="green">597</FONT> } else {<a name="line.597"></a> |
| <FONT color="green">598</FONT> result = new boolean[0];<a name="line.598"></a> |
| <FONT color="green">599</FONT> }<a name="line.599"></a> |
| <FONT color="green">600</FONT> return result;<a name="line.600"></a> |
| <FONT color="green">601</FONT> }<a name="line.601"></a> |
| <FONT color="green">602</FONT> <a name="line.602"></a> |
| <FONT color="green">603</FONT> public boolean hasAllRoles(PrincipalCollection principal, Collection<String> roleIdentifiers) {<a name="line.603"></a> |
| <FONT color="green">604</FONT> AuthorizationInfo info = getAuthorizationInfo(principal);<a name="line.604"></a> |
| <FONT color="green">605</FONT> return info != null && hasAllRoles(roleIdentifiers, info);<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> private boolean hasAllRoles(Collection<String> roleIdentifiers, AuthorizationInfo info) {<a name="line.608"></a> |
| <FONT color="green">609</FONT> if (roleIdentifiers != null && !roleIdentifiers.isEmpty()) {<a name="line.609"></a> |
| <FONT color="green">610</FONT> for (String roleName : roleIdentifiers) {<a name="line.610"></a> |
| <FONT color="green">611</FONT> if (!hasRole(roleName, info)) {<a name="line.611"></a> |
| <FONT color="green">612</FONT> return false;<a name="line.612"></a> |
| <FONT color="green">613</FONT> }<a name="line.613"></a> |
| <FONT color="green">614</FONT> }<a name="line.614"></a> |
| <FONT color="green">615</FONT> }<a name="line.615"></a> |
| <FONT color="green">616</FONT> return true;<a name="line.616"></a> |
| <FONT color="green">617</FONT> }<a name="line.617"></a> |
| <FONT color="green">618</FONT> <a name="line.618"></a> |
| <FONT color="green">619</FONT> public void checkRole(PrincipalCollection principal, String role) throws AuthorizationException {<a name="line.619"></a> |
| <FONT color="green">620</FONT> AuthorizationInfo info = getAuthorizationInfo(principal);<a name="line.620"></a> |
| <FONT color="green">621</FONT> checkRole(role, info);<a name="line.621"></a> |
| <FONT color="green">622</FONT> }<a name="line.622"></a> |
| <FONT color="green">623</FONT> <a name="line.623"></a> |
| <FONT color="green">624</FONT> protected void checkRole(String role, AuthorizationInfo info) {<a name="line.624"></a> |
| <FONT color="green">625</FONT> if (!hasRole(role, info)) {<a name="line.625"></a> |
| <FONT color="green">626</FONT> String msg = "User does not have role [" + role + "]";<a name="line.626"></a> |
| <FONT color="green">627</FONT> throw new UnauthorizedException(msg);<a name="line.627"></a> |
| <FONT color="green">628</FONT> }<a name="line.628"></a> |
| <FONT color="green">629</FONT> }<a name="line.629"></a> |
| <FONT color="green">630</FONT> <a name="line.630"></a> |
| <FONT color="green">631</FONT> public void checkRoles(PrincipalCollection principal, Collection<String> roles) throws AuthorizationException {<a name="line.631"></a> |
| <FONT color="green">632</FONT> AuthorizationInfo info = getAuthorizationInfo(principal);<a name="line.632"></a> |
| <FONT color="green">633</FONT> checkRoles(roles, info);<a name="line.633"></a> |
| <FONT color="green">634</FONT> }<a name="line.634"></a> |
| <FONT color="green">635</FONT> <a name="line.635"></a> |
| <FONT color="green">636</FONT> public void checkRoles(PrincipalCollection principal, String... roles) throws AuthorizationException {<a name="line.636"></a> |
| <FONT color="green">637</FONT> checkRoles(principal, Arrays.asList(roles));<a name="line.637"></a> |
| <FONT color="green">638</FONT> }<a name="line.638"></a> |
| <FONT color="green">639</FONT> <a name="line.639"></a> |
| <FONT color="green">640</FONT> protected void checkRoles(Collection<String> roles, AuthorizationInfo info) {<a name="line.640"></a> |
| <FONT color="green">641</FONT> if (roles != null && !roles.isEmpty()) {<a name="line.641"></a> |
| <FONT color="green">642</FONT> for (String roleName : roles) {<a name="line.642"></a> |
| <FONT color="green">643</FONT> checkRole(roleName, info);<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> }<a name="line.646"></a> |
| <FONT color="green">647</FONT> <a name="line.647"></a> |
| <FONT color="green">648</FONT> /**<a name="line.648"></a> |
| <FONT color="green">649</FONT> * Calls {@code super.doClearCache} to ensure any cached authentication data is removed and then calls<a name="line.649"></a> |
| <FONT color="green">650</FONT> * {@link #clearCachedAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection)} to remove any cached<a name="line.650"></a> |
| <FONT color="green">651</FONT> * authorization data.<a name="line.651"></a> |
| <FONT color="green">652</FONT> * <p/><a name="line.652"></a> |
| <FONT color="green">653</FONT> * If overriding in a subclass, be sure to call {@code super.doClearCache} to ensure this behavior is maintained.<a name="line.653"></a> |
| <FONT color="green">654</FONT> *<a name="line.654"></a> |
| <FONT color="green">655</FONT> * @param principals the principals of the account for which to clear any cached AuthorizationInfo<a name="line.655"></a> |
| <FONT color="green">656</FONT> * @since 1.2<a name="line.656"></a> |
| <FONT color="green">657</FONT> */<a name="line.657"></a> |
| <FONT color="green">658</FONT> @Override<a name="line.658"></a> |
| <FONT color="green">659</FONT> protected void doClearCache(PrincipalCollection principals) {<a name="line.659"></a> |
| <FONT color="green">660</FONT> super.doClearCache(principals);<a name="line.660"></a> |
| <FONT color="green">661</FONT> clearCachedAuthorizationInfo(principals);<a name="line.661"></a> |
| <FONT color="green">662</FONT> }<a name="line.662"></a> |
| <FONT color="green">663</FONT> }<a name="line.663"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
