blob: ebcad390d977af960c5064a69376af28afd89359 [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a>
<FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a>
<FONT color="green">017</FONT> * under the License.<a name="line.17"></a>
<FONT color="green">018</FONT> */<a name="line.18"></a>
<FONT color="green">019</FONT> package org.apache.shiro.authz;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import org.apache.shiro.authz.permission.PermissionResolver;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.shiro.authz.permission.PermissionResolverAware;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.shiro.authz.permission.RolePermissionResolver;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.shiro.authz.permission.RolePermissionResolverAware;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.shiro.realm.Realm;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.shiro.subject.PrincipalCollection;<a name="line.26"></a>
<FONT color="green">027</FONT> <a name="line.27"></a>
<FONT color="green">028</FONT> import java.util.Collection;<a name="line.28"></a>
<FONT color="green">029</FONT> import java.util.List;<a name="line.29"></a>
<FONT color="green">030</FONT> <a name="line.30"></a>
<FONT color="green">031</FONT> <a name="line.31"></a>
<FONT color="green">032</FONT> /**<a name="line.32"></a>
<FONT color="green">033</FONT> * A &lt;tt&gt;ModularRealmAuthorizer&lt;/tt&gt; is an &lt;tt&gt;Authorizer&lt;/tt&gt; implementation that consults one or more configured<a name="line.33"></a>
<FONT color="green">034</FONT> * {@link Realm Realm}s during an authorization operation.<a name="line.34"></a>
<FONT color="green">035</FONT> *<a name="line.35"></a>
<FONT color="green">036</FONT> * @since 0.2<a name="line.36"></a>
<FONT color="green">037</FONT> */<a name="line.37"></a>
<FONT color="green">038</FONT> public class ModularRealmAuthorizer implements Authorizer, PermissionResolverAware, RolePermissionResolverAware {<a name="line.38"></a>
<FONT color="green">039</FONT> <a name="line.39"></a>
<FONT color="green">040</FONT> /**<a name="line.40"></a>
<FONT color="green">041</FONT> * The realms to consult during any authorization check.<a name="line.41"></a>
<FONT color="green">042</FONT> */<a name="line.42"></a>
<FONT color="green">043</FONT> protected Collection&lt;Realm&gt; realms;<a name="line.43"></a>
<FONT color="green">044</FONT> <a name="line.44"></a>
<FONT color="green">045</FONT> /**<a name="line.45"></a>
<FONT color="green">046</FONT> * A PermissionResolver to be used by &lt;em&gt;all&lt;/em&gt; configured realms. Leave &lt;code&gt;null&lt;/code&gt; if you wish<a name="line.46"></a>
<FONT color="green">047</FONT> * to configure different resolvers for different realms.<a name="line.47"></a>
<FONT color="green">048</FONT> */<a name="line.48"></a>
<FONT color="green">049</FONT> protected PermissionResolver permissionResolver;<a name="line.49"></a>
<FONT color="green">050</FONT> <a name="line.50"></a>
<FONT color="green">051</FONT> /**<a name="line.51"></a>
<FONT color="green">052</FONT> * A RolePermissionResolver to be used by &lt;em&gt;all&lt;/em&gt; configured realms. Leave &lt;code&gt;null&lt;/code&gt; if you wish<a name="line.52"></a>
<FONT color="green">053</FONT> * to configure different resolvers for different realms.<a name="line.53"></a>
<FONT color="green">054</FONT> */<a name="line.54"></a>
<FONT color="green">055</FONT> protected RolePermissionResolver rolePermissionResolver;<a name="line.55"></a>
<FONT color="green">056</FONT> <a name="line.56"></a>
<FONT color="green">057</FONT> /**<a name="line.57"></a>
<FONT color="green">058</FONT> * Default no-argument constructor, does nothing.<a name="line.58"></a>
<FONT color="green">059</FONT> */<a name="line.59"></a>
<FONT color="green">060</FONT> public ModularRealmAuthorizer() {<a name="line.60"></a>
<FONT color="green">061</FONT> }<a name="line.61"></a>
<FONT color="green">062</FONT> <a name="line.62"></a>
<FONT color="green">063</FONT> /**<a name="line.63"></a>
<FONT color="green">064</FONT> * Constructor that accepts the &lt;code&gt;Realm&lt;/code&gt;s to consult during an authorization check. Immediately calls<a name="line.64"></a>
<FONT color="green">065</FONT> * {@link #setRealms setRealms(realms)}.<a name="line.65"></a>
<FONT color="green">066</FONT> *<a name="line.66"></a>
<FONT color="green">067</FONT> * @param realms the realms to consult during an authorization check.<a name="line.67"></a>
<FONT color="green">068</FONT> */<a name="line.68"></a>
<FONT color="green">069</FONT> public ModularRealmAuthorizer(Collection&lt;Realm&gt; realms) {<a name="line.69"></a>
<FONT color="green">070</FONT> setRealms(realms);<a name="line.70"></a>
<FONT color="green">071</FONT> }<a name="line.71"></a>
<FONT color="green">072</FONT> <a name="line.72"></a>
<FONT color="green">073</FONT> /**<a name="line.73"></a>
<FONT color="green">074</FONT> * Returns the realms wrapped by this &lt;code&gt;Authorizer&lt;/code&gt; which are consulted during an authorization check.<a name="line.74"></a>
<FONT color="green">075</FONT> *<a name="line.75"></a>
<FONT color="green">076</FONT> * @return the realms wrapped by this &lt;code&gt;Authorizer&lt;/code&gt; which are consulted during an authorization check.<a name="line.76"></a>
<FONT color="green">077</FONT> */<a name="line.77"></a>
<FONT color="green">078</FONT> public Collection&lt;Realm&gt; getRealms() {<a name="line.78"></a>
<FONT color="green">079</FONT> return this.realms;<a name="line.79"></a>
<FONT color="green">080</FONT> }<a name="line.80"></a>
<FONT color="green">081</FONT> <a name="line.81"></a>
<FONT color="green">082</FONT> /**<a name="line.82"></a>
<FONT color="green">083</FONT> * Sets the realms wrapped by this &lt;code&gt;Authorizer&lt;/code&gt; which are consulted during an authorization check.<a name="line.83"></a>
<FONT color="green">084</FONT> *<a name="line.84"></a>
<FONT color="green">085</FONT> * @param realms the realms wrapped by this &lt;code&gt;Authorizer&lt;/code&gt; which are consulted during an authorization check.<a name="line.85"></a>
<FONT color="green">086</FONT> */<a name="line.86"></a>
<FONT color="green">087</FONT> public void setRealms(Collection&lt;Realm&gt; realms) {<a name="line.87"></a>
<FONT color="green">088</FONT> this.realms = realms;<a name="line.88"></a>
<FONT color="green">089</FONT> applyPermissionResolverToRealms();<a name="line.89"></a>
<FONT color="green">090</FONT> applyRolePermissionResolverToRealms();<a name="line.90"></a>
<FONT color="green">091</FONT> }<a name="line.91"></a>
<FONT color="green">092</FONT> <a name="line.92"></a>
<FONT color="green">093</FONT> /**<a name="line.93"></a>
<FONT color="green">094</FONT> * Returns the PermissionResolver to be used on &lt;em&gt;all&lt;/em&gt; configured realms, or &lt;code&gt;null&lt;/code (the default)<a name="line.94"></a>
<FONT color="green">095</FONT> * if all realm instances will each configure their own permission resolver.<a name="line.95"></a>
<FONT color="green">096</FONT> *<a name="line.96"></a>
<FONT color="green">097</FONT> * @return the PermissionResolver to be used on &lt;em&gt;all&lt;/em&gt; configured realms, or &lt;code&gt;null&lt;/code (the default)<a name="line.97"></a>
<FONT color="green">098</FONT> * if realm instances will each configure their own permission resolver.<a name="line.98"></a>
<FONT color="green">099</FONT> * @since 1.0<a name="line.99"></a>
<FONT color="green">100</FONT> */<a name="line.100"></a>
<FONT color="green">101</FONT> public PermissionResolver getPermissionResolver() {<a name="line.101"></a>
<FONT color="green">102</FONT> return this.permissionResolver;<a name="line.102"></a>
<FONT color="green">103</FONT> }<a name="line.103"></a>
<FONT color="green">104</FONT> <a name="line.104"></a>
<FONT color="green">105</FONT> /**<a name="line.105"></a>
<FONT color="green">106</FONT> * Sets the specified {@link PermissionResolver PermissionResolver} on &lt;em&gt;all&lt;/em&gt; of the wrapped realms that<a name="line.106"></a>
<FONT color="green">107</FONT> * implement the {@link org.apache.shiro.authz.permission.PermissionResolverAware PermissionResolverAware} interface.<a name="line.107"></a>
<FONT color="green">108</FONT> * &lt;p/&gt;<a name="line.108"></a>
<FONT color="green">109</FONT> * Only call this method if you want the permission resolver to be passed to all realms that implement the<a name="line.109"></a>
<FONT color="green">110</FONT> * &lt;code&gt;PermissionResolver&lt;/code&gt; interface. If you do not want this to occur, the realms must<a name="line.110"></a>
<FONT color="green">111</FONT> * configure themselves individually (or be configured individually).<a name="line.111"></a>
<FONT color="green">112</FONT> *<a name="line.112"></a>
<FONT color="green">113</FONT> * @param permissionResolver the permissionResolver to set on all of the wrapped realms that implement the<a name="line.113"></a>
<FONT color="green">114</FONT> * {@link org.apache.shiro.authz.permission.PermissionResolverAware PermissionResolverAware} interface.<a name="line.114"></a>
<FONT color="green">115</FONT> */<a name="line.115"></a>
<FONT color="green">116</FONT> public void setPermissionResolver(PermissionResolver permissionResolver) {<a name="line.116"></a>
<FONT color="green">117</FONT> this.permissionResolver = permissionResolver;<a name="line.117"></a>
<FONT color="green">118</FONT> applyPermissionResolverToRealms();<a name="line.118"></a>
<FONT color="green">119</FONT> }<a name="line.119"></a>
<FONT color="green">120</FONT> <a name="line.120"></a>
<FONT color="green">121</FONT> /**<a name="line.121"></a>
<FONT color="green">122</FONT> * Sets the internal {@link #getPermissionResolver} on any internal configured<a name="line.122"></a>
<FONT color="green">123</FONT> * {@link #getRealms Realms} that implement the {@link org.apache.shiro.authz.permission.PermissionResolverAware PermissionResolverAware} interface.<a name="line.123"></a>
<FONT color="green">124</FONT> * &lt;p/&gt;<a name="line.124"></a>
<FONT color="green">125</FONT> * This method is called after setting a permissionResolver on this ModularRealmAuthorizer via the<a name="line.125"></a>
<FONT color="green">126</FONT> * {@link #setPermissionResolver(org.apache.shiro.authz.permission.PermissionResolver) setPermissionResolver} method.<a name="line.126"></a>
<FONT color="green">127</FONT> * &lt;p/&gt;<a name="line.127"></a>
<FONT color="green">128</FONT> * It is also called after setting one or more realms via the {@link #setRealms setRealms} method to allow these<a name="line.128"></a>
<FONT color="green">129</FONT> * newly available realms to be given the &lt;code&gt;PermissionResolver&lt;/code&gt; already in use.<a name="line.129"></a>
<FONT color="green">130</FONT> *<a name="line.130"></a>
<FONT color="green">131</FONT> * @since 1.0<a name="line.131"></a>
<FONT color="green">132</FONT> */<a name="line.132"></a>
<FONT color="green">133</FONT> protected void applyPermissionResolverToRealms() {<a name="line.133"></a>
<FONT color="green">134</FONT> PermissionResolver resolver = getPermissionResolver();<a name="line.134"></a>
<FONT color="green">135</FONT> Collection&lt;Realm&gt; realms = getRealms();<a name="line.135"></a>
<FONT color="green">136</FONT> if (resolver != null &amp;&amp; realms != null &amp;&amp; !realms.isEmpty()) {<a name="line.136"></a>
<FONT color="green">137</FONT> for (Realm realm : realms) {<a name="line.137"></a>
<FONT color="green">138</FONT> if (realm instanceof PermissionResolverAware) {<a name="line.138"></a>
<FONT color="green">139</FONT> ((PermissionResolverAware) realm).setPermissionResolver(resolver);<a name="line.139"></a>
<FONT color="green">140</FONT> }<a name="line.140"></a>
<FONT color="green">141</FONT> }<a name="line.141"></a>
<FONT color="green">142</FONT> }<a name="line.142"></a>
<FONT color="green">143</FONT> }<a name="line.143"></a>
<FONT color="green">144</FONT> <a name="line.144"></a>
<FONT color="green">145</FONT> /**<a name="line.145"></a>
<FONT color="green">146</FONT> * Returns the RolePermissionResolver to be used on &lt;em&gt;all&lt;/em&gt; configured realms, or &lt;code&gt;null&lt;/code (the default)<a name="line.146"></a>
<FONT color="green">147</FONT> * if all realm instances will each configure their own permission resolver.<a name="line.147"></a>
<FONT color="green">148</FONT> *<a name="line.148"></a>
<FONT color="green">149</FONT> * @return the RolePermissionResolver to be used on &lt;em&gt;all&lt;/em&gt; configured realms, or &lt;code&gt;null&lt;/code (the default)<a name="line.149"></a>
<FONT color="green">150</FONT> * if realm instances will each configure their own role permission resolver.<a name="line.150"></a>
<FONT color="green">151</FONT> * @since 1.0<a name="line.151"></a>
<FONT color="green">152</FONT> */<a name="line.152"></a>
<FONT color="green">153</FONT> public RolePermissionResolver getRolePermissionResolver() {<a name="line.153"></a>
<FONT color="green">154</FONT> return this.rolePermissionResolver;<a name="line.154"></a>
<FONT color="green">155</FONT> }<a name="line.155"></a>
<FONT color="green">156</FONT> <a name="line.156"></a>
<FONT color="green">157</FONT> /**<a name="line.157"></a>
<FONT color="green">158</FONT> * Sets the specified {@link RolePermissionResolver RolePermissionResolver} on &lt;em&gt;all&lt;/em&gt; of the wrapped realms that<a name="line.158"></a>
<FONT color="green">159</FONT> * implement the {@link org.apache.shiro.authz.permission.RolePermissionResolverAware PermissionResolverAware} interface.<a name="line.159"></a>
<FONT color="green">160</FONT> * &lt;p/&gt;<a name="line.160"></a>
<FONT color="green">161</FONT> * Only call this method if you want the permission resolver to be passed to all realms that implement the<a name="line.161"></a>
<FONT color="green">162</FONT> * &lt;code&gt;RolePermissionResolver&lt;/code&gt; interface. If you do not want this to occur, the realms must<a name="line.162"></a>
<FONT color="green">163</FONT> * configure themselves individually (or be configured individually).<a name="line.163"></a>
<FONT color="green">164</FONT> *<a name="line.164"></a>
<FONT color="green">165</FONT> * @param rolePermissionResolver the rolePermissionResolver to set on all of the wrapped realms that implement the<a name="line.165"></a>
<FONT color="green">166</FONT> * {@link org.apache.shiro.authz.permission.RolePermissionResolverAware RolePermissionResolverAware} interface.<a name="line.166"></a>
<FONT color="green">167</FONT> */<a name="line.167"></a>
<FONT color="green">168</FONT> public void setRolePermissionResolver(RolePermissionResolver rolePermissionResolver) {<a name="line.168"></a>
<FONT color="green">169</FONT> this.rolePermissionResolver = rolePermissionResolver;<a name="line.169"></a>
<FONT color="green">170</FONT> applyRolePermissionResolverToRealms();<a name="line.170"></a>
<FONT color="green">171</FONT> }<a name="line.171"></a>
<FONT color="green">172</FONT> <a name="line.172"></a>
<FONT color="green">173</FONT> <a name="line.173"></a>
<FONT color="green">174</FONT> /**<a name="line.174"></a>
<FONT color="green">175</FONT> * Sets the internal {@link #getRolePermissionResolver} on any internal configured<a name="line.175"></a>
<FONT color="green">176</FONT> * {@link #getRealms Realms} that implement the {@link org.apache.shiro.authz.permission.RolePermissionResolverAware RolePermissionResolverAware} interface.<a name="line.176"></a>
<FONT color="green">177</FONT> * &lt;p/&gt;<a name="line.177"></a>
<FONT color="green">178</FONT> * This method is called after setting a rolePermissionResolver on this ModularRealmAuthorizer via the<a name="line.178"></a>
<FONT color="green">179</FONT> * {@link #setRolePermissionResolver(org.apache.shiro.authz.permission.RolePermissionResolver) setRolePermissionResolver} method.<a name="line.179"></a>
<FONT color="green">180</FONT> * &lt;p/&gt;<a name="line.180"></a>
<FONT color="green">181</FONT> * It is also called after setting one or more realms via the {@link #setRealms setRealms} method to allow these<a name="line.181"></a>
<FONT color="green">182</FONT> * newly available realms to be given the &lt;code&gt;RolePermissionResolver&lt;/code&gt; already in use.<a name="line.182"></a>
<FONT color="green">183</FONT> *<a name="line.183"></a>
<FONT color="green">184</FONT> * @since 1.0<a name="line.184"></a>
<FONT color="green">185</FONT> */<a name="line.185"></a>
<FONT color="green">186</FONT> protected void applyRolePermissionResolverToRealms() {<a name="line.186"></a>
<FONT color="green">187</FONT> RolePermissionResolver resolver = getRolePermissionResolver();<a name="line.187"></a>
<FONT color="green">188</FONT> Collection&lt;Realm&gt; realms = getRealms();<a name="line.188"></a>
<FONT color="green">189</FONT> if (resolver != null &amp;&amp; realms != null &amp;&amp; !realms.isEmpty()) {<a name="line.189"></a>
<FONT color="green">190</FONT> for (Realm realm : realms) {<a name="line.190"></a>
<FONT color="green">191</FONT> if (realm instanceof RolePermissionResolverAware) {<a name="line.191"></a>
<FONT color="green">192</FONT> ((RolePermissionResolverAware) realm).setRolePermissionResolver(resolver);<a name="line.192"></a>
<FONT color="green">193</FONT> }<a name="line.193"></a>
<FONT color="green">194</FONT> }<a name="line.194"></a>
<FONT color="green">195</FONT> }<a name="line.195"></a>
<FONT color="green">196</FONT> }<a name="line.196"></a>
<FONT color="green">197</FONT> <a name="line.197"></a>
<FONT color="green">198</FONT> <a name="line.198"></a>
<FONT color="green">199</FONT> /**<a name="line.199"></a>
<FONT color="green">200</FONT> * Used by the {@link Authorizer Authorizer} implementation methods to ensure that the {@link #setRealms realms}<a name="line.200"></a>
<FONT color="green">201</FONT> * has been set. The default implementation ensures the property is not null and not empty.<a name="line.201"></a>
<FONT color="green">202</FONT> *<a name="line.202"></a>
<FONT color="green">203</FONT> * @throws IllegalStateException if the &lt;tt&gt;realms&lt;/tt&gt; property is configured incorrectly.<a name="line.203"></a>
<FONT color="green">204</FONT> */<a name="line.204"></a>
<FONT color="green">205</FONT> protected void assertRealmsConfigured() throws IllegalStateException {<a name="line.205"></a>
<FONT color="green">206</FONT> Collection&lt;Realm&gt; realms = getRealms();<a name="line.206"></a>
<FONT color="green">207</FONT> if (realms == null || realms.isEmpty()) {<a name="line.207"></a>
<FONT color="green">208</FONT> String msg = "Configuration error: No realms have been configured! One or more realms must be " +<a name="line.208"></a>
<FONT color="green">209</FONT> "present to execute an authorization operation.";<a name="line.209"></a>
<FONT color="green">210</FONT> throw new IllegalStateException(msg);<a name="line.210"></a>
<FONT color="green">211</FONT> }<a name="line.211"></a>
<FONT color="green">212</FONT> }<a name="line.212"></a>
<FONT color="green">213</FONT> <a name="line.213"></a>
<FONT color="green">214</FONT> /**<a name="line.214"></a>
<FONT color="green">215</FONT> * Returns &lt;code&gt;true&lt;/code&gt; if any of the configured realms'<a name="line.215"></a>
<FONT color="green">216</FONT> * {@link #isPermitted(org.apache.shiro.subject.PrincipalCollection, String)} returns &lt;code&gt;true&lt;/code&gt;,<a name="line.216"></a>
<FONT color="green">217</FONT> * &lt;code&gt;false&lt;/code&gt; otherwise.<a name="line.217"></a>
<FONT color="green">218</FONT> */<a name="line.218"></a>
<FONT color="green">219</FONT> public boolean isPermitted(PrincipalCollection principals, String permission) {<a name="line.219"></a>
<FONT color="green">220</FONT> assertRealmsConfigured();<a name="line.220"></a>
<FONT color="green">221</FONT> for (Realm realm : getRealms()) {<a name="line.221"></a>
<FONT color="green">222</FONT> if (!(realm instanceof Authorizer)) continue;<a name="line.222"></a>
<FONT color="green">223</FONT> if (((Authorizer) realm).isPermitted(principals, permission)) {<a name="line.223"></a>
<FONT color="green">224</FONT> return true;<a name="line.224"></a>
<FONT color="green">225</FONT> }<a name="line.225"></a>
<FONT color="green">226</FONT> }<a name="line.226"></a>
<FONT color="green">227</FONT> return false;<a name="line.227"></a>
<FONT color="green">228</FONT> }<a name="line.228"></a>
<FONT color="green">229</FONT> <a name="line.229"></a>
<FONT color="green">230</FONT> /**<a name="line.230"></a>
<FONT color="green">231</FONT> * Returns &lt;code&gt;true&lt;/code&gt; if any of the configured realms'<a name="line.231"></a>
<FONT color="green">232</FONT> * {@link #isPermitted(org.apache.shiro.subject.PrincipalCollection, Permission)} call returns &lt;code&gt;true&lt;/code&gt;,<a name="line.232"></a>
<FONT color="green">233</FONT> * &lt;code&gt;false&lt;/code&gt; otherwise.<a name="line.233"></a>
<FONT color="green">234</FONT> */<a name="line.234"></a>
<FONT color="green">235</FONT> public boolean isPermitted(PrincipalCollection principals, Permission permission) {<a name="line.235"></a>
<FONT color="green">236</FONT> assertRealmsConfigured();<a name="line.236"></a>
<FONT color="green">237</FONT> for (Realm realm : getRealms()) {<a name="line.237"></a>
<FONT color="green">238</FONT> if (!(realm instanceof Authorizer)) continue;<a name="line.238"></a>
<FONT color="green">239</FONT> if (((Authorizer) realm).isPermitted(principals, permission)) {<a name="line.239"></a>
<FONT color="green">240</FONT> return true;<a name="line.240"></a>
<FONT color="green">241</FONT> }<a name="line.241"></a>
<FONT color="green">242</FONT> }<a name="line.242"></a>
<FONT color="green">243</FONT> return false;<a name="line.243"></a>
<FONT color="green">244</FONT> }<a name="line.244"></a>
<FONT color="green">245</FONT> <a name="line.245"></a>
<FONT color="green">246</FONT> /**<a name="line.246"></a>
<FONT color="green">247</FONT> * Returns &lt;code&gt;true&lt;/code&gt; if any of the configured realms'<a name="line.247"></a>
<FONT color="green">248</FONT> * {@link #isPermittedAll(org.apache.shiro.subject.PrincipalCollection, String...)} call returns<a name="line.248"></a>
<FONT color="green">249</FONT> * &lt;code&gt;true&lt;/code&gt;, &lt;code&gt;false&lt;/code&gt; otherwise.<a name="line.249"></a>
<FONT color="green">250</FONT> */<a name="line.250"></a>
<FONT color="green">251</FONT> public boolean[] isPermitted(PrincipalCollection principals, String... permissions) {<a name="line.251"></a>
<FONT color="green">252</FONT> assertRealmsConfigured();<a name="line.252"></a>
<FONT color="green">253</FONT> if (permissions != null &amp;&amp; permissions.length &gt; 0) {<a name="line.253"></a>
<FONT color="green">254</FONT> boolean[] isPermitted = new boolean[permissions.length];<a name="line.254"></a>
<FONT color="green">255</FONT> for (int i = 0; i &lt; permissions.length; i++) {<a name="line.255"></a>
<FONT color="green">256</FONT> isPermitted[i] = isPermitted(principals, permissions[i]);<a name="line.256"></a>
<FONT color="green">257</FONT> }<a name="line.257"></a>
<FONT color="green">258</FONT> return isPermitted;<a name="line.258"></a>
<FONT color="green">259</FONT> }<a name="line.259"></a>
<FONT color="green">260</FONT> return new boolean[0];<a name="line.260"></a>
<FONT color="green">261</FONT> }<a name="line.261"></a>
<FONT color="green">262</FONT> <a name="line.262"></a>
<FONT color="green">263</FONT> /**<a name="line.263"></a>
<FONT color="green">264</FONT> * Returns &lt;code&gt;true&lt;/code&gt; if any of the configured realms'<a name="line.264"></a>
<FONT color="green">265</FONT> * {@link #isPermitted(org.apache.shiro.subject.PrincipalCollection, List)} call returns &lt;code&gt;true&lt;/code&gt;,<a name="line.265"></a>
<FONT color="green">266</FONT> * &lt;code&gt;false&lt;/code&gt; otherwise.<a name="line.266"></a>
<FONT color="green">267</FONT> */<a name="line.267"></a>
<FONT color="green">268</FONT> public boolean[] isPermitted(PrincipalCollection principals, List&lt;Permission&gt; permissions) {<a name="line.268"></a>
<FONT color="green">269</FONT> assertRealmsConfigured();<a name="line.269"></a>
<FONT color="green">270</FONT> if (permissions != null &amp;&amp; !permissions.isEmpty()) {<a name="line.270"></a>
<FONT color="green">271</FONT> boolean[] isPermitted = new boolean[permissions.size()];<a name="line.271"></a>
<FONT color="green">272</FONT> int i = 0;<a name="line.272"></a>
<FONT color="green">273</FONT> for (Permission p : permissions) {<a name="line.273"></a>
<FONT color="green">274</FONT> isPermitted[i++] = isPermitted(principals, p);<a name="line.274"></a>
<FONT color="green">275</FONT> }<a name="line.275"></a>
<FONT color="green">276</FONT> return isPermitted;<a name="line.276"></a>
<FONT color="green">277</FONT> }<a name="line.277"></a>
<FONT color="green">278</FONT> <a name="line.278"></a>
<FONT color="green">279</FONT> return new boolean[0];<a name="line.279"></a>
<FONT color="green">280</FONT> }<a name="line.280"></a>
<FONT color="green">281</FONT> <a name="line.281"></a>
<FONT color="green">282</FONT> /**<a name="line.282"></a>
<FONT color="green">283</FONT> * Returns &lt;code&gt;true&lt;/code&gt; if any of the configured realms'<a name="line.283"></a>
<FONT color="green">284</FONT> * {@link #isPermitted(org.apache.shiro.subject.PrincipalCollection, String)} call returns &lt;code&gt;true&lt;/code&gt;<a name="line.284"></a>
<FONT color="green">285</FONT> * for &lt;em&gt;all&lt;/em&gt; of the specified string permissions, &lt;code&gt;false&lt;/code&gt; otherwise.<a name="line.285"></a>
<FONT color="green">286</FONT> */<a name="line.286"></a>
<FONT color="green">287</FONT> public boolean isPermittedAll(PrincipalCollection principals, String... permissions) {<a name="line.287"></a>
<FONT color="green">288</FONT> assertRealmsConfigured();<a name="line.288"></a>
<FONT color="green">289</FONT> if (permissions != null &amp;&amp; permissions.length &gt; 0) {<a name="line.289"></a>
<FONT color="green">290</FONT> for (String perm : permissions) {<a name="line.290"></a>
<FONT color="green">291</FONT> if (!isPermitted(principals, perm)) {<a name="line.291"></a>
<FONT color="green">292</FONT> return false;<a name="line.292"></a>
<FONT color="green">293</FONT> }<a name="line.293"></a>
<FONT color="green">294</FONT> }<a name="line.294"></a>
<FONT color="green">295</FONT> }<a name="line.295"></a>
<FONT color="green">296</FONT> return true;<a name="line.296"></a>
<FONT color="green">297</FONT> }<a name="line.297"></a>
<FONT color="green">298</FONT> <a name="line.298"></a>
<FONT color="green">299</FONT> /**<a name="line.299"></a>
<FONT color="green">300</FONT> * Returns &lt;code&gt;true&lt;/code&gt; if any of the configured realms'<a name="line.300"></a>
<FONT color="green">301</FONT> * {@link #isPermitted(org.apache.shiro.subject.PrincipalCollection, Permission)} call returns &lt;code&gt;true&lt;/code&gt;<a name="line.301"></a>
<FONT color="green">302</FONT> * for &lt;em&gt;all&lt;/em&gt; of the specified Permissions, &lt;code&gt;false&lt;/code&gt; otherwise.<a name="line.302"></a>
<FONT color="green">303</FONT> */<a name="line.303"></a>
<FONT color="green">304</FONT> public boolean isPermittedAll(PrincipalCollection principals, Collection&lt;Permission&gt; permissions) {<a name="line.304"></a>
<FONT color="green">305</FONT> assertRealmsConfigured();<a name="line.305"></a>
<FONT color="green">306</FONT> if (permissions != null &amp;&amp; !permissions.isEmpty()) {<a name="line.306"></a>
<FONT color="green">307</FONT> for (Permission permission : permissions) {<a name="line.307"></a>
<FONT color="green">308</FONT> if (!isPermitted(principals, permission)) {<a name="line.308"></a>
<FONT color="green">309</FONT> return false;<a name="line.309"></a>
<FONT color="green">310</FONT> }<a name="line.310"></a>
<FONT color="green">311</FONT> }<a name="line.311"></a>
<FONT color="green">312</FONT> }<a name="line.312"></a>
<FONT color="green">313</FONT> return true;<a name="line.313"></a>
<FONT color="green">314</FONT> }<a name="line.314"></a>
<FONT color="green">315</FONT> <a name="line.315"></a>
<FONT color="green">316</FONT> /**<a name="line.316"></a>
<FONT color="green">317</FONT> * If !{@link #isPermitted(org.apache.shiro.subject.PrincipalCollection, String) isPermitted(permission)}, throws<a name="line.317"></a>
<FONT color="green">318</FONT> * an &lt;code&gt;UnauthorizedException&lt;/code&gt; otherwise returns quietly.<a name="line.318"></a>
<FONT color="green">319</FONT> */<a name="line.319"></a>
<FONT color="green">320</FONT> public void checkPermission(PrincipalCollection principals, String permission) throws AuthorizationException {<a name="line.320"></a>
<FONT color="green">321</FONT> assertRealmsConfigured();<a name="line.321"></a>
<FONT color="green">322</FONT> if (!isPermitted(principals, permission)) {<a name="line.322"></a>
<FONT color="green">323</FONT> throw new UnauthorizedException("Subject does not have permission [" + permission + "]");<a name="line.323"></a>
<FONT color="green">324</FONT> }<a name="line.324"></a>
<FONT color="green">325</FONT> }<a name="line.325"></a>
<FONT color="green">326</FONT> <a name="line.326"></a>
<FONT color="green">327</FONT> /**<a name="line.327"></a>
<FONT color="green">328</FONT> * If !{@link #isPermitted(org.apache.shiro.subject.PrincipalCollection, Permission) isPermitted(permission)}, throws<a name="line.328"></a>
<FONT color="green">329</FONT> * an &lt;code&gt;UnauthorizedException&lt;/code&gt; otherwise returns quietly.<a name="line.329"></a>
<FONT color="green">330</FONT> */<a name="line.330"></a>
<FONT color="green">331</FONT> public void checkPermission(PrincipalCollection principals, Permission permission) throws AuthorizationException {<a name="line.331"></a>
<FONT color="green">332</FONT> assertRealmsConfigured();<a name="line.332"></a>
<FONT color="green">333</FONT> if (!isPermitted(principals, permission)) {<a name="line.333"></a>
<FONT color="green">334</FONT> throw new UnauthorizedException("Subject does not have permission [" + permission + "]");<a name="line.334"></a>
<FONT color="green">335</FONT> }<a name="line.335"></a>
<FONT color="green">336</FONT> }<a name="line.336"></a>
<FONT color="green">337</FONT> <a name="line.337"></a>
<FONT color="green">338</FONT> /**<a name="line.338"></a>
<FONT color="green">339</FONT> * If !{@link #isPermitted(org.apache.shiro.subject.PrincipalCollection, String...) isPermitted(permission)},<a name="line.339"></a>
<FONT color="green">340</FONT> * throws an &lt;code&gt;UnauthorizedException&lt;/code&gt; otherwise returns quietly.<a name="line.340"></a>
<FONT color="green">341</FONT> */<a name="line.341"></a>
<FONT color="green">342</FONT> public void checkPermissions(PrincipalCollection principals, String... permissions) throws AuthorizationException {<a name="line.342"></a>
<FONT color="green">343</FONT> assertRealmsConfigured();<a name="line.343"></a>
<FONT color="green">344</FONT> if (permissions != null &amp;&amp; permissions.length &gt; 0) {<a name="line.344"></a>
<FONT color="green">345</FONT> for (String perm : permissions) {<a name="line.345"></a>
<FONT color="green">346</FONT> checkPermission(principals, perm);<a name="line.346"></a>
<FONT color="green">347</FONT> }<a name="line.347"></a>
<FONT color="green">348</FONT> }<a name="line.348"></a>
<FONT color="green">349</FONT> }<a name="line.349"></a>
<FONT color="green">350</FONT> <a name="line.350"></a>
<FONT color="green">351</FONT> /**<a name="line.351"></a>
<FONT color="green">352</FONT> * If !{@link #isPermitted(org.apache.shiro.subject.PrincipalCollection, Permission) isPermitted(permission)} for<a name="line.352"></a>
<FONT color="green">353</FONT> * &lt;em&gt;all&lt;/em&gt; the given Permissions, throws<a name="line.353"></a>
<FONT color="green">354</FONT> * an &lt;code&gt;UnauthorizedException&lt;/code&gt; otherwise returns quietly.<a name="line.354"></a>
<FONT color="green">355</FONT> */<a name="line.355"></a>
<FONT color="green">356</FONT> public void checkPermissions(PrincipalCollection principals, Collection&lt;Permission&gt; permissions) throws AuthorizationException {<a name="line.356"></a>
<FONT color="green">357</FONT> assertRealmsConfigured();<a name="line.357"></a>
<FONT color="green">358</FONT> if (permissions != null) {<a name="line.358"></a>
<FONT color="green">359</FONT> for (Permission permission : permissions) {<a name="line.359"></a>
<FONT color="green">360</FONT> checkPermission(principals, permission);<a name="line.360"></a>
<FONT color="green">361</FONT> }<a name="line.361"></a>
<FONT color="green">362</FONT> }<a name="line.362"></a>
<FONT color="green">363</FONT> }<a name="line.363"></a>
<FONT color="green">364</FONT> <a name="line.364"></a>
<FONT color="green">365</FONT> /**<a name="line.365"></a>
<FONT color="green">366</FONT> * Returns &lt;code&gt;true&lt;/code&gt; if any of the configured realms'<a name="line.366"></a>
<FONT color="green">367</FONT> * {@link #hasRole(org.apache.shiro.subject.PrincipalCollection, String)} call returns &lt;code&gt;true&lt;/code&gt;,<a name="line.367"></a>
<FONT color="green">368</FONT> * &lt;code&gt;false&lt;/code&gt; otherwise.<a name="line.368"></a>
<FONT color="green">369</FONT> */<a name="line.369"></a>
<FONT color="green">370</FONT> public boolean hasRole(PrincipalCollection principals, String roleIdentifier) {<a name="line.370"></a>
<FONT color="green">371</FONT> assertRealmsConfigured();<a name="line.371"></a>
<FONT color="green">372</FONT> for (Realm realm : getRealms()) {<a name="line.372"></a>
<FONT color="green">373</FONT> if (!(realm instanceof Authorizer)) continue;<a name="line.373"></a>
<FONT color="green">374</FONT> if (((Authorizer) realm).hasRole(principals, roleIdentifier)) {<a name="line.374"></a>
<FONT color="green">375</FONT> return true;<a name="line.375"></a>
<FONT color="green">376</FONT> }<a name="line.376"></a>
<FONT color="green">377</FONT> }<a name="line.377"></a>
<FONT color="green">378</FONT> return false;<a name="line.378"></a>
<FONT color="green">379</FONT> }<a name="line.379"></a>
<FONT color="green">380</FONT> <a name="line.380"></a>
<FONT color="green">381</FONT> /**<a name="line.381"></a>
<FONT color="green">382</FONT> * Calls {@link #hasRole(org.apache.shiro.subject.PrincipalCollection, String)} for each role name in the specified<a name="line.382"></a>
<FONT color="green">383</FONT> * collection and places the return value from each call at the respective location in the returned array.<a name="line.383"></a>
<FONT color="green">384</FONT> */<a name="line.384"></a>
<FONT color="green">385</FONT> public boolean[] hasRoles(PrincipalCollection principals, List&lt;String&gt; roleIdentifiers) {<a name="line.385"></a>
<FONT color="green">386</FONT> assertRealmsConfigured();<a name="line.386"></a>
<FONT color="green">387</FONT> if (roleIdentifiers != null &amp;&amp; !roleIdentifiers.isEmpty()) {<a name="line.387"></a>
<FONT color="green">388</FONT> boolean[] hasRoles = new boolean[roleIdentifiers.size()];<a name="line.388"></a>
<FONT color="green">389</FONT> int i = 0;<a name="line.389"></a>
<FONT color="green">390</FONT> for (String roleId : roleIdentifiers) {<a name="line.390"></a>
<FONT color="green">391</FONT> hasRoles[i++] = hasRole(principals, roleId);<a name="line.391"></a>
<FONT color="green">392</FONT> }<a name="line.392"></a>
<FONT color="green">393</FONT> return hasRoles;<a name="line.393"></a>
<FONT color="green">394</FONT> }<a name="line.394"></a>
<FONT color="green">395</FONT> <a name="line.395"></a>
<FONT color="green">396</FONT> return new boolean[0];<a name="line.396"></a>
<FONT color="green">397</FONT> }<a name="line.397"></a>
<FONT color="green">398</FONT> <a name="line.398"></a>
<FONT color="green">399</FONT> /**<a name="line.399"></a>
<FONT color="green">400</FONT> * Returns &lt;code&gt;true&lt;/code&gt; iff any of the configured realms'<a name="line.400"></a>
<FONT color="green">401</FONT> * {@link #hasRole(org.apache.shiro.subject.PrincipalCollection, String)} call returns &lt;code&gt;true&lt;/code&gt; for<a name="line.401"></a>
<FONT color="green">402</FONT> * &lt;em&gt;all&lt;/em&gt; roles specified, &lt;code&gt;false&lt;/code&gt; otherwise.<a name="line.402"></a>
<FONT color="green">403</FONT> */<a name="line.403"></a>
<FONT color="green">404</FONT> public boolean hasAllRoles(PrincipalCollection principals, Collection&lt;String&gt; roleIdentifiers) {<a name="line.404"></a>
<FONT color="green">405</FONT> assertRealmsConfigured();<a name="line.405"></a>
<FONT color="green">406</FONT> for (String roleIdentifier : roleIdentifiers) {<a name="line.406"></a>
<FONT color="green">407</FONT> if (!hasRole(principals, roleIdentifier)) {<a name="line.407"></a>
<FONT color="green">408</FONT> return false;<a name="line.408"></a>
<FONT color="green">409</FONT> }<a name="line.409"></a>
<FONT color="green">410</FONT> }<a name="line.410"></a>
<FONT color="green">411</FONT> return true;<a name="line.411"></a>
<FONT color="green">412</FONT> }<a name="line.412"></a>
<FONT color="green">413</FONT> <a name="line.413"></a>
<FONT color="green">414</FONT> /**<a name="line.414"></a>
<FONT color="green">415</FONT> * If !{@link #hasRole(org.apache.shiro.subject.PrincipalCollection, String) hasRole(role)}, throws<a name="line.415"></a>
<FONT color="green">416</FONT> * an &lt;code&gt;UnauthorizedException&lt;/code&gt; otherwise returns quietly.<a name="line.416"></a>
<FONT color="green">417</FONT> */<a name="line.417"></a>
<FONT color="green">418</FONT> public void checkRole(PrincipalCollection principals, String role) throws AuthorizationException {<a name="line.418"></a>
<FONT color="green">419</FONT> assertRealmsConfigured();<a name="line.419"></a>
<FONT color="green">420</FONT> if (!hasRole(principals, role)) {<a name="line.420"></a>
<FONT color="green">421</FONT> throw new UnauthorizedException("Subject does not have role [" + role + "]");<a name="line.421"></a>
<FONT color="green">422</FONT> }<a name="line.422"></a>
<FONT color="green">423</FONT> }<a name="line.423"></a>
<FONT color="green">424</FONT> <a name="line.424"></a>
<FONT color="green">425</FONT> /**<a name="line.425"></a>
<FONT color="green">426</FONT> * Calls {@link #checkRoles(PrincipalCollection principals, String... roles) checkRoles(PrincipalCollection principals, String... roles) }.<a name="line.426"></a>
<FONT color="green">427</FONT> */<a name="line.427"></a>
<FONT color="green">428</FONT> public void checkRoles(PrincipalCollection principals, Collection&lt;String&gt; roles) throws AuthorizationException {<a name="line.428"></a>
<FONT color="green">429</FONT> //SHIRO-234 - roles.toArray() -&gt; roles.toArray(new String[roles.size()])<a name="line.429"></a>
<FONT color="green">430</FONT> if (roles != null &amp;&amp; !roles.isEmpty()) checkRoles(principals, roles.toArray(new String[roles.size()]));<a name="line.430"></a>
<FONT color="green">431</FONT> }<a name="line.431"></a>
<FONT color="green">432</FONT> <a name="line.432"></a>
<FONT color="green">433</FONT> /**<a name="line.433"></a>
<FONT color="green">434</FONT> * Calls {@link #checkRole(org.apache.shiro.subject.PrincipalCollection, String) checkRole} for each role specified.<a name="line.434"></a>
<FONT color="green">435</FONT> */<a name="line.435"></a>
<FONT color="green">436</FONT> public void checkRoles(PrincipalCollection principals, String... roles) throws AuthorizationException {<a name="line.436"></a>
<FONT color="green">437</FONT> assertRealmsConfigured();<a name="line.437"></a>
<FONT color="green">438</FONT> if (roles != null) {<a name="line.438"></a>
<FONT color="green">439</FONT> for (String role : roles) {<a name="line.439"></a>
<FONT color="green">440</FONT> checkRole(principals, role);<a name="line.440"></a>
<FONT color="green">441</FONT> }<a name="line.441"></a>
<FONT color="green">442</FONT> }<a name="line.442"></a>
<FONT color="green">443</FONT> }<a name="line.443"></a>
<FONT color="green">444</FONT> }<a name="line.444"></a>
</PRE>
</BODY>
</HTML>