| <!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>WildcardPermission xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/authz/permission/WildcardPermission.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.authz.permission; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authz.Permission; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.CollectionUtils; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils; |
| <a name="24" href="#24">24</a> |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.io.Serializable; |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.Iterator; |
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.LinkedHashSet; |
| <a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.util.List; |
| <a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> java.util.Set; |
| <a name="31" href="#31">31</a> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * A <code>WildcardPermission</code> is a very flexible permission construct supporting multiple levels of</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * permission matching. However, most people will probably follow some standard conventions as explained below.</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * <h3>Simple Usage</h3></em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * In the simplest form, <code>WildcardPermission</code> can be used as a simple permission string. You could grant a</em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * user an &quot;editNewsletter&quot; permission and then check to see if the user has the editNewsletter</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * permission by calling</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * <code>subject.isPermitted(&quot;editNewsletter&quot;)</code></em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * This is (mostly) equivalent to</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * <code>subject.isPermitted( new WildcardPermission(&quot;editNewsletter&quot;) )</code></em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * but more on that later.</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * The simple permission string may work for simple applications, but it requires you to have permissions like</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * <code>&quot;viewNewsletter&quot;</code>, <code>&quot;deleteNewsletter&quot;</code>,</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * <code>&quot;createNewsletter&quot;</code>, etc. You can also grant a user <code>&quot;*&quot;</code> permissions</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * using the wildcard character (giving this class its name), which means they have <em>all</em> permissions. But</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * using this approach there's no way to just say a user has &quot;all newsletter permissions&quot;.</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * For this reason, <code>WildcardPermission</code> supports multiple <em>levels</em> of permissioning.</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * <h3>Multiple Levels</h3></em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * WildcardPermission</code> also supports the concept of multiple <em>levels</em>. For example, you could</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * restructure the previous simple example by granting a user the permission <code>&quot;newsletter:edit&quot;</code>.</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * The colon in this example is a special character used by the <code>WildcardPermission</code> that delimits the</em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * next token in the permission.</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * In this example, the first token is the <em>domain</em> that is being operated on</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * and the second token is the <em>action</em> being performed. Each level can contain multiple values. So you</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * could simply grant a user the permission <code>&quot;newsletter:view,edit,create&quot;</code> which gives them</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * access to perform <code>view</code>, <code>edit</code>, and <code>create</code> actions in the <code>newsletter</code></em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * <em>domain</em>. Then you could check to see if the user has the <code>&quot;newsletter:create&quot;</code></em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * permission by calling</em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * <code>subject.isPermitted(&quot;newsletter:create&quot;)</code></em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * (which would return true).</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * In addition to granting multiple permissions via a single string, you can grant all permission for a particular</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * level. So if you wanted to grant a user all actions in the <code>newsletter</code> domain, you could simply give</em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * them <code>&quot;newsletter:*&quot;</code>. Now, any permission check for <code>&quot;newsletter:XXX&quot;</code></em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * will return <code>true</code>. It is also possible to use the wildcard token at the domain level (or both): so you</em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * could grant a user the <code>&quot;view&quot;</code> action across all domains <code>&quot;*:view&quot;</code>.</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * <h3>Instance-level Access Control</h3></em> |
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * Another common usage of the <code>WildcardPermission</code> is to model instance-level Access Control Lists.</em> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * In this scenario you use three tokens - the first is the <em>domain</em>, the second is the <em>action</em>, and</em> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * the third is the <em>instance</em> you are acting on.</em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * So for example you could grant a user <code>&quot;newsletter:edit:12,13,18&quot;</code>. In this example, assume</em> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * that the third token is the system's ID of the newsletter. That would allow the user to edit newsletters</em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * <code>12</code>, <code>13</code>, and <code>18</code>. This is an extremely powerful way to express permissions,</em> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * since you can now say things like <code>&quot;newsletter:*:13&quot;</code> (grant a user all actions for newsletter</em> |
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * <code>13</code>), <code>&quot;newsletter:view,create,edit:*&quot;</code> (allow the user to</em> |
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * <code>view</code>, <code>create</code>, or <code>edit</code> <em>any</em> newsletter), or</em> |
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * <code>&quot;newsletter:*:*</code> (allow the user to perform <em>any</em> action on <em>any</em> newsletter).</em> |
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * To perform checks against these instance-level permissions, the application should include the instance ID in the</em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * permission check like so:</em> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * <code>subject.isPermitted( &quot;newsletter:edit:13&quot; )</code></em> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * There is no limit to the number of tokens that can be used, so it is up to your imagination in terms of ways that</em> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * this could be used in your application. However, the Shiro team likes to standardize some common usages shown</em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * above to help people get started and provide consistency in the Shiro community.</em> |
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="107" href="#107">107</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/authz/permission/WildcardPermission.html">WildcardPermission</a> implements Permission, Serializable { |
| <a name="108" href="#108">108</a> |
| <a name="109" href="#109">109</a> <em class="jxr_comment">//TODO - JavaDoc methods</em> |
| <a name="110" href="#110">110</a> |
| <a name="111" href="#111">111</a> <em class="jxr_comment">/*<em class="jxr_comment">--------------------------------------------</em></em> |
| <a name="112" href="#112">112</a> <em class="jxr_comment"> | C O N S T A N T S |</em> |
| <a name="113" href="#113">113</a> <em class="jxr_comment"> ============================================*/</em> |
| <a name="114" href="#114">114</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String WILDCARD_TOKEN = <span class="jxr_string">"*"</span>; |
| <a name="115" href="#115">115</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PART_DIVIDER_TOKEN = <span class="jxr_string">":"</span>; |
| <a name="116" href="#116">116</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SUBPART_DIVIDER_TOKEN = <span class="jxr_string">","</span>; |
| <a name="117" href="#117">117</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> DEFAULT_CASE_SENSITIVE = false; |
| <a name="118" href="#118">118</a> |
| <a name="119" href="#119">119</a> <em class="jxr_comment">/*<em class="jxr_comment">--------------------------------------------</em></em> |
| <a name="120" href="#120">120</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="121" href="#121">121</a> <em class="jxr_comment"> ============================================*/</em> |
| <a name="122" href="#122">122</a> <strong class="jxr_keyword">private</strong> List<Set<String>> parts; |
| <a name="123" href="#123">123</a> |
| <a name="124" href="#124">124</a> <em class="jxr_comment">/*<em class="jxr_comment">--------------------------------------------</em></em> |
| <a name="125" href="#125">125</a> <em class="jxr_comment"> | C O N S T R U C T O R S |</em> |
| <a name="126" href="#126">126</a> <em class="jxr_comment"> ============================================*/</em> |
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * Default no-arg constructor for subclasses only - end-user developers instantiating Permission instances must</em> |
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * provide a wildcard string at a minimum, since Permission instances are immutable once instantiated.</em> |
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * Note that the WildcardPermission class is very robust and typically subclasses are not necessary unless you</em> |
| <a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * wish to create type-safe Permission objects that would be used in your application, such as perhaps a</em> |
| <a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * {@code UserPermission}, {@code SystemPermission}, {@code PrinterPermission}, etc. If you want such type-safe</em> |
| <a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * permission usage, consider subclassing the {@link DomainPermission DomainPermission} class for your needs.</em> |
| <a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="136" href="#136">136</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/authz/permission/WildcardPermission.html">WildcardPermission</a>() { |
| <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> <a href="../../../../../org/apache/shiro/authz/permission/WildcardPermission.html">WildcardPermission</a>(String wildcardString) { |
| <a name="140" href="#140">140</a> <strong class="jxr_keyword">this</strong>(wildcardString, DEFAULT_CASE_SENSITIVE); |
| <a name="141" href="#141">141</a> } |
| <a name="142" href="#142">142</a> |
| <a name="143" href="#143">143</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/authz/permission/WildcardPermission.html">WildcardPermission</a>(String wildcardString, <strong class="jxr_keyword">boolean</strong> caseSensitive) { |
| <a name="144" href="#144">144</a> setParts(wildcardString, caseSensitive); |
| <a name="145" href="#145">145</a> } |
| <a name="146" href="#146">146</a> |
| <a name="147" href="#147">147</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setParts(String wildcardString) { |
| <a name="148" href="#148">148</a> setParts(wildcardString, DEFAULT_CASE_SENSITIVE); |
| <a name="149" href="#149">149</a> } |
| <a name="150" href="#150">150</a> |
| <a name="151" href="#151">151</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setParts(String wildcardString, <strong class="jxr_keyword">boolean</strong> caseSensitive) { |
| <a name="152" href="#152">152</a> wildcardString = StringUtils.clean(wildcardString); |
| <a name="153" href="#153">153</a> |
| <a name="154" href="#154">154</a> <strong class="jxr_keyword">if</strong> (wildcardString == <strong class="jxr_keyword">null</strong> || wildcardString.isEmpty()) { |
| <a name="155" href="#155">155</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Wildcard string cannot be null or empty. Make sure permission strings are properly formatted."</span>); |
| <a name="156" href="#156">156</a> } |
| <a name="157" href="#157">157</a> |
| <a name="158" href="#158">158</a> <strong class="jxr_keyword">if</strong> (!caseSensitive) { |
| <a name="159" href="#159">159</a> wildcardString = wildcardString.toLowerCase(); |
| <a name="160" href="#160">160</a> } |
| <a name="161" href="#161">161</a> |
| <a name="162" href="#162">162</a> List<String> parts = CollectionUtils.asList(wildcardString.split(PART_DIVIDER_TOKEN)); |
| <a name="163" href="#163">163</a> |
| <a name="164" href="#164">164</a> <strong class="jxr_keyword">this</strong>.parts = <strong class="jxr_keyword">new</strong> ArrayList<Set<String>>(); |
| <a name="165" href="#165">165</a> <strong class="jxr_keyword">for</strong> (String part : parts) { |
| <a name="166" href="#166">166</a> Set<String> subparts = CollectionUtils.asSet(part.split(SUBPART_DIVIDER_TOKEN)); |
| <a name="167" href="#167">167</a> |
| <a name="168" href="#168">168</a> <strong class="jxr_keyword">if</strong> (subparts.isEmpty()) { |
| <a name="169" href="#169">169</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Wildcard string cannot contain parts with only dividers. Make sure permission strings are properly formatted."</span>); |
| <a name="170" href="#170">170</a> } |
| <a name="171" href="#171">171</a> <strong class="jxr_keyword">this</strong>.parts.add(subparts); |
| <a name="172" href="#172">172</a> } |
| <a name="173" href="#173">173</a> |
| <a name="174" href="#174">174</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.parts.isEmpty()) { |
| <a name="175" href="#175">175</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Wildcard string cannot contain only dividers. Make sure permission strings are properly formatted."</span>); |
| <a name="176" href="#176">176</a> } |
| <a name="177" href="#177">177</a> } |
| <a name="178" href="#178">178</a> |
| <a name="179" href="#179">179</a> <em class="jxr_comment">/*<em class="jxr_comment">--------------------------------------------</em></em> |
| <a name="180" href="#180">180</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="181" href="#181">181</a> <em class="jxr_comment"> ============================================*/</em> |
| <a name="182" href="#182">182</a> <strong class="jxr_keyword">protected</strong> List<Set<String>> getParts() { |
| <a name="183" href="#183">183</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.parts; |
| <a name="184" href="#184">184</a> } |
| <a name="185" href="#185">185</a> |
| <a name="186" href="#186">186</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * Sets the pre-split String parts of this <code>WildcardPermission</code>.</em> |
| <a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> * @since 1.3.0</em> |
| <a name="189" href="#189">189</a> <em class="jxr_javadoccomment"> * @param parts pre-split String parts.</em> |
| <a name="190" href="#190">190</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="191" href="#191">191</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setParts(List<Set<String>> parts) { |
| <a name="192" href="#192">192</a> <strong class="jxr_keyword">this</strong>.parts = parts; |
| <a name="193" href="#193">193</a> } |
| <a name="194" href="#194">194</a> |
| <a name="195" href="#195">195</a> <em class="jxr_comment">/*<em class="jxr_comment">--------------------------------------------</em></em> |
| <a name="196" href="#196">196</a> <em class="jxr_comment"> | M E T H O D S |</em> |
| <a name="197" href="#197">197</a> <em class="jxr_comment"> ============================================*/</em> |
| <a name="198" href="#198">198</a> |
| <a name="199" href="#199">199</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> implies(<a href="../../../../../org/apache/shiro/authz/Permission.html">Permission</a> p) { |
| <a name="200" href="#200">200</a> <em class="jxr_comment">// By default only supports comparisons with other WildcardPermissions</em> |
| <a name="201" href="#201">201</a> <strong class="jxr_keyword">if</strong> (!(p instanceof WildcardPermission)) { |
| <a name="202" href="#202">202</a> <strong class="jxr_keyword">return</strong> false; |
| <a name="203" href="#203">203</a> } |
| <a name="204" href="#204">204</a> |
| <a name="205" href="#205">205</a> <a href="../../../../../org/apache/shiro/authz/permission/WildcardPermission.html">WildcardPermission</a> wp = (WildcardPermission) p; |
| <a name="206" href="#206">206</a> |
| <a name="207" href="#207">207</a> List<Set<String>> otherParts = wp.getParts(); |
| <a name="208" href="#208">208</a> |
| <a name="209" href="#209">209</a> <strong class="jxr_keyword">int</strong> i = 0; |
| <a name="210" href="#210">210</a> <strong class="jxr_keyword">for</strong> (Set<String> otherPart : otherParts) { |
| <a name="211" href="#211">211</a> <em class="jxr_comment">// If this permission has less parts than the other permission, everything after the number of parts contained</em> |
| <a name="212" href="#212">212</a> <em class="jxr_comment">// in this permission is automatically implied, so return true</em> |
| <a name="213" href="#213">213</a> <strong class="jxr_keyword">if</strong> (getParts().size() - 1 < i) { |
| <a name="214" href="#214">214</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; |
| <a name="215" href="#215">215</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="216" href="#216">216</a> Set<String> part = getParts().get(i); |
| <a name="217" href="#217">217</a> <strong class="jxr_keyword">if</strong> (!part.contains(WILDCARD_TOKEN) && !part.containsAll(otherPart)) { |
| <a name="218" href="#218">218</a> <strong class="jxr_keyword">return</strong> false; |
| <a name="219" href="#219">219</a> } |
| <a name="220" href="#220">220</a> i++; |
| <a name="221" href="#221">221</a> } |
| <a name="222" href="#222">222</a> } |
| <a name="223" href="#223">223</a> |
| <a name="224" href="#224">224</a> <em class="jxr_comment">// If this permission has more parts than the other parts, only imply it if all of the other parts are wildcards</em> |
| <a name="225" href="#225">225</a> <strong class="jxr_keyword">for</strong> (; i < getParts().size(); i++) { |
| <a name="226" href="#226">226</a> Set<String> part = getParts().get(i); |
| <a name="227" href="#227">227</a> <strong class="jxr_keyword">if</strong> (!part.contains(WILDCARD_TOKEN)) { |
| <a name="228" href="#228">228</a> <strong class="jxr_keyword">return</strong> false; |
| <a name="229" href="#229">229</a> } |
| <a name="230" href="#230">230</a> } |
| <a name="231" href="#231">231</a> |
| <a name="232" href="#232">232</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; |
| <a name="233" href="#233">233</a> } |
| <a name="234" href="#234">234</a> |
| <a name="235" href="#235">235</a> <strong class="jxr_keyword">public</strong> String toString() { |
| <a name="236" href="#236">236</a> StringBuilder buffer = <strong class="jxr_keyword">new</strong> StringBuilder(); |
| <a name="237" href="#237">237</a> <strong class="jxr_keyword">for</strong> (Set<String> part : parts) { |
| <a name="238" href="#238">238</a> <strong class="jxr_keyword">if</strong> (buffer.length() > 0) { |
| <a name="239" href="#239">239</a> buffer.append(PART_DIVIDER_TOKEN); |
| <a name="240" href="#240">240</a> } |
| <a name="241" href="#241">241</a> Iterator<String> partIt = part.iterator(); |
| <a name="242" href="#242">242</a> <strong class="jxr_keyword">while</strong>(partIt.hasNext()) { |
| <a name="243" href="#243">243</a> buffer.append(partIt.next()); |
| <a name="244" href="#244">244</a> <strong class="jxr_keyword">if</strong> (partIt.hasNext()) { |
| <a name="245" href="#245">245</a> buffer.append(SUBPART_DIVIDER_TOKEN); |
| <a name="246" href="#246">246</a> } |
| <a name="247" href="#247">247</a> } |
| <a name="248" href="#248">248</a> } |
| <a name="249" href="#249">249</a> <strong class="jxr_keyword">return</strong> buffer.toString(); |
| <a name="250" href="#250">250</a> } |
| <a name="251" href="#251">251</a> |
| <a name="252" href="#252">252</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> equals(Object o) { |
| <a name="253" href="#253">253</a> <strong class="jxr_keyword">if</strong> (o instanceof WildcardPermission) { |
| <a name="254" href="#254">254</a> <a href="../../../../../org/apache/shiro/authz/permission/WildcardPermission.html">WildcardPermission</a> wp = (WildcardPermission) o; |
| <a name="255" href="#255">255</a> <strong class="jxr_keyword">return</strong> parts.equals(wp.parts); |
| <a name="256" href="#256">256</a> } |
| <a name="257" href="#257">257</a> <strong class="jxr_keyword">return</strong> false; |
| <a name="258" href="#258">258</a> } |
| <a name="259" href="#259">259</a> |
| <a name="260" href="#260">260</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> hashCode() { |
| <a name="261" href="#261">261</a> <strong class="jxr_keyword">return</strong> parts.hashCode(); |
| <a name="262" href="#262">262</a> } |
| <a name="263" href="#263">263</a> |
| <a name="264" href="#264">264</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
