| <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.subject.PrincipalCollection;<a name="line.21"></a> |
| <FONT color="green">022</FONT> <a name="line.22"></a> |
| <FONT color="green">023</FONT> import java.util.Collection;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import java.util.List;<a name="line.24"></a> |
| <FONT color="green">025</FONT> <a name="line.25"></a> |
| <FONT color="green">026</FONT> /**<a name="line.26"></a> |
| <FONT color="green">027</FONT> * An <tt>Authorizer</tt> performs authorization (access control) operations for any given Subject<a name="line.27"></a> |
| <FONT color="green">028</FONT> * (aka 'application user').<a name="line.28"></a> |
| <FONT color="green">029</FONT> *<a name="line.29"></a> |
| <FONT color="green">030</FONT> * <p>Each method requires a subject principal to perform the action for the corresponding Subject/user.<a name="line.30"></a> |
| <FONT color="green">031</FONT> *<a name="line.31"></a> |
| <FONT color="green">032</FONT> * <p>This principal argument is usually an object representing a user database primary key or a String username or<a name="line.32"></a> |
| <FONT color="green">033</FONT> * something similar that uniquely identifies an application user. The runtime value of the this principal<a name="line.33"></a> |
| <FONT color="green">034</FONT> * is application-specific and provided by the application's configured Realms.<a name="line.34"></a> |
| <FONT color="green">035</FONT> *<a name="line.35"></a> |
| <FONT color="green">036</FONT> * <p>Note that there are many *Permission methods in this interface overloaded to accept String arguments instead of<a name="line.36"></a> |
| <FONT color="green">037</FONT> * {@link Permission Permission} instances. They are a convenience allowing the caller to use a String representation of<a name="line.37"></a> |
| <FONT color="green">038</FONT> * a {@link Permission Permission} if desired. Most implementations of this interface will simply convert these<a name="line.38"></a> |
| <FONT color="green">039</FONT> * String values to {@link Permission Permission} instances and then just call the corresponding type-safe method.<a name="line.39"></a> |
| <FONT color="green">040</FONT> * (Shiro's default implementations do String-to-Permission conversion for these methods using<a name="line.40"></a> |
| <FONT color="green">041</FONT> * {@link org.apache.shiro.authz.permission.PermissionResolver PermissionResolver}s.)<a name="line.41"></a> |
| <FONT color="green">042</FONT> *<a name="line.42"></a> |
| <FONT color="green">043</FONT> * <p>These overloaded *Permission methods <em>do</em> forego type-saftey for the benefit of convenience and simplicity,<a name="line.43"></a> |
| <FONT color="green">044</FONT> * so you should choose which ones to use based on your preferences and needs.<a name="line.44"></a> |
| <FONT color="green">045</FONT> *<a name="line.45"></a> |
| <FONT color="green">046</FONT> * @since 0.1<a name="line.46"></a> |
| <FONT color="green">047</FONT> */<a name="line.47"></a> |
| <FONT color="green">048</FONT> public interface Authorizer {<a name="line.48"></a> |
| <FONT color="green">049</FONT> <a name="line.49"></a> |
| <FONT color="green">050</FONT> /**<a name="line.50"></a> |
| <FONT color="green">051</FONT> * Returns <tt>true</tt> if the corresponding subject/user is permitted to perform an action or access a resource<a name="line.51"></a> |
| <FONT color="green">052</FONT> * summarized by the specified permission string.<a name="line.52"></a> |
| <FONT color="green">053</FONT> *<a name="line.53"></a> |
| <FONT color="green">054</FONT> * <p>This is an overloaded method for the corresponding type-safe {@link Permission Permission} variant.<a name="line.54"></a> |
| <FONT color="green">055</FONT> * Please see the class-level JavaDoc for more information on these String-based permission methods.<a name="line.55"></a> |
| <FONT color="green">056</FONT> *<a name="line.56"></a> |
| <FONT color="green">057</FONT> * @param principals the application-specific subject/user identifier.<a name="line.57"></a> |
| <FONT color="green">058</FONT> * @param permission the String representation of a Permission that is being checked.<a name="line.58"></a> |
| <FONT color="green">059</FONT> * @return true if the corresponding Subject/user is permitted, false otherwise.<a name="line.59"></a> |
| <FONT color="green">060</FONT> * @see #isPermitted(PrincipalCollection principals,Permission permission)<a name="line.60"></a> |
| <FONT color="green">061</FONT> * @since 0.9<a name="line.61"></a> |
| <FONT color="green">062</FONT> */<a name="line.62"></a> |
| <FONT color="green">063</FONT> boolean isPermitted(PrincipalCollection principals, String permission);<a name="line.63"></a> |
| <FONT color="green">064</FONT> <a name="line.64"></a> |
| <FONT color="green">065</FONT> /**<a name="line.65"></a> |
| <FONT color="green">066</FONT> * Returns <tt>true</tt> if the corresponding subject/user is permitted to perform an action or access a resource<a name="line.66"></a> |
| <FONT color="green">067</FONT> * summarized by the specified permission.<a name="line.67"></a> |
| <FONT color="green">068</FONT> *<a name="line.68"></a> |
| <FONT color="green">069</FONT> * <p>More specifically, this method determines if any <tt>Permission</tt>s associated<a name="line.69"></a> |
| <FONT color="green">070</FONT> * with the subject {@link Permission#implies(Permission) imply} the specified permission.<a name="line.70"></a> |
| <FONT color="green">071</FONT> *<a name="line.71"></a> |
| <FONT color="green">072</FONT> * @param subjectPrincipal the application-specific subject/user identifier.<a name="line.72"></a> |
| <FONT color="green">073</FONT> * @param permission the permission that is being checked.<a name="line.73"></a> |
| <FONT color="green">074</FONT> * @return true if the corresponding Subject/user is permitted, false otherwise.<a name="line.74"></a> |
| <FONT color="green">075</FONT> */<a name="line.75"></a> |
| <FONT color="green">076</FONT> boolean isPermitted(PrincipalCollection subjectPrincipal, Permission permission);<a name="line.76"></a> |
| <FONT color="green">077</FONT> <a name="line.77"></a> |
| <FONT color="green">078</FONT> /**<a name="line.78"></a> |
| <FONT color="green">079</FONT> * Checks if the corresponding Subject implies the given permission strings and returns a boolean array<a name="line.79"></a> |
| <FONT color="green">080</FONT> * indicating which permissions are implied.<a name="line.80"></a> |
| <FONT color="green">081</FONT> *<a name="line.81"></a> |
| <FONT color="green">082</FONT> * <p>This is an overloaded method for the corresponding type-safe {@link Permission Permission} variant.<a name="line.82"></a> |
| <FONT color="green">083</FONT> * Please see the class-level JavaDoc for more information on these String-based permission methods.<a name="line.83"></a> |
| <FONT color="green">084</FONT> *<a name="line.84"></a> |
| <FONT color="green">085</FONT> * @param subjectPrincipal the application-specific subject/user identifier.<a name="line.85"></a> |
| <FONT color="green">086</FONT> * @param permissions the String representations of the Permissions that are being checked.<a name="line.86"></a> |
| <FONT color="green">087</FONT> * @return an array of booleans whose indices correspond to the index of the<a name="line.87"></a> |
| <FONT color="green">088</FONT> * permissions in the given list. A true value at an index indicates the user is permitted for<a name="line.88"></a> |
| <FONT color="green">089</FONT> * for the associated <tt>Permission</tt> string in the list. A false value at an index<a name="line.89"></a> |
| <FONT color="green">090</FONT> * indicates otherwise.<a name="line.90"></a> |
| <FONT color="green">091</FONT> * @since 0.9<a name="line.91"></a> |
| <FONT color="green">092</FONT> */<a name="line.92"></a> |
| <FONT color="green">093</FONT> boolean[] isPermitted(PrincipalCollection subjectPrincipal, String... permissions);<a name="line.93"></a> |
| <FONT color="green">094</FONT> <a name="line.94"></a> |
| <FONT color="green">095</FONT> /**<a name="line.95"></a> |
| <FONT color="green">096</FONT> * Checks if the corresponding Subject/user implies the given Permissions and returns a boolean array indicating<a name="line.96"></a> |
| <FONT color="green">097</FONT> * which permissions are implied.<a name="line.97"></a> |
| <FONT color="green">098</FONT> *<a name="line.98"></a> |
| <FONT color="green">099</FONT> * <p>More specifically, this method should determine if each <tt>Permission</tt> in<a name="line.99"></a> |
| <FONT color="green">100</FONT> * the array is {@link Permission#implies(Permission) implied} by permissions<a name="line.100"></a> |
| <FONT color="green">101</FONT> * already associated with the subject.<a name="line.101"></a> |
| <FONT color="green">102</FONT> *<a name="line.102"></a> |
| <FONT color="green">103</FONT> * <p>This is primarily a performance-enhancing method to help reduce the number of<a name="line.103"></a> |
| <FONT color="green">104</FONT> * {@link #isPermitted} invocations over the wire in client/server systems.<a name="line.104"></a> |
| <FONT color="green">105</FONT> *<a name="line.105"></a> |
| <FONT color="green">106</FONT> * @param subjectPrincipal the application-specific subject/user identifier.<a name="line.106"></a> |
| <FONT color="green">107</FONT> * @param permissions the permissions that are being checked.<a name="line.107"></a> |
| <FONT color="green">108</FONT> * @return an array of booleans whose indices correspond to the index of the<a name="line.108"></a> |
| <FONT color="green">109</FONT> * permissions in the given list. A true value at an index indicates the user is permitted for<a name="line.109"></a> |
| <FONT color="green">110</FONT> * for the associated <tt>Permission</tt> object in the list. A false value at an index<a name="line.110"></a> |
| <FONT color="green">111</FONT> * indicates otherwise.<a name="line.111"></a> |
| <FONT color="green">112</FONT> */<a name="line.112"></a> |
| <FONT color="green">113</FONT> boolean[] isPermitted(PrincipalCollection subjectPrincipal, List<Permission> permissions);<a name="line.113"></a> |
| <FONT color="green">114</FONT> <a name="line.114"></a> |
| <FONT color="green">115</FONT> /**<a name="line.115"></a> |
| <FONT color="green">116</FONT> * Returns <tt>true</tt> if the corresponding Subject/user implies all of the specified permission strings,<a name="line.116"></a> |
| <FONT color="green">117</FONT> * <tt>false</tt> otherwise.<a name="line.117"></a> |
| <FONT color="green">118</FONT> *<a name="line.118"></a> |
| <FONT color="green">119</FONT> * <p>This is an overloaded method for the corresponding type-safe {@link Permission Permission} variant.<a name="line.119"></a> |
| <FONT color="green">120</FONT> * Please see the class-level JavaDoc for more information on these String-based permission methods.<a name="line.120"></a> |
| <FONT color="green">121</FONT> *<a name="line.121"></a> |
| <FONT color="green">122</FONT> * @param subjectPrincipal the application-specific subject/user identifier.<a name="line.122"></a> |
| <FONT color="green">123</FONT> * @param permissions the String representations of the Permissions that are being checked.<a name="line.123"></a> |
| <FONT color="green">124</FONT> * @return true if the user has all of the specified permissions, false otherwise.<a name="line.124"></a> |
| <FONT color="green">125</FONT> * @see #isPermittedAll(PrincipalCollection,Collection)<a name="line.125"></a> |
| <FONT color="green">126</FONT> * @since 0.9<a name="line.126"></a> |
| <FONT color="green">127</FONT> */<a name="line.127"></a> |
| <FONT color="green">128</FONT> boolean isPermittedAll(PrincipalCollection subjectPrincipal, String... permissions);<a name="line.128"></a> |
| <FONT color="green">129</FONT> <a name="line.129"></a> |
| <FONT color="green">130</FONT> /**<a name="line.130"></a> |
| <FONT color="green">131</FONT> * Returns <tt>true</tt> if the corresponding Subject/user implies all of the specified permissions, <tt>false</tt><a name="line.131"></a> |
| <FONT color="green">132</FONT> * otherwise.<a name="line.132"></a> |
| <FONT color="green">133</FONT> *<a name="line.133"></a> |
| <FONT color="green">134</FONT> * <p>More specifically, this method determines if all of the given <tt>Permission</tt>s are<a name="line.134"></a> |
| <FONT color="green">135</FONT> * {@link Permission#implies(Permission) implied by} permissions already associated with the subject.<a name="line.135"></a> |
| <FONT color="green">136</FONT> *<a name="line.136"></a> |
| <FONT color="green">137</FONT> * @param subjectPrincipal the application-specific subject/user identifier.<a name="line.137"></a> |
| <FONT color="green">138</FONT> * @param permissions the permissions to check.<a name="line.138"></a> |
| <FONT color="green">139</FONT> * @return true if the user has all of the specified permissions, false otherwise.<a name="line.139"></a> |
| <FONT color="green">140</FONT> */<a name="line.140"></a> |
| <FONT color="green">141</FONT> boolean isPermittedAll(PrincipalCollection subjectPrincipal, Collection<Permission> permissions);<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> * Ensures the corresponding Subject/user implies the specified permission String.<a name="line.144"></a> |
| <FONT color="green">145</FONT> *<a name="line.145"></a> |
| <FONT color="green">146</FONT> * <p>If the subject's existing associated permissions do not {@link Permission#implies(Permission)} imply}<a name="line.146"></a> |
| <FONT color="green">147</FONT> * the given permission, an {@link AuthorizationException} will be thrown.<a name="line.147"></a> |
| <FONT color="green">148</FONT> *<a name="line.148"></a> |
| <FONT color="green">149</FONT> * <p>This is an overloaded method for the corresponding type-safe {@link Permission Permission} variant.<a name="line.149"></a> |
| <FONT color="green">150</FONT> * Please see the class-level JavaDoc for more information on these String-based permission methods.<a name="line.150"></a> |
| <FONT color="green">151</FONT> *<a name="line.151"></a> |
| <FONT color="green">152</FONT> * @param subjectPrincipal the application-specific subject/user identifier.<a name="line.152"></a> |
| <FONT color="green">153</FONT> * @param permission the String representation of the Permission to check.<a name="line.153"></a> |
| <FONT color="green">154</FONT> * @throws AuthorizationException<a name="line.154"></a> |
| <FONT color="green">155</FONT> * if the user does not have the permission.<a name="line.155"></a> |
| <FONT color="green">156</FONT> * @since 0.9<a name="line.156"></a> |
| <FONT color="green">157</FONT> */<a name="line.157"></a> |
| <FONT color="green">158</FONT> void checkPermission(PrincipalCollection subjectPrincipal, String permission) throws AuthorizationException;<a name="line.158"></a> |
| <FONT color="green">159</FONT> <a name="line.159"></a> |
| <FONT color="green">160</FONT> /**<a name="line.160"></a> |
| <FONT color="green">161</FONT> * Ensures a subject/user {@link Permission#implies(Permission)} implies} the specified <tt>Permission</tt>.<a name="line.161"></a> |
| <FONT color="green">162</FONT> * If the subject's exisiting associated permissions do not {@link Permission#implies(Permission)} imply}<a name="line.162"></a> |
| <FONT color="green">163</FONT> * the given permission, an {@link AuthorizationException} will be thrown.<a name="line.163"></a> |
| <FONT color="green">164</FONT> *<a name="line.164"></a> |
| <FONT color="green">165</FONT> * @param subjectPrincipal the application-specific subject/user identifier.<a name="line.165"></a> |
| <FONT color="green">166</FONT> * @param permission the Permission to check.<a name="line.166"></a> |
| <FONT color="green">167</FONT> * @throws AuthorizationException<a name="line.167"></a> |
| <FONT color="green">168</FONT> * if the user does not have the permission.<a name="line.168"></a> |
| <FONT color="green">169</FONT> */<a name="line.169"></a> |
| <FONT color="green">170</FONT> void checkPermission(PrincipalCollection subjectPrincipal, Permission permission) throws AuthorizationException;<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> * Ensures the corresponding Subject/user<a name="line.173"></a> |
| <FONT color="green">174</FONT> * {@link Permission#implies(Permission) implies} all of the<a name="line.174"></a> |
| <FONT color="green">175</FONT> * specified permission strings.<a name="line.175"></a> |
| <FONT color="green">176</FONT> *<a name="line.176"></a> |
| <FONT color="green">177</FONT> * If the subject's exisiting associated permissions do not<a name="line.177"></a> |
| <FONT color="green">178</FONT> * {@link Permission#implies(Permission) imply} all of the given permissions,<a name="line.178"></a> |
| <FONT color="green">179</FONT> * an {@link AuthorizationException} will be thrown.<a name="line.179"></a> |
| <FONT color="green">180</FONT> *<a name="line.180"></a> |
| <FONT color="green">181</FONT> * <p>This is an overloaded method for the corresponding type-safe {@link Permission Permission} variant.<a name="line.181"></a> |
| <FONT color="green">182</FONT> * Please see the class-level JavaDoc for more information on these String-based permission methods.<a name="line.182"></a> |
| <FONT color="green">183</FONT> *<a name="line.183"></a> |
| <FONT color="green">184</FONT> * @param subjectPrincipal the application-specific subject/user identifier.<a name="line.184"></a> |
| <FONT color="green">185</FONT> * @param permissions the string representations of Permissions to check.<a name="line.185"></a> |
| <FONT color="green">186</FONT> * @throws AuthorizationException if the user does not have all of the given permissions.<a name="line.186"></a> |
| <FONT color="green">187</FONT> * @since 0.9<a name="line.187"></a> |
| <FONT color="green">188</FONT> */<a name="line.188"></a> |
| <FONT color="green">189</FONT> void checkPermissions(PrincipalCollection subjectPrincipal, String... permissions) throws AuthorizationException;<a name="line.189"></a> |
| <FONT color="green">190</FONT> <a name="line.190"></a> |
| <FONT color="green">191</FONT> /**<a name="line.191"></a> |
| <FONT color="green">192</FONT> * Ensures the corresponding Subject/user<a name="line.192"></a> |
| <FONT color="green">193</FONT> * {@link Permission#implies(Permission) implies} all of the<a name="line.193"></a> |
| <FONT color="green">194</FONT> * specified permission strings.<a name="line.194"></a> |
| <FONT color="green">195</FONT> *<a name="line.195"></a> |
| <FONT color="green">196</FONT> * If the subject's exisiting associated permissions do not<a name="line.196"></a> |
| <FONT color="green">197</FONT> * {@link Permission#implies(Permission) imply} all of the given permissions,<a name="line.197"></a> |
| <FONT color="green">198</FONT> * an {@link AuthorizationException} will be thrown.<a name="line.198"></a> |
| <FONT color="green">199</FONT> *<a name="line.199"></a> |
| <FONT color="green">200</FONT> * @param subjectPrincipal the application-specific subject/user identifier.<a name="line.200"></a> |
| <FONT color="green">201</FONT> * @param permissions the Permissions to check.<a name="line.201"></a> |
| <FONT color="green">202</FONT> * @throws AuthorizationException if the user does not have all of the given permissions.<a name="line.202"></a> |
| <FONT color="green">203</FONT> */<a name="line.203"></a> |
| <FONT color="green">204</FONT> void checkPermissions(PrincipalCollection subjectPrincipal, Collection<Permission> permissions) throws AuthorizationException;<a name="line.204"></a> |
| <FONT color="green">205</FONT> <a name="line.205"></a> |
| <FONT color="green">206</FONT> /**<a name="line.206"></a> |
| <FONT color="green">207</FONT> * Returns <tt>true</tt> if the corresponding Subject/user has the specified role, <tt>false</tt> otherwise.<a name="line.207"></a> |
| <FONT color="green">208</FONT> *<a name="line.208"></a> |
| <FONT color="green">209</FONT> * @param subjectPrincipal the application-specific subject/user identifier.<a name="line.209"></a> |
| <FONT color="green">210</FONT> * @param roleIdentifier the application-specific role identifier (usually a role id or role name).<a name="line.210"></a> |
| <FONT color="green">211</FONT> * @return <tt>true</tt> if the corresponding subject has the specified role, <tt>false</tt> otherwise.<a name="line.211"></a> |
| <FONT color="green">212</FONT> */<a name="line.212"></a> |
| <FONT color="green">213</FONT> boolean hasRole(PrincipalCollection subjectPrincipal, String roleIdentifier);<a name="line.213"></a> |
| <FONT color="green">214</FONT> <a name="line.214"></a> |
| <FONT color="green">215</FONT> /**<a name="line.215"></a> |
| <FONT color="green">216</FONT> * Checks if the corresponding Subject/user has the specified roles, returning a boolean array indicating<a name="line.216"></a> |
| <FONT color="green">217</FONT> * which roles are associated with the given subject.<a name="line.217"></a> |
| <FONT color="green">218</FONT> *<a name="line.218"></a> |
| <FONT color="green">219</FONT> * <p>This is primarily a performance-enhancing method to help reduce the number of<a name="line.219"></a> |
| <FONT color="green">220</FONT> * {@link #hasRole} invocations over the wire in client/server systems.<a name="line.220"></a> |
| <FONT color="green">221</FONT> *<a name="line.221"></a> |
| <FONT color="green">222</FONT> * @param subjectPrincipal the application-specific subject/user identifier.<a name="line.222"></a> |
| <FONT color="green">223</FONT> * @param roleIdentifiers the application-specific role identifiers to check (usually role ids or role names).<a name="line.223"></a> |
| <FONT color="green">224</FONT> * @return an array of booleans whose indices correspond to the index of the<a name="line.224"></a> |
| <FONT color="green">225</FONT> * roles in the given identifiers. A true value indicates the user has the<a name="line.225"></a> |
| <FONT color="green">226</FONT> * role at that index. False indicates the user does not have the role at that index.<a name="line.226"></a> |
| <FONT color="green">227</FONT> */<a name="line.227"></a> |
| <FONT color="green">228</FONT> boolean[] hasRoles(PrincipalCollection subjectPrincipal, List<String> roleIdentifiers);<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 <tt>true</tt> if the corresponding Subject/user has all of the specified roles, <tt>false</tt> otherwise.<a name="line.231"></a> |
| <FONT color="green">232</FONT> *<a name="line.232"></a> |
| <FONT color="green">233</FONT> * @param subjectPrincipal the application-specific subject/user identifier.<a name="line.233"></a> |
| <FONT color="green">234</FONT> * @param roleIdentifiers the application-specific role identifiers to check (usually role ids or role names).<a name="line.234"></a> |
| <FONT color="green">235</FONT> * @return true if the user has all the roles, false otherwise.<a name="line.235"></a> |
| <FONT color="green">236</FONT> */<a name="line.236"></a> |
| <FONT color="green">237</FONT> boolean hasAllRoles(PrincipalCollection subjectPrincipal, Collection<String> roleIdentifiers);<a name="line.237"></a> |
| <FONT color="green">238</FONT> <a name="line.238"></a> |
| <FONT color="green">239</FONT> /**<a name="line.239"></a> |
| <FONT color="green">240</FONT> * Asserts the corresponding Subject/user has the specified role by returning quietly if they do or throwing an<a name="line.240"></a> |
| <FONT color="green">241</FONT> * {@link AuthorizationException} if they do not.<a name="line.241"></a> |
| <FONT color="green">242</FONT> *<a name="line.242"></a> |
| <FONT color="green">243</FONT> * @param subjectPrincipal the application-specific subject/user identifier.<a name="line.243"></a> |
| <FONT color="green">244</FONT> * @param roleIdentifier the application-specific role identifier (usually a role id or role name ).<a name="line.244"></a> |
| <FONT color="green">245</FONT> * @throws AuthorizationException<a name="line.245"></a> |
| <FONT color="green">246</FONT> * if the user does not have the role.<a name="line.246"></a> |
| <FONT color="green">247</FONT> */<a name="line.247"></a> |
| <FONT color="green">248</FONT> void checkRole(PrincipalCollection subjectPrincipal, String roleIdentifier) throws AuthorizationException;<a name="line.248"></a> |
| <FONT color="green">249</FONT> <a name="line.249"></a> |
| <FONT color="green">250</FONT> /**<a name="line.250"></a> |
| <FONT color="green">251</FONT> * Asserts the corresponding Subject/user has all of the specified roles by returning quietly if they do or<a name="line.251"></a> |
| <FONT color="green">252</FONT> * throwing an {@link AuthorizationException} if they do not.<a name="line.252"></a> |
| <FONT color="green">253</FONT> *<a name="line.253"></a> |
| <FONT color="green">254</FONT> * @param subjectPrincipal the application-specific subject/user identifier.<a name="line.254"></a> |
| <FONT color="green">255</FONT> * @param roleIdentifiers the application-specific role identifiers to check (usually role ids or role names).<a name="line.255"></a> |
| <FONT color="green">256</FONT> * @throws AuthorizationException<a name="line.256"></a> |
| <FONT color="green">257</FONT> * if the user does not have all of the specified roles.<a name="line.257"></a> |
| <FONT color="green">258</FONT> */<a name="line.258"></a> |
| <FONT color="green">259</FONT> void checkRoles(PrincipalCollection subjectPrincipal, Collection<String> roleIdentifiers) throws AuthorizationException;<a name="line.259"></a> |
| <FONT color="green">260</FONT> <a name="line.260"></a> |
| <FONT color="green">261</FONT> /**<a name="line.261"></a> |
| <FONT color="green">262</FONT> * Same as {@link #checkRoles(org.apache.shiro.subject.PrincipalCollection, java.util.Collection)<a name="line.262"></a> |
| <FONT color="green">263</FONT> * checkRoles(PrincipalCollection subjectPrincipal, Collection&lt;String&gt; roleIdentifiers)} but doesn't require a collection<a name="line.263"></a> |
| <FONT color="green">264</FONT> * as an argument.<a name="line.264"></a> |
| <FONT color="green">265</FONT> * Asserts the corresponding Subject/user has all of the specified roles by returning quietly if they do or<a name="line.265"></a> |
| <FONT color="green">266</FONT> * throwing an {@link AuthorizationException} if they do not.<a name="line.266"></a> |
| <FONT color="green">267</FONT> *<a name="line.267"></a> |
| <FONT color="green">268</FONT> * @param subjectPrincipal the application-specific subject/user identifier.<a name="line.268"></a> |
| <FONT color="green">269</FONT> * @param roleIdentifiers the application-specific role identifiers to check (usually role ids or role names).<a name="line.269"></a> |
| <FONT color="green">270</FONT> * @throws AuthorizationException<a name="line.270"></a> |
| <FONT color="green">271</FONT> * if the user does not have all of the specified roles.<a name="line.271"></a> |
| <FONT color="green">272</FONT> * <a name="line.272"></a> |
| <FONT color="green">273</FONT> * @since 1.1.0<a name="line.273"></a> |
| <FONT color="green">274</FONT> */<a name="line.274"></a> |
| <FONT color="green">275</FONT> void checkRoles(PrincipalCollection subjectPrincipal, String... roleIdentifiers) throws AuthorizationException;<a name="line.275"></a> |
| <FONT color="green">276</FONT> <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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
