| <!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=UTF-8" /> |
| <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 class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> |
| <a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L10" href="#L10">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 class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.authz.permission; |
| <a class="jxr_linenumber" name="L20" href="#L20">20</a> |
| <a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authz.Permission; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.CollectionUtils; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils; |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.io.Serializable; |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.Iterator; |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.LinkedHashSet; |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.util.List; |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.util.Set; |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * A <code>WildcardPermission</code> is a very flexible permission construct supporting multiple levels of</em> |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * permission matching. However, most people will probably follow some standard conventions as explained below.</em> |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * <h3>Simple Usage</h3></em> |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L38" href="#L38">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 class="jxr_linenumber" name="L39" href="#L39">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 class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * permission by calling</em> |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * <code>subject.isPermitted(&quot;editNewsletter&quot;)</code></em> |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * This is (mostly) equivalent to</em> |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * <code>subject.isPermitted( new WildcardPermission(&quot;editNewsletter&quot;) )</code></em> |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * but more on that later.</em> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L50" href="#L50">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 class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * <code>&quot;viewNewsletter&quot;</code>, <code>&quot;deleteNewsletter&quot;</code>,</em> |
| <a class="jxr_linenumber" name="L52" href="#L52">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 class="jxr_linenumber" name="L53" href="#L53">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 class="jxr_linenumber" name="L54" href="#L54">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 class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * For this reason, <code>WildcardPermission</code> supports multiple <em>levels</em> of permissioning.</em> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * <h3>Multiple Levels</h3></em> |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * WildcardPermission</code> also supports the concept of multiple <em>levels</em>. For example, you could</em> |
| <a class="jxr_linenumber" name="L61" href="#L61">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 class="jxr_linenumber" name="L62" href="#L62">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 class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * next token in the permission.</em> |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * In this example, the first token is the <em>domain</em> that is being operated on</em> |
| <a class="jxr_linenumber" name="L66" href="#L66">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 class="jxr_linenumber" name="L67" href="#L67">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 class="jxr_linenumber" name="L68" href="#L68">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 class="jxr_linenumber" name="L69" href="#L69">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 class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * permission by calling</em> |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * <code>subject.isPermitted(&quot;newsletter:create&quot;)</code></em> |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * (which would return true).</em> |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L76" href="#L76">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 class="jxr_linenumber" name="L77" href="#L77">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 class="jxr_linenumber" name="L78" href="#L78">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 class="jxr_linenumber" name="L79" href="#L79">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 class="jxr_linenumber" name="L80" href="#L80">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 class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * <h3>Instance-level Access Control</h3></em> |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * Another common usage of the <code>WildcardPermission</code> is to model instance-level Access Control Lists.</em> |
| <a class="jxr_linenumber" name="L85" href="#L85">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 class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * the third is the <em>instance</em> you are acting on.</em> |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L88" href="#L88">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 class="jxr_linenumber" name="L89" href="#L89">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 class="jxr_linenumber" name="L90" href="#L90">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 class="jxr_linenumber" name="L91" href="#L91">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 class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * <code>13</code>), <code>&quot;newsletter:view,create,edit:*&quot;</code> (allow the user to</em> |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * <code>view</code>, <code>create</code>, or <code>edit</code> <em>any</em> newsletter), or</em> |
| <a class="jxr_linenumber" name="L94" href="#L94">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 class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L96" href="#L96">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 class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * permission check like so:</em> |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * <code>subject.isPermitted( &quot;newsletter:edit:13&quot; )</code></em> |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L101" href="#L101">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 class="jxr_linenumber" name="L102" href="#L102">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 class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * above to help people get started and provide consistency in the Shiro community.</em> |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="WildcardPermission" href="../../../../../org/apache/shiro/authz/permission/WildcardPermission.html#WildcardPermission">WildcardPermission</a> <strong class="jxr_keyword">implements</strong> Permission, Serializable { |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_comment">//TODO - JavaDoc methods</em> |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_comment">/*--------------------------------------------</em> |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_comment"> | C O N S T A N T S |</em> |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_comment"> ============================================*/</em> |
| <a class="jxr_linenumber" name="L114" href="#L114">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 class="jxr_linenumber" name="L115" href="#L115">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 class="jxr_linenumber" name="L116" href="#L116">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 class="jxr_linenumber" name="L117" href="#L117">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 class="jxr_linenumber" name="L118" href="#L118">118</a> |
| <a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_comment">/*--------------------------------------------</em> |
| <a class="jxr_linenumber" name="L120" href="#L120">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 class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_comment"> ============================================*/</em> |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">private</strong> List<Set<String>> parts; |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> |
| <a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_comment">/*--------------------------------------------</em> |
| <a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_comment"> | C O N S T R U C T O R S |</em> |
| <a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_comment"> ============================================*/</em> |
| <a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * Default no-arg constructor for subclasses only - end-user developers instantiating Permission instances must</em> |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * provide a wildcard string at a minimum, since Permission instances are immutable once instantiated.</em> |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * Note that the WildcardPermission class is very robust and typically subclasses are not necessary unless you</em> |
| <a class="jxr_linenumber" name="L132" href="#L132">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 class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * {@code UserPermission}, {@code SystemPermission}, {@code PrinterPermission}, etc. If you want such type-safe</em> |
| <a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * permission usage, consider subclassing the {@link DomainPermission DomainPermission} class for your needs.</em> |
| <a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">protected</strong> <a name="WildcardPermission" href="../../../../../org/apache/shiro/authz/permission/WildcardPermission.html#WildcardPermission">WildcardPermission</a>() { |
| <a class="jxr_linenumber" name="L137" href="#L137">137</a> } |
| <a class="jxr_linenumber" name="L138" href="#L138">138</a> |
| <a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">public</strong> <a name="WildcardPermission" href="../../../../../org/apache/shiro/authz/permission/WildcardPermission.html#WildcardPermission">WildcardPermission</a>(String wildcardString) { |
| <a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">this</strong>(wildcardString, DEFAULT_CASE_SENSITIVE); |
| <a class="jxr_linenumber" name="L141" href="#L141">141</a> } |
| <a class="jxr_linenumber" name="L142" href="#L142">142</a> |
| <a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">public</strong> <a name="WildcardPermission" href="../../../../../org/apache/shiro/authz/permission/WildcardPermission.html#WildcardPermission">WildcardPermission</a>(String wildcardString, <strong class="jxr_keyword">boolean</strong> caseSensitive) { |
| <a class="jxr_linenumber" name="L144" href="#L144">144</a> setParts(wildcardString, caseSensitive); |
| <a class="jxr_linenumber" name="L145" href="#L145">145</a> } |
| <a class="jxr_linenumber" name="L146" href="#L146">146</a> |
| <a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setParts(String wildcardString) { |
| <a class="jxr_linenumber" name="L148" href="#L148">148</a> setParts(wildcardString, DEFAULT_CASE_SENSITIVE); |
| <a class="jxr_linenumber" name="L149" href="#L149">149</a> } |
| <a class="jxr_linenumber" name="L150" href="#L150">150</a> |
| <a class="jxr_linenumber" name="L151" href="#L151">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 class="jxr_linenumber" name="L152" href="#L152">152</a> wildcardString = StringUtils.clean(wildcardString); |
| <a class="jxr_linenumber" name="L153" href="#L153">153</a> |
| <a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">if</strong> (wildcardString == <strong class="jxr_keyword">null</strong> || wildcardString.isEmpty()) { |
| <a class="jxr_linenumber" name="L155" href="#L155">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 class="jxr_linenumber" name="L156" href="#L156">156</a> } |
| <a class="jxr_linenumber" name="L157" href="#L157">157</a> |
| <a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">if</strong> (!caseSensitive) { |
| <a class="jxr_linenumber" name="L159" href="#L159">159</a> wildcardString = wildcardString.toLowerCase(); |
| <a class="jxr_linenumber" name="L160" href="#L160">160</a> } |
| <a class="jxr_linenumber" name="L161" href="#L161">161</a> |
| <a class="jxr_linenumber" name="L162" href="#L162">162</a> List<String> parts = CollectionUtils.asList(wildcardString.split(PART_DIVIDER_TOKEN)); |
| <a class="jxr_linenumber" name="L163" href="#L163">163</a> |
| <a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">this</strong>.parts = <strong class="jxr_keyword">new</strong> ArrayList<Set<String>>(); |
| <a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">for</strong> (String part : parts) { |
| <a class="jxr_linenumber" name="L166" href="#L166">166</a> Set<String> subparts = CollectionUtils.asSet(part.split(SUBPART_DIVIDER_TOKEN)); |
| <a class="jxr_linenumber" name="L167" href="#L167">167</a> |
| <a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">if</strong> (subparts.isEmpty()) { |
| <a class="jxr_linenumber" name="L169" href="#L169">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 class="jxr_linenumber" name="L170" href="#L170">170</a> } |
| <a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">this</strong>.parts.add(subparts); |
| <a class="jxr_linenumber" name="L172" href="#L172">172</a> } |
| <a class="jxr_linenumber" name="L173" href="#L173">173</a> |
| <a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.parts.isEmpty()) { |
| <a class="jxr_linenumber" name="L175" href="#L175">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 class="jxr_linenumber" name="L176" href="#L176">176</a> } |
| <a class="jxr_linenumber" name="L177" href="#L177">177</a> } |
| <a class="jxr_linenumber" name="L178" href="#L178">178</a> |
| <a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_comment">/*--------------------------------------------</em> |
| <a class="jxr_linenumber" name="L180" href="#L180">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 class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_comment"> ============================================*/</em> |
| <a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">protected</strong> List<Set<String>> getParts() { |
| <a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.parts; |
| <a class="jxr_linenumber" name="L184" href="#L184">184</a> } |
| <a class="jxr_linenumber" name="L185" href="#L185">185</a> |
| <a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * Sets the pre-split String parts of this <code>WildcardPermission</code>.</em> |
| <a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * @since 1.3.0</em> |
| <a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * @param parts pre-split String parts.</em> |
| <a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setParts(List<Set<String>> parts) { |
| <a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">this</strong>.parts = parts; |
| <a class="jxr_linenumber" name="L193" href="#L193">193</a> } |
| <a class="jxr_linenumber" name="L194" href="#L194">194</a> |
| <a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_comment">/*--------------------------------------------</em> |
| <a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_comment"> | M E T H O D S |</em> |
| <a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_comment"> ============================================*/</em> |
| <a class="jxr_linenumber" name="L198" href="#L198">198</a> |
| <a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> implies(<a name="Permission" href="../../../../../org/apache/shiro/authz/Permission.html#Permission">Permission</a> p) { |
| <a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_comment">// By default only supports comparisons with other WildcardPermissions</em> |
| <a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong class="jxr_keyword">if</strong> (!(p instanceof <a name="WildcardPermission" href="../../../../../org/apache/shiro/authz/permission/WildcardPermission.html#WildcardPermission">WildcardPermission</a>)) { |
| <a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">return</strong> false; |
| <a class="jxr_linenumber" name="L203" href="#L203">203</a> } |
| <a class="jxr_linenumber" name="L204" href="#L204">204</a> |
| <a class="jxr_linenumber" name="L205" href="#L205">205</a> <a name="WildcardPermissi<a name="WildcardPermission" href="../../../../../org/apache/shiro/authz/permission/WildcardPermission.html#WildcardPermission">WildcardPermission</a>/../../org/apache/shiro/authz/permission/WildcardPermission.html#WildcardPermission">WildcardPermission</a> wp = (<a name="WildcardPermission" href="../../../../../org/apache/shiro/authz/permission/WildcardPermission.html#WildcardPermission">WildcardPermission</a>) p; |
| <a class="jxr_linenumber" name="L206" href="#L206">206</a> |
| <a class="jxr_linenumber" name="L207" href="#L207">207</a> List<Set<String>> otherParts = wp.getParts(); |
| <a class="jxr_linenumber" name="L208" href="#L208">208</a> |
| <a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">int</strong> i = 0; |
| <a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">for</strong> (Set<String> otherPart : otherParts) { |
| <a class="jxr_linenumber" name="L211" href="#L211">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 class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_comment">// in this permission is automatically implied, so return true</em> |
| <a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">if</strong> (getParts().size() - 1 < i) { |
| <a class="jxr_linenumber" name="L214" href="#L214">214</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="L215" href="#L215">215</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L216" href="#L216">216</a> Set<String> part = getParts().get(i); |
| <a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">if</strong> (!part.contains(WILDCARD_TOKEN) && !part.containsAll(otherPart)) { |
| <a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">return</strong> false; |
| <a class="jxr_linenumber" name="L219" href="#L219">219</a> } |
| <a class="jxr_linenumber" name="L220" href="#L220">220</a> i++; |
| <a class="jxr_linenumber" name="L221" href="#L221">221</a> } |
| <a class="jxr_linenumber" name="L222" href="#L222">222</a> } |
| <a class="jxr_linenumber" name="L223" href="#L223">223</a> |
| <a class="jxr_linenumber" name="L224" href="#L224">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 class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">for</strong> (; i < getParts().size(); i++) { |
| <a class="jxr_linenumber" name="L226" href="#L226">226</a> Set<String> part = getParts().get(i); |
| <a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">if</strong> (!part.contains(WILDCARD_TOKEN)) { |
| <a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">return</strong> false; |
| <a class="jxr_linenumber" name="L229" href="#L229">229</a> } |
| <a class="jxr_linenumber" name="L230" href="#L230">230</a> } |
| <a class="jxr_linenumber" name="L231" href="#L231">231</a> |
| <a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="L233" href="#L233">233</a> } |
| <a class="jxr_linenumber" name="L234" href="#L234">234</a> |
| <a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">public</strong> String toString() { |
| <a class="jxr_linenumber" name="L236" href="#L236">236</a> StringBuilder buffer = <strong class="jxr_keyword">new</strong> StringBuilder(); |
| <a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">for</strong> (Set<String> part : parts) { |
| <a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">if</strong> (buffer.length() > 0) { |
| <a class="jxr_linenumber" name="L239" href="#L239">239</a> buffer.append(PART_DIVIDER_TOKEN); |
| <a class="jxr_linenumber" name="L240" href="#L240">240</a> } |
| <a class="jxr_linenumber" name="L241" href="#L241">241</a> Iterator<String> partIt = part.iterator(); |
| <a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">while</strong>(partIt.hasNext()) { |
| <a class="jxr_linenumber" name="L243" href="#L243">243</a> buffer.append(partIt.next()); |
| <a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">if</strong> (partIt.hasNext()) { |
| <a class="jxr_linenumber" name="L245" href="#L245">245</a> buffer.append(SUBPART_DIVIDER_TOKEN); |
| <a class="jxr_linenumber" name="L246" href="#L246">246</a> } |
| <a class="jxr_linenumber" name="L247" href="#L247">247</a> } |
| <a class="jxr_linenumber" name="L248" href="#L248">248</a> } |
| <a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">return</strong> buffer.toString(); |
| <a class="jxr_linenumber" name="L250" href="#L250">250</a> } |
| <a class="jxr_linenumber" name="L251" href="#L251">251</a> |
| <a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> equals(Object o) { |
| <a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong class="jxr_keyword">if</strong> (o instanceof <a name="WildcardPermission" href="../../../../../org/apache/shiro/authz/permission/WildcardPermission.html#WildcardPermission">WildcardPermission</a>) { |
| <a class="jxr_linenumber" name="L254" href="#L254">254</a> <a name="WildcardPermissi<a name="WildcardPermission" href="../../../../../org/apache/shiro/authz/permission/WildcardPermission.html#WildcardPermission">WildcardPermission</a>/../../org/apache/shiro/authz/permission/WildcardPermission.html#WildcardPermission">WildcardPermission</a> wp = (<a name="WildcardPermission" href="../../../../../org/apache/shiro/authz/permission/WildcardPermission.html#WildcardPermission">WildcardPermission</a>) o; |
| <a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">return</strong> parts.equals(wp.parts); |
| <a class="jxr_linenumber" name="L256" href="#L256">256</a> } |
| <a class="jxr_linenumber" name="L257" href="#L257">257</a> <strong class="jxr_keyword">return</strong> false; |
| <a class="jxr_linenumber" name="L258" href="#L258">258</a> } |
| <a class="jxr_linenumber" name="L259" href="#L259">259</a> |
| <a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> hashCode() { |
| <a class="jxr_linenumber" name="L261" href="#L261">261</a> <strong class="jxr_keyword">return</strong> parts.hashCode(); |
| <a class="jxr_linenumber" name="L262" href="#L262">262</a> } |
| <a class="jxr_linenumber" name="L263" href="#L263">263</a> |
| <a class="jxr_linenumber" name="L264" href="#L264">264</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 2004–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
