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