| <!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>AnnotationsAuthorizingMethodInterceptor xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/authz/aop/AnnotationsAuthorizingMethodInterceptor.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.aop; |
| <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> java.util.ArrayList; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.Collection; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.aop.MethodInvocation; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authz.AuthorizationException; |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * An <tt>AnnotationsAuthorizingMethodInterceptor</tt> is a MethodInterceptor that asserts a given method is authorized</em> |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * to execute based on one or more configured <tt>AuthorizingAnnotationMethodInterceptor</tt>s.</em> |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * <p>This allows multiple annotations on a method to be processed before the method</em> |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * executes, and if any of the <tt>AuthorizingAnnotationMethodInterceptor</tt>s indicate that the method should not be</em> |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * executed, an <tt>AuthorizationException</tt> will be thrown, otherwise the method will be invoked as expected.</em> |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * <p>It is essentially a convenience mechanism to allow multiple annotations to be processed in a single method</em> |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * interceptor.</em> |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * @since 0.2</em> |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a name="AnnotationsAuthorizingMethodInterceptor" href="../../../../../org/apache/shiro/authz/aop/AnnotationsAuthorizingMethodInterceptor.html#AnnotationsAuthorizingMethodInterceptor">AnnotationsAuthorizingMethodInterceptor</a> <strong class="jxr_keyword">extends</strong> <a name="AuthorizingMethodInterceptor" href="../../../../../org/apache/shiro/authz/aop/AuthorizingMethodInterceptor.html#AuthorizingMethodInterceptor">AuthorizingMethodInterceptor</a> { |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * The method interceptors to execute for the annotated method.</em> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">protected</strong> Collection<AuthorizingAnnotationMethodInterceptor> methodInterceptors; |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * Default no-argument constructor that defaults the </em> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * {@link #methodInterceptors methodInterceptors} attribute to contain two interceptors by default - the</em> |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * {@link RoleAnnotationMethodInterceptor RoleAnnotationMethodInterceptor} and the</em> |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * {@link PermissionAnnotationMethodInterceptor PermissionAnnotationMethodInterceptor} to</em> |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * support role and permission annotations.</em> |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">public</strong> <a name="AnnotationsAuthorizingMethodInterceptor" href="../../../../../org/apache/shiro/authz/aop/AnnotationsAuthorizingMethodInterceptor.html#AnnotationsAuthorizingMethodInterceptor">AnnotationsAuthorizingMethodInterceptor</a>() { |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> methodInterceptors = <strong class="jxr_keyword">new</strong> ArrayList<AuthorizingAnnotationMethodInterceptor>(5); |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> methodInterceptors.add(<strong class="jxr_keyword">new</strong> <a name="RoleAnnotationMethodInterceptor" href="../../../../../org/apache/shiro/authz/aop/RoleAnnotationMethodInterceptor.html#RoleAnnotationMethodInterceptor">RoleAnnotationMethodInterceptor</a>()); |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> methodInterceptors.add(<strong class="jxr_keyword">new</strong> <a name="PermissionAnnotationMethodInterceptor" href="../../../../../org/apache/shiro/authz/aop/PermissionAnnotationMethodInterceptor.html#PermissionAnnotationMethodInterceptor">PermissionAnnotationMethodInterceptor</a>()); |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> methodInterceptors.add(<strong class="jxr_keyword">new</strong> <a name="AuthenticatedAnnotationMethodInterceptor" href="../../../../../org/apache/shiro/authz/aop/AuthenticatedAnnotationMethodInterceptor.html#AuthenticatedAnnotationMethodInterceptor">AuthenticatedAnnotationMethodInterceptor</a>()); |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> methodInterceptors.add(<strong class="jxr_keyword">new</strong> <a name="UserAnnotationMethodInterceptor" href="../../../../../org/apache/shiro/authz/aop/UserAnnotationMethodInterceptor.html#UserAnnotationMethodInterceptor">UserAnnotationMethodInterceptor</a>()); |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> methodInterceptors.add(<strong class="jxr_keyword">new</strong> <a name="GuestAnnotationMethodInterceptor" href="../../../../../org/apache/shiro/authz/aop/GuestAnnotationMethodInterceptor.html#GuestAnnotationMethodInterceptor">GuestAnnotationMethodInterceptor</a>()); |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> } |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * Returns the method interceptors to execute for the annotated method.</em> |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * Unless overridden by the {@link #setMethodInterceptors(java.util.Collection)} method, the default collection</em> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * contains a</em> |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * {@link RoleAnnotationMethodInterceptor RoleAnnotationMethodInterceptor} and a</em> |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * {@link PermissionAnnotationMethodInterceptor PermissionAnnotationMethodInterceptor} to</em> |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * support role and permission annotations automatically.</em> |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * @return the method interceptors to execute for the annotated method.</em> |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">public</strong> Collection<AuthorizingAnnotationMethodInterceptor> getMethodInterceptors() { |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">return</strong> methodInterceptors; |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> } |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * Sets the method interceptors to execute for the annotated method.</em> |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * @param methodInterceptors the method interceptors to execute for the annotated method.</em> |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * @see #getMethodInterceptors()</em> |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setMethodInterceptors(Collection<AuthorizingAnnotationMethodInterceptor> methodInterceptors) { |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">this</strong>.methodInterceptors = methodInterceptors; |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> } |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * Iterates over the internal {@link #getMethodInterceptors() methodInterceptors} collection, and for each one,</em> |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * ensures that if the interceptor</em> |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * {@link AuthorizingAnnotationMethodInterceptor#supports(org.apache.shiro.aop.MethodInvocation) supports}</em> |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * the invocation, that the interceptor</em> |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * {@link AuthorizingAnnotationMethodInterceptor#assertAuthorized(org.apache.shiro.aop.MethodInvocation) asserts}</em> |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * that the invocation is authorized to proceed.</em> |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> assertAuthorized(<a name="MethodInvocation" href="../../../../../org/apache/shiro/aop/MethodInvocation.html#MethodInvocation">MethodInvocation</a> methodInvocation) <strong class="jxr_keyword">throws</strong> <a name="AuthorizationException" href="../../../../../org/apache/shiro/authz/AuthorizationException.html#AuthorizationException">AuthorizationException</a> { |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_comment">//default implementation just ensures no deny votes are cast:</em> |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> Collection<AuthorizingAnnotationMethodInterceptor> aamis = getMethodInterceptors(); |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">if</strong> (aamis != <strong class="jxr_keyword">null</strong> && !aamis.isEmpty()) { |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">for</strong> (<a name="AuthorizingAnnotationMethodInterceptor" href="../../../../../org/apache/shiro/authz/aop/AuthorizingAnnotationMethodInterceptor.html#AuthorizingAnnotationMethodInterceptor">AuthorizingAnnotationMethodInterceptor</a> aami : aamis) { |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">if</strong> (aami.supports(methodInvocation)) { |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> aami.assertAuthorized(methodInvocation); |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> } |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> } |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> } |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> } |
| <a class="jxr_linenumber" name="L105" href="#L105">105</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> |
