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