| <!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>AuthorizingAnnotationMethodInterceptor xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/authz/aop/AuthorizingAnnotationMethodInterceptor.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.AnnotationMethodInterceptor; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.aop.AnnotationResolver; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.aop.MethodInvocation; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authz.AuthorizationException; |
| <a name="25" href="#25">25</a> |
| <a name="26" href="#26">26</a> |
| <a name="27" href="#27">27</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * An <tt>AnnotationMethodInterceptor</tt> that asserts the calling code is authorized to execute the method</em> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * before allowing the invocation to continue by inspecting code annotations to perform an access control check.</em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * @since 0.1</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="33" href="#33">33</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/authz/aop/AuthorizingAnnotationMethodInterceptor.html">AuthorizingAnnotationMethodInterceptor</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/aop/AnnotationMethodInterceptor.html">AnnotationMethodInterceptor</a> |
| <a name="34" href="#34">34</a> { |
| <a name="35" href="#35">35</a> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * Constructor that ensures the internal <code>handler</code> is set which will be used to perform the</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * authorization assertion checks when a supported annotation is encountered.</em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * @param handler the internal <code>handler</code> used to perform authorization assertion checks when a </em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * supported annotation is encountered.</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="42" href="#42">42</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/authz/aop/AuthorizingAnnotationMethodInterceptor.html">AuthorizingAnnotationMethodInterceptor</a>( AuthorizingAnnotationHandler handler ) { |
| <a name="43" href="#43">43</a> <strong class="jxr_keyword">super</strong>(handler); |
| <a name="44" href="#44">44</a> } |
| <a name="45" href="#45">45</a> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * @param handler</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * @param resolver</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * @since 1.1</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="52" href="#52">52</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/authz/aop/AuthorizingAnnotationMethodInterceptor.html">AuthorizingAnnotationMethodInterceptor</a>( AuthorizingAnnotationHandler handler, |
| <a name="53" href="#53">53</a> <a href="../../../../../org/apache/shiro/aop/AnnotationResolver.html">AnnotationResolver</a> resolver) { |
| <a name="54" href="#54">54</a> <strong class="jxr_keyword">super</strong>(handler, resolver); |
| <a name="55" href="#55">55</a> } |
| <a name="56" href="#56">56</a> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * Ensures the <code>methodInvocation</code> is allowed to execute first before proceeding by calling the</em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * {@link #assertAuthorized(org.apache.shiro.aop.MethodInvocation) assertAuthorized} method first.</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * @param methodInvocation the method invocation to check for authorization prior to allowing it to proceed/execute.</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * @return the return value from the method invocation (the value of {@link org.apache.shiro.aop.MethodInvocation#proceed() MethodInvocation.proceed()}).</em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * @throws org.apache.shiro.authz.AuthorizationException if the <code>MethodInvocation</code> is not allowed to proceed.</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @throws Throwable if any other error occurs.</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="66" href="#66">66</a> <strong class="jxr_keyword">public</strong> Object invoke(<a href="../../../../../org/apache/shiro/aop/MethodInvocation.html">MethodInvocation</a> methodInvocation) <strong class="jxr_keyword">throws</strong> Throwable { |
| <a name="67" href="#67">67</a> assertAuthorized(methodInvocation); |
| <a name="68" href="#68">68</a> <strong class="jxr_keyword">return</strong> methodInvocation.proceed(); |
| <a name="69" href="#69">69</a> } |
| <a name="70" href="#70">70</a> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * Ensures the calling Subject is authorized to execute the specified <code>MethodInvocation</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"> * As this is an AnnotationMethodInterceptor, this implementation merely delegates to the internal</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * {@link AuthorizingAnnotationHandler AuthorizingAnnotationHandler} by first acquiring the annotation by</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * calling {@link #getAnnotation(MethodInvocation) getAnnotation(methodInvocation)} and then calls</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * {@link AuthorizingAnnotationHandler#assertAuthorized(java.lang.annotation.Annotation) handler.assertAuthorized(annotation)}.</em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * @param mi the <code>MethodInvocation</code> to check to see if it is allowed to proceed/execute.</em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * @throws AuthorizationException if the method invocation is not allowed to continue/execute.</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="82" href="#82">82</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> assertAuthorized(<a href="../../../../../org/apache/shiro/aop/MethodInvocation.html">MethodInvocation</a> mi) <strong class="jxr_keyword">throws</strong> AuthorizationException { |
| <a name="83" href="#83">83</a> <strong class="jxr_keyword">try</strong> { |
| <a name="84" href="#84">84</a> ((<a href="../../../../../org/apache/shiro/authz/aop/AuthorizingAnnotationHandler.html">AuthorizingAnnotationHandler</a>)getHandler()).assertAuthorized(getAnnotation(mi)); |
| <a name="85" href="#85">85</a> } |
| <a name="86" href="#86">86</a> <strong class="jxr_keyword">catch</strong>(<a href="../../../../../org/apache/shiro/authz/AuthorizationException.html">AuthorizationException</a> ae) { |
| <a name="87" href="#87">87</a> <em class="jxr_comment">// Annotation handler doesn't know why it was called, so add the information here if possible. </em> |
| <a name="88" href="#88">88</a> <em class="jxr_comment">// Don't wrap the exception here since we don't want to mask the specific exception, such as </em> |
| <a name="89" href="#89">89</a> <em class="jxr_comment">// UnauthenticatedException etc. </em> |
| <a name="90" href="#90">90</a> <strong class="jxr_keyword">if</strong> (ae.getCause() == <strong class="jxr_keyword">null</strong>) ae.initCause(<strong class="jxr_keyword">new</strong> AuthorizationException(<span class="jxr_string">"Not authorized to invoke method: "</span> + mi.getMethod())); |
| <a name="91" href="#91">91</a> <strong class="jxr_keyword">throw</strong> ae; |
| <a name="92" href="#92">92</a> } |
| <a name="93" href="#93">93</a> } |
| <a name="94" href="#94">94</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
