| <!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>HttpMethodPermissionFilter xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../../apidocs/org/apache/shiro/web/filter/authz/HttpMethodPermissionFilter.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.web.filter.authz; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a name="24" href="#24">24</a> |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletRequest; |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletResponse; |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest; |
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.io.IOException; |
| <a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.util.HashMap; |
| <a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> java.util.Map; |
| <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 filter that translates an HTTP Request's Method (eg GET, POST, etc)</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * into an corresponding action (verb) and uses that verb to construct a permission that will be checked to determine</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * access.</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * This Filter is primarily provided to support REST environments where the type (Method)</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * of request translates to an action being performed on one or more resources. This paradigm works well with Shiro's</em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * concepts of using permissions for access control and can be leveraged to easily perform permission checks.</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * This filter functions as follows:</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * <li>The incoming HTTP request's Method (GET, POST, PUT, DELETE, etc) is discovered.</li></em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * <li>The Method is translated into a more 'application friendly' verb, such as 'create', edit', 'delete', etc.</li></em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * <li>The verb is appended to any configured permissions for the</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.web.filter.PathMatchingFilter currently matching path}.</li></em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * <li>If the current {@code Subject} {@link org.apache.shiro.subject.Subject#isPermitted(String) isPermitted} to</em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * perform the resolved action, the request is allowed to continue.</li></em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * For example, if the following filter chain was defined, where 'rest' was the name given to a filter instance of</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * this class:</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * /user/** = rest[user]</pre></em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * Then an HTTP {@code GET} request to {@code /user/1234} would translate to the constructed permission</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * {@code user:read} (GET is mapped to the 'read' action) and execute the permission check</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * <code>Subject.isPermitted(&quot;user:read&quot;)</code> in order to allow the request to continue.</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * Similarly, an HTTP {@code POST} to {@code /user} would translate to the constructed permission</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * {@code user:create} (POST is mapped to the 'create' action) and execute the permission check</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * <code>Subject.isPermitted(&quot;user:create&quot;)</code> in order to allow the request to continue.</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * <h3>Method To Verb Mapping</h3></em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * The following table represents the default HTTP Method-to-action verb mapping:</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * <table></em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * <tr><th>HTTP Method</th><th>Mapped Action</th><th>Example Permission</th><th>Runtime Check</th></tr></em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * <tr><td>head</td><td>read</td><td>perm1</td><td>perm1:read</td></tr></em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * <tr><td>get</td><td>read</td><td>perm2</td><td>perm2:read</td></tr></em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * <tr><td>put</td><td>update</td><td>perm3</td><td>perm3:update</td></tr></em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * <tr><td>post</td><td>create</td><td>perm4</td><td>perm4:create</td></tr></em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * <tr><td>mkcol</td><td>create</td><td>perm5</td><td>perm5:create</td></tr></em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * <tr><td>options</td><td>read</td><td>perm6</td><td>perm6:read</td></tr></em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * <tr><td>trace</td><td>read</td><td>perm7</td><td>perm7:read</td></tr></em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * </table></em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="78" href="#78">78</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/shiro/web/filter/authz/HttpMethodPermissionFilter.html">HttpMethodPermissionFilter</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/shiro/web/filter/authz/PermissionsAuthorizationFilter.html">PermissionsAuthorizationFilter</a> { |
| <a name="79" href="#79">79</a> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * This class's private logger.</em> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="83" href="#83">83</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(HttpMethodPermissionFilter.<strong class="jxr_keyword">class</strong>); |
| <a name="84" href="#84">84</a> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * Map that contains a mapping between http methods to permission actions (verbs)</em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="88" href="#88">88</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Map<String, String> httpMethodActions = <strong class="jxr_keyword">new</strong> HashMap<String, String>(); |
| <a name="89" href="#89">89</a> |
| <a name="90" href="#90">90</a> <em class="jxr_comment">//Actions representing HTTP Method values (GET -> read, POST -> create, etc)</em> |
| <a name="91" href="#91">91</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CREATE_ACTION = <span class="jxr_string">"create"</span>; |
| <a name="92" href="#92">92</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String READ_ACTION = <span class="jxr_string">"read"</span>; |
| <a name="93" href="#93">93</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String UPDATE_ACTION = <span class="jxr_string">"update"</span>; |
| <a name="94" href="#94">94</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DELETE_ACTION = <span class="jxr_string">"delete"</span>; |
| <a name="95" href="#95">95</a> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * Enum of constants for well-defined mapping values. Used in the Filter's constructor to perform the map instance</em> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * used at runtime.</em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="100" href="#100">100</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> enum <a href="../../../../../../org/apache/shiro/web/filter/authz/HttpMethodPermissionFilter.html">HttpMethodAction</a> { |
| <a name="101" href="#101">101</a> |
| <a name="102" href="#102">102</a> DELETE(DELETE_ACTION), |
| <a name="103" href="#103">103</a> GET(READ_ACTION), |
| <a name="104" href="#104">104</a> HEAD(READ_ACTION), |
| <a name="105" href="#105">105</a> MKCOL(CREATE_ACTION), <em class="jxr_comment">//webdav, but useful here</em> |
| <a name="106" href="#106">106</a> OPTIONS(READ_ACTION), |
| <a name="107" href="#107">107</a> POST(CREATE_ACTION), |
| <a name="108" href="#108">108</a> PUT(UPDATE_ACTION), |
| <a name="109" href="#109">109</a> TRACE(READ_ACTION); |
| <a name="110" href="#110">110</a> |
| <a name="111" href="#111">111</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String action; |
| <a name="112" href="#112">112</a> |
| <a name="113" href="#113">113</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/shiro/web/filter/authz/HttpMethodPermissionFilter.html">HttpMethodAction</a>(String action) { |
| <a name="114" href="#114">114</a> <strong class="jxr_keyword">this</strong>.action = action; |
| <a name="115" href="#115">115</a> } |
| <a name="116" href="#116">116</a> |
| <a name="117" href="#117">117</a> <strong class="jxr_keyword">public</strong> String getAction() { |
| <a name="118" href="#118">118</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.action; |
| <a name="119" href="#119">119</a> } |
| <a name="120" href="#120">120</a> } |
| <a name="121" href="#121">121</a> |
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * Creates the filter instance with default method-to-action values in the instance's</em> |
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * {@link #getHttpMethodActions() http method actions map}.</em> |
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="126" href="#126">126</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/shiro/web/filter/authz/HttpMethodPermissionFilter.html">HttpMethodPermissionFilter</a>() { |
| <a name="127" href="#127">127</a> <strong class="jxr_keyword">for</strong> (HttpMethodAction methodAction : HttpMethodAction.values()) { |
| <a name="128" href="#128">128</a> httpMethodActions.put(methodAction.name().toLowerCase(), methodAction.getAction()); |
| <a name="129" href="#129">129</a> } |
| <a name="130" href="#130">130</a> } |
| <a name="131" href="#131">131</a> |
| <a name="132" href="#132">132</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * Returns the HTTP Method name (key) to action verb (value) mapping used to resolve actions based on an</em> |
| <a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * incoming {@code HttpServletRequest}. All keys and values are lower-case. The</em> |
| <a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * default key/value pairs are defined in the top class-level JavaDoc.</em> |
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * @return the HTTP Method lower-case name (key) to lower-case action verb (value) mapping</em> |
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="139" href="#139">139</a> <strong class="jxr_keyword">protected</strong> Map<String, String> getHttpMethodActions() { |
| <a name="140" href="#140">140</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.httpMethodActions; |
| <a name="141" href="#141">141</a> } |
| <a name="142" href="#142">142</a> |
| <a name="143" href="#143">143</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * Determines the action (verb) attempting to be performed on the filtered resource by the current request.</em> |
| <a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * This implementation expects the incoming request to be an {@link HttpServletRequest} and returns a mapped</em> |
| <a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * action based on the HTTP request {@link javax.servlet.http.HttpServletRequest#getMethod() method}.</em> |
| <a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * @param request to pull the method from.</em> |
| <a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> * @return The string equivalent verb of the http method.</em> |
| <a name="151" href="#151">151</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="152" href="#152">152</a> <strong class="jxr_keyword">protected</strong> String getHttpMethodAction(ServletRequest request) { |
| <a name="153" href="#153">153</a> String method = ((HttpServletRequest) request).getMethod(); |
| <a name="154" href="#154">154</a> <strong class="jxr_keyword">return</strong> getHttpMethodAction(method); |
| <a name="155" href="#155">155</a> } |
| <a name="156" href="#156">156</a> |
| <a name="157" href="#157">157</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * Determines the corresponding application action that will be performed on the filtered resource based on the</em> |
| <a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * specified HTTP method (GET, POST, etc).</em> |
| <a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * @param method to be translated into the verb.</em> |
| <a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * @return The string equivalent verb of the method.</em> |
| <a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="164" href="#164">164</a> <strong class="jxr_keyword">protected</strong> String getHttpMethodAction(String method) { |
| <a name="165" href="#165">165</a> String lc = method.toLowerCase(); |
| <a name="166" href="#166">166</a> String resolved = getHttpMethodActions().get(lc); |
| <a name="167" href="#167">167</a> <strong class="jxr_keyword">return</strong> resolved != <strong class="jxr_keyword">null</strong> ? resolved : method; |
| <a name="168" href="#168">168</a> } |
| <a name="169" href="#169">169</a> |
| <a name="170" href="#170">170</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * Returns a collection of String permissions with which to perform a permission check to determine if the filter</em> |
| <a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> * will allow the request to continue.</em> |
| <a name="173" href="#173">173</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="174" href="#174">174</a> <em class="jxr_javadoccomment"> * This implementation merely delegates to {@link #buildPermissions(String[], String)} and ignores the inbound</em> |
| <a name="175" href="#175">175</a> <em class="jxr_javadoccomment"> * HTTP servlet request, but it can be overridden by subclasses for more complex request-specific building logic</em> |
| <a name="176" href="#176">176</a> <em class="jxr_javadoccomment"> * if necessary.</em> |
| <a name="177" href="#177">177</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="178" href="#178">178</a> <em class="jxr_javadoccomment"> * @param request the inbound HTTP request - ignored in this implementation, but available to</em> |
| <a name="179" href="#179">179</a> <em class="jxr_javadoccomment"> * subclasses for more complex construction building logic if necessary</em> |
| <a name="180" href="#180">180</a> <em class="jxr_javadoccomment"> * @param configuredPerms any url-specific permissions mapped to this filter in the URL rules mappings.</em> |
| <a name="181" href="#181">181</a> <em class="jxr_javadoccomment"> * @param action the application-friendly action (verb) resolved based on the HTTP Method name.</em> |
| <a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> * @return a collection of String permissions with which to perform a permission check to determine if the filter</em> |
| <a name="183" href="#183">183</a> <em class="jxr_javadoccomment"> * will allow the request to continue.</em> |
| <a name="184" href="#184">184</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="185" href="#185">185</a> <strong class="jxr_keyword">protected</strong> String[] buildPermissions(HttpServletRequest request, String[] configuredPerms, String action) { |
| <a name="186" href="#186">186</a> <strong class="jxr_keyword">return</strong> buildPermissions(configuredPerms, action); |
| <a name="187" href="#187">187</a> } |
| <a name="188" href="#188">188</a> |
| <a name="189" href="#189">189</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="190" href="#190">190</a> <em class="jxr_javadoccomment"> * Builds a new array of permission strings based on the original argument, appending the specified action verb</em> |
| <a name="191" href="#191">191</a> <em class="jxr_javadoccomment"> * to each one per {@link org.apache.shiro.authz.permission.WildcardPermission WildcardPermission} conventions. The</em> |
| <a name="192" href="#192">192</a> <em class="jxr_javadoccomment"> * built permission strings will be the ones used at runtime during the permission check that determines if filter</em> |
| <a name="193" href="#193">193</a> <em class="jxr_javadoccomment"> * access should be allowed to continue or not.</em> |
| <a name="194" href="#194">194</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="195" href="#195">195</a> <em class="jxr_javadoccomment"> * For example, if the {@code configuredPerms} argument contains the following 3 permission strings:</em> |
| <a name="196" href="#196">196</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="197" href="#197">197</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a name="198" href="#198">198</a> <em class="jxr_javadoccomment"> * <li>permission:one</li></em> |
| <a name="199" href="#199">199</a> <em class="jxr_javadoccomment"> * <li>permission:two</li></em> |
| <a name="200" href="#200">200</a> <em class="jxr_javadoccomment"> * <li>permission:three</li></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"> * And the action is {@code read}, then the return value will be:</em> |
| <a name="203" href="#203">203</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a name="204" href="#204">204</a> <em class="jxr_javadoccomment"> * <li>permission:one:read</li></em> |
| <a name="205" href="#205">205</a> <em class="jxr_javadoccomment"> * <li>permission:two:read</li></em> |
| <a name="206" href="#206">206</a> <em class="jxr_javadoccomment"> * <li>permission:three:read</li></em> |
| <a name="207" href="#207">207</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a name="208" href="#208">208</a> <em class="jxr_javadoccomment"> * per {@link org.apache.shiro.authz.permission.WildcardPermission WildcardPermission} conventions. Subclasses</em> |
| <a name="209" href="#209">209</a> <em class="jxr_javadoccomment"> * are of course free to override this method or the</em> |
| <a name="210" href="#210">210</a> <em class="jxr_javadoccomment"> * {@link #buildPermissions(javax.servlet.http.HttpServletRequest, String[], String) buildPermissions} request</em> |
| <a name="211" href="#211">211</a> <em class="jxr_javadoccomment"> * variant for custom building logic or with different permission formats.</em> |
| <a name="212" href="#212">212</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="213" href="#213">213</a> <em class="jxr_javadoccomment"> * @param configuredPerms list of configuredPerms to be converted.</em> |
| <a name="214" href="#214">214</a> <em class="jxr_javadoccomment"> * @param action the resolved action based on the request method to be appended to permission strings.</em> |
| <a name="215" href="#215">215</a> <em class="jxr_javadoccomment"> * @return an array of permission strings with each element appended with the action.</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> String[] buildPermissions(String[] configuredPerms, String action) { |
| <a name="218" href="#218">218</a> <strong class="jxr_keyword">if</strong> (configuredPerms == <strong class="jxr_keyword">null</strong> || configuredPerms.length <= 0 || !StringUtils.hasText(action)) { |
| <a name="219" href="#219">219</a> <strong class="jxr_keyword">return</strong> configuredPerms; |
| <a name="220" href="#220">220</a> } |
| <a name="221" href="#221">221</a> |
| <a name="222" href="#222">222</a> String[] mappedPerms = <strong class="jxr_keyword">new</strong> String[configuredPerms.length]; |
| <a name="223" href="#223">223</a> |
| <a name="224" href="#224">224</a> <em class="jxr_comment">// loop and append :action</em> |
| <a name="225" href="#225">225</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < configuredPerms.length; i++) { |
| <a name="226" href="#226">226</a> mappedPerms[i] = configuredPerms[i] + <span class="jxr_string">":"</span> + action; |
| <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">if</strong> (log.isTraceEnabled()) { |
| <a name="230" href="#230">230</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder(); |
| <a name="231" href="#231">231</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < mappedPerms.length; i++) { |
| <a name="232" href="#232">232</a> <strong class="jxr_keyword">if</strong> (i > 0) { |
| <a name="233" href="#233">233</a> sb.append(<span class="jxr_string">", "</span>); |
| <a name="234" href="#234">234</a> } |
| <a name="235" href="#235">235</a> sb.append(mappedPerms[i]); |
| <a name="236" href="#236">236</a> } |
| <a name="237" href="#237">237</a> log.trace(<span class="jxr_string">"MAPPED '{}' action to permission(s) '{}'"</span>, action, sb); |
| <a name="238" href="#238">238</a> } |
| <a name="239" href="#239">239</a> |
| <a name="240" href="#240">240</a> <strong class="jxr_keyword">return</strong> mappedPerms; |
| <a name="241" href="#241">241</a> } |
| <a name="242" href="#242">242</a> |
| <a name="243" href="#243">243</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="244" href="#244">244</a> <em class="jxr_javadoccomment"> * Resolves an 'application friendly' action verb based on the {@code HttpServletRequest}'s method, appends that</em> |
| <a name="245" href="#245">245</a> <em class="jxr_javadoccomment"> * action to each configured permission (the {@code mappedValue} argument is a {@code String[]} array), and</em> |
| <a name="246" href="#246">246</a> <em class="jxr_javadoccomment"> * delegates the permission check for the newly constructed permission(s) to the superclass</em> |
| <a name="247" href="#247">247</a> <em class="jxr_javadoccomment"> * {@link PermissionsAuthorizationFilter#isAccessAllowed(javax.servlet.ServletRequest, javax.servlet.ServletResponse, Object) isAccessAllowed}</em> |
| <a name="248" href="#248">248</a> <em class="jxr_javadoccomment"> * implementation to perform the actual permission check.</em> |
| <a name="249" href="#249">249</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="250" href="#250">250</a> <em class="jxr_javadoccomment"> * @param request the inbound {@code ServletRequest}</em> |
| <a name="251" href="#251">251</a> <em class="jxr_javadoccomment"> * @param response the outbound {@code ServletResponse}</em> |
| <a name="252" href="#252">252</a> <em class="jxr_javadoccomment"> * @param mappedValue the filter-specific config value mapped to this filter in the URL rules mappings.</em> |
| <a name="253" href="#253">253</a> <em class="jxr_javadoccomment"> * @return {@code true} if the request should proceed through the filter normally, {@code false} if the</em> |
| <a name="254" href="#254">254</a> <em class="jxr_javadoccomment"> * request should be processed by this filter's</em> |
| <a name="255" href="#255">255</a> <em class="jxr_javadoccomment"> * {@link #onAccessDenied(ServletRequest,ServletResponse,Object)} method instead.</em> |
| <a name="256" href="#256">256</a> <em class="jxr_javadoccomment"> * @throws IOException</em> |
| <a name="257" href="#257">257</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="258" href="#258">258</a> @Override |
| <a name="259" href="#259">259</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue) <strong class="jxr_keyword">throws</strong> IOException { |
| <a name="260" href="#260">260</a> String[] perms = (String[]) mappedValue; |
| <a name="261" href="#261">261</a> <em class="jxr_comment">// append the http action to the end of the permissions and then back to super</em> |
| <a name="262" href="#262">262</a> String action = getHttpMethodAction(request); |
| <a name="263" href="#263">263</a> String[] resolvedPerms = buildPermissions(perms, action); |
| <a name="264" href="#264">264</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">super</strong>.isAccessAllowed(request, response, resolvedPerms); |
| <a name="265" href="#265">265</a> } |
| <a name="266" href="#266">266</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
| |
