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