blob: 59d4f13c3a7d165936a815021d4314ab10ab96ef [file] [log] [blame]
<!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>PermissionAnnotationMethodInterceptor xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/authz/aop/PermissionAnnotationMethodInterceptor.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.aop;
<a name="20" href="#20">20</a>
<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.aop.AnnotationResolver;
<a name="22" href="#22">22</a>
<a name="23" href="#23">23</a> <em class="jxr_javadoccomment">/**</em>
<a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * Checks to see if a @{@link org.apache.shiro.authz.annotation.RequiresPermissions RequiresPermissions} annotation is declared, and if so, performs</em>
<a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * a permission check to see if the calling &lt;code&gt;Subject&lt;/code&gt; is allowed to call the method.</em>
<a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * @since 0.9</em>
<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> */</em>
<a name="28" href="#28">28</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/authz/aop/PermissionAnnotationMethodInterceptor.html">PermissionAnnotationMethodInterceptor</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/authz/aop/AuthorizingAnnotationMethodInterceptor.html">AuthorizingAnnotationMethodInterceptor</a> {
<a name="29" href="#29">29</a>
<a name="30" href="#30">30</a> <em class="jxr_comment">/*</em>
<a name="31" href="#31">31</a> <em class="jxr_comment"> * The character to look for that closes a permission definition.</em>
<a name="32" href="#32">32</a> <em class="jxr_comment"> **/</em>
<a name="33" href="#33">33</a> <em class="jxr_comment">//private static final char ARRAY_CLOSE_CHAR = ']';</em>
<a name="34" href="#34">34</a>
<a name="35" href="#35">35</a> <em class="jxr_javadoccomment">/**</em>
<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * Default no-argument constructor that ensures this interceptor looks for</em>
<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authz.annotation.RequiresPermissions RequiresPermissions} annotations in a method declaration.</em>
<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> */</em>
<a name="39" href="#39">39</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/authz/aop/PermissionAnnotationMethodInterceptor.html">PermissionAnnotationMethodInterceptor</a>() {
<a name="40" href="#40">40</a> <strong class="jxr_keyword">super</strong>( <strong class="jxr_keyword">new</strong> PermissionAnnotationHandler() );
<a name="41" href="#41">41</a> }
<a name="42" href="#42">42</a>
<a name="43" href="#43">43</a> <em class="jxr_javadoccomment">/**</em>
<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * @param resolver</em>
<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * @since 1.1</em>
<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> */</em>
<a name="47" href="#47">47</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/authz/aop/PermissionAnnotationMethodInterceptor.html">PermissionAnnotationMethodInterceptor</a>(<a href="../../../../../org/apache/shiro/aop/AnnotationResolver.html">AnnotationResolver</a> resolver) {
<a name="48" href="#48">48</a> <strong class="jxr_keyword">super</strong>( <strong class="jxr_keyword">new</strong> PermissionAnnotationHandler(), resolver);
<a name="49" href="#49">49</a> }
<a name="50" href="#50">50</a>
<a name="51" href="#51">51</a> <em class="jxr_comment">/*</em>
<a name="52" href="#52">52</a> <em class="jxr_comment"> * Infers the permission from the specified name path in the annotation.</em>
<a name="53" href="#53">53</a> <em class="jxr_comment"> * @param methodArgs the &lt;code&gt;MethodInvocation&lt;/code&gt; method arguments.</em>
<a name="54" href="#54">54</a> <em class="jxr_comment"> * @param namePath the Annotation 'name' value, which is a string-based permission definition.</em>
<a name="55" href="#55">55</a> <em class="jxr_comment"> * @return the String permission representation.</em>
<a name="56" href="#56">56</a> <em class="jxr_comment"> * @throws Exception if there is an error infering the target.</em>
<a name="57" href="#57">57</a> <em class="jxr_comment"> *</em>
<a name="58" href="#58">58</a> <em class="jxr_comment"> protected String inferTargetFromPath(Object[] methodArgs, String namePath) throws Exception {</em>
<a name="59" href="#59">59</a> <em class="jxr_comment"> int propertyStartIndex = -1;</em>
<a name="60" href="#60">60</a>
<a name="61" href="#61">61</a> <em class="jxr_comment"> char[] chars = namePath.toCharArray();</em>
<a name="62" href="#62">62</a> <em class="jxr_comment"> StringBuilder buf = new StringBuilder();</em>
<a name="63" href="#63">63</a> <em class="jxr_comment"> //init iteration at index 1 (instead of 0). This is because the first</em>
<a name="64" href="#64">64</a> <em class="jxr_comment"> //character must be the ARRAY_OPEN_CHAR (eliminates unnecessary iteration)</em>
<a name="65" href="#65">65</a> <em class="jxr_comment"> for (int i = 1; i &lt; chars.length; i++) {</em>
<a name="66" href="#66">66</a> <em class="jxr_comment"> if (chars[i] == ARRAY_CLOSE_CHAR) {</em>
<a name="67" href="#67">67</a> <em class="jxr_comment"> // skip the delimiting period after the ARRAY_CLOSE_CHAR. The resulting</em>
<a name="68" href="#68">68</a> <em class="jxr_comment"> // index is the init of the property path that we'll use with</em>
<a name="69" href="#69">69</a> <em class="jxr_comment"> // BeanUtils.getProperty:</em>
<a name="70" href="#70">70</a> <em class="jxr_comment"> propertyStartIndex = i + 2;</em>
<a name="71" href="#71">71</a> <em class="jxr_comment"> break;</em>
<a name="72" href="#72">72</a> <em class="jxr_comment"> } else {</em>
<a name="73" href="#73">73</a> <em class="jxr_comment"> buf.append(chars[i]);</em>
<a name="74" href="#74">74</a> <em class="jxr_comment"> }</em>
<a name="75" href="#75">75</a> <em class="jxr_comment"> }</em>
<a name="76" href="#76">76</a>
<a name="77" href="#77">77</a> <em class="jxr_comment"> Integer methodArgIndex = Integer.parseInt(buf.toString());</em>
<a name="78" href="#78">78</a> <em class="jxr_comment"> String beanUtilsPath = new String(chars, propertyStartIndex,</em>
<a name="79" href="#79">79</a> <em class="jxr_comment"> chars.length - propertyStartIndex);</em>
<a name="80" href="#80">80</a> <em class="jxr_comment"> Object targetValue = PropertyUtils.getProperty(methodArgs[methodArgIndex], beanUtilsPath);</em>
<a name="81" href="#81">81</a> <em class="jxr_comment"> return targetValue.toString();</em>
<a name="82" href="#82">82</a> <em class="jxr_comment"> }</em>
<a name="83" href="#83">83</a>
<a name="84" href="#84">84</a> <em class="jxr_comment"> /*</em>
<a name="85" href="#85">85</a> <em class="jxr_comment"> * Returns the &lt;code&gt;MethodInvocation&lt;/code&gt;'s arguments, or &lt;code&gt;null&lt;/code&gt; if there were none.</em>
<a name="86" href="#86">86</a> <em class="jxr_comment"> * @param invocation the methodInvocation to inspect.</em>
<a name="87" href="#87">87</a> <em class="jxr_comment"> * @return the method invocation's method arguments, or &lt;code&gt;null&lt;/code&gt; if there were none.</em>
<a name="88" href="#88">88</a> <em class="jxr_comment"> *</em>
<a name="89" href="#89">89</a> <em class="jxr_comment"> protected Object[] getMethodArguments(MethodInvocation invocation) {</em>
<a name="90" href="#90">90</a> <em class="jxr_comment"> if (invocation != null) {</em>
<a name="91" href="#91">91</a> <em class="jxr_comment"> return invocation.getArguments();</em>
<a name="92" href="#92">92</a> <em class="jxr_comment"> } else {</em>
<a name="93" href="#93">93</a> <em class="jxr_comment"> return null;</em>
<a name="94" href="#94">94</a> <em class="jxr_comment"> }</em>
<a name="95" href="#95">95</a> <em class="jxr_comment"> }</em>
<a name="96" href="#96">96</a>
<a name="97" href="#97">97</a> <em class="jxr_comment"> /*</em>
<a name="98" href="#98">98</a> <em class="jxr_comment"> * Returns the annotation {@link RequiresPermissions#value value}, from which the Permission will be constructed.</em>
<a name="99" href="#99">99</a> <em class="jxr_comment"> *</em>
<a name="100" href="#100">100</a> <em class="jxr_comment"> * @param invocation the method being invoked.</em>
<a name="101" href="#101">101</a> <em class="jxr_comment"> * @return the method annotation's &lt;code&gt;value&lt;/code&gt;, from which the Permission will be constructed.</em>
<a name="102" href="#102">102</a> <em class="jxr_comment"> *</em>
<a name="103" href="#103">103</a> <em class="jxr_comment"> protected String getAnnotationValue(MethodInvocation invocation) {</em>
<a name="104" href="#104">104</a> <em class="jxr_comment"> RequiresPermissions prAnnotation = (RequiresPermissions) getAnnotation(invocation);</em>
<a name="105" href="#105">105</a> <em class="jxr_comment"> return prAnnotation.value();</em>
<a name="106" href="#106">106</a> <em class="jxr_comment"> } */</em>
<a name="107" href="#107">107</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>