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