blob: 01ea095667e009b66115024600a6633482ffead2 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a>
<span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">009</span><a id="line.9"> *</a>
<span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">011</span><a id="line.11"> *</a>
<span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a>
<span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a>
<span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a>
<span class="sourceLineNo">018</span><a id="line.18"> */</a>
<span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.spring.security.interceptor;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.authz.annotation.*;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.mgt.SecurityManager;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.slf4j.Logger;</a>
<span class="sourceLineNo">024</span><a id="line.24">import org.slf4j.LoggerFactory;</a>
<span class="sourceLineNo">025</span><a id="line.25">import org.springframework.aop.support.StaticMethodMatcherPointcutAdvisor;</a>
<span class="sourceLineNo">026</span><a id="line.26">import org.springframework.core.annotation.AnnotationUtils;</a>
<span class="sourceLineNo">027</span><a id="line.27"></a>
<span class="sourceLineNo">028</span><a id="line.28">import java.lang.annotation.Annotation;</a>
<span class="sourceLineNo">029</span><a id="line.29">import java.lang.reflect.Method;</a>
<span class="sourceLineNo">030</span><a id="line.30"></a>
<span class="sourceLineNo">031</span><a id="line.31"></a>
<span class="sourceLineNo">032</span><a id="line.32">/**</a>
<span class="sourceLineNo">033</span><a id="line.33"> * TODO - complete JavaDoc</a>
<span class="sourceLineNo">034</span><a id="line.34"> *</a>
<span class="sourceLineNo">035</span><a id="line.35"> * @since 0.1</a>
<span class="sourceLineNo">036</span><a id="line.36"> */</a>
<span class="sourceLineNo">037</span><a id="line.37">@SuppressWarnings({"unchecked"})</a>
<span class="sourceLineNo">038</span><a id="line.38">public class AuthorizationAttributeSourceAdvisor extends StaticMethodMatcherPointcutAdvisor {</a>
<span class="sourceLineNo">039</span><a id="line.39"></a>
<span class="sourceLineNo">040</span><a id="line.40"> private static final Logger log = LoggerFactory.getLogger(AuthorizationAttributeSourceAdvisor.class);</a>
<span class="sourceLineNo">041</span><a id="line.41"></a>
<span class="sourceLineNo">042</span><a id="line.42"> private static final Class&lt;? extends Annotation&gt;[] AUTHZ_ANNOTATION_CLASSES =</a>
<span class="sourceLineNo">043</span><a id="line.43"> new Class[] {</a>
<span class="sourceLineNo">044</span><a id="line.44"> RequiresPermissions.class, RequiresRoles.class,</a>
<span class="sourceLineNo">045</span><a id="line.45"> RequiresUser.class, RequiresGuest.class, RequiresAuthentication.class</a>
<span class="sourceLineNo">046</span><a id="line.46"> };</a>
<span class="sourceLineNo">047</span><a id="line.47"></a>
<span class="sourceLineNo">048</span><a id="line.48"> protected SecurityManager securityManager = null;</a>
<span class="sourceLineNo">049</span><a id="line.49"></a>
<span class="sourceLineNo">050</span><a id="line.50"> /**</a>
<span class="sourceLineNo">051</span><a id="line.51"> * Create a new AuthorizationAttributeSourceAdvisor.</a>
<span class="sourceLineNo">052</span><a id="line.52"> */</a>
<span class="sourceLineNo">053</span><a id="line.53"> public AuthorizationAttributeSourceAdvisor() {</a>
<span class="sourceLineNo">054</span><a id="line.54"> setAdvice(new AopAllianceAnnotationsAuthorizingMethodInterceptor());</a>
<span class="sourceLineNo">055</span><a id="line.55"> }</a>
<span class="sourceLineNo">056</span><a id="line.56"></a>
<span class="sourceLineNo">057</span><a id="line.57"> public SecurityManager getSecurityManager() {</a>
<span class="sourceLineNo">058</span><a id="line.58"> return securityManager;</a>
<span class="sourceLineNo">059</span><a id="line.59"> }</a>
<span class="sourceLineNo">060</span><a id="line.60"></a>
<span class="sourceLineNo">061</span><a id="line.61"> public void setSecurityManager(org.apache.shiro.mgt.SecurityManager securityManager) {</a>
<span class="sourceLineNo">062</span><a id="line.62"> this.securityManager = securityManager;</a>
<span class="sourceLineNo">063</span><a id="line.63"> }</a>
<span class="sourceLineNo">064</span><a id="line.64"></a>
<span class="sourceLineNo">065</span><a id="line.65"> /**</a>
<span class="sourceLineNo">066</span><a id="line.66"> * Returns &lt;tt&gt;true&lt;/tt&gt; if the method or the class has any Shiro annotations, false otherwise.</a>
<span class="sourceLineNo">067</span><a id="line.67"> * The annotations inspected are:</a>
<span class="sourceLineNo">068</span><a id="line.68"> * &lt;ul&gt;</a>
<span class="sourceLineNo">069</span><a id="line.69"> * &lt;li&gt;{@link org.apache.shiro.authz.annotation.RequiresAuthentication RequiresAuthentication}&lt;/li&gt;</a>
<span class="sourceLineNo">070</span><a id="line.70"> * &lt;li&gt;{@link org.apache.shiro.authz.annotation.RequiresUser RequiresUser}&lt;/li&gt;</a>
<span class="sourceLineNo">071</span><a id="line.71"> * &lt;li&gt;{@link org.apache.shiro.authz.annotation.RequiresGuest RequiresGuest}&lt;/li&gt;</a>
<span class="sourceLineNo">072</span><a id="line.72"> * &lt;li&gt;{@link org.apache.shiro.authz.annotation.RequiresRoles RequiresRoles}&lt;/li&gt;</a>
<span class="sourceLineNo">073</span><a id="line.73"> * &lt;li&gt;{@link org.apache.shiro.authz.annotation.RequiresPermissions RequiresPermissions}&lt;/li&gt;</a>
<span class="sourceLineNo">074</span><a id="line.74"> * &lt;/ul&gt;</a>
<span class="sourceLineNo">075</span><a id="line.75"> *</a>
<span class="sourceLineNo">076</span><a id="line.76"> * @param method the method to check for a Shiro annotation</a>
<span class="sourceLineNo">077</span><a id="line.77"> * @param targetClass the class potentially declaring Shiro annotations</a>
<span class="sourceLineNo">078</span><a id="line.78"> * @return &lt;tt&gt;true&lt;/tt&gt; if the method has a Shiro annotation, false otherwise.</a>
<span class="sourceLineNo">079</span><a id="line.79"> * @see org.springframework.aop.MethodMatcher#matches(java.lang.reflect.Method, Class)</a>
<span class="sourceLineNo">080</span><a id="line.80"> */</a>
<span class="sourceLineNo">081</span><a id="line.81"> public boolean matches(Method method, Class targetClass) {</a>
<span class="sourceLineNo">082</span><a id="line.82"> Method m = method;</a>
<span class="sourceLineNo">083</span><a id="line.83"></a>
<span class="sourceLineNo">084</span><a id="line.84"> if ( isAuthzAnnotationPresent(m) ) {</a>
<span class="sourceLineNo">085</span><a id="line.85"> return true;</a>
<span class="sourceLineNo">086</span><a id="line.86"> }</a>
<span class="sourceLineNo">087</span><a id="line.87"></a>
<span class="sourceLineNo">088</span><a id="line.88"> //The 'method' parameter could be from an interface that doesn't have the annotation.</a>
<span class="sourceLineNo">089</span><a id="line.89"> //Check to see if the implementation has it.</a>
<span class="sourceLineNo">090</span><a id="line.90"> if ( targetClass != null) {</a>
<span class="sourceLineNo">091</span><a id="line.91"> try {</a>
<span class="sourceLineNo">092</span><a id="line.92"> m = targetClass.getMethod(m.getName(), m.getParameterTypes());</a>
<span class="sourceLineNo">093</span><a id="line.93"> return isAuthzAnnotationPresent(m) || isAuthzAnnotationPresent(targetClass);</a>
<span class="sourceLineNo">094</span><a id="line.94"> } catch (NoSuchMethodException ignored) {</a>
<span class="sourceLineNo">095</span><a id="line.95"> //default return value is false. If we can't find the method, then obviously</a>
<span class="sourceLineNo">096</span><a id="line.96"> //there is no annotation, so just use the default return value.</a>
<span class="sourceLineNo">097</span><a id="line.97"> }</a>
<span class="sourceLineNo">098</span><a id="line.98"> }</a>
<span class="sourceLineNo">099</span><a id="line.99"></a>
<span class="sourceLineNo">100</span><a id="line.100"> return false;</a>
<span class="sourceLineNo">101</span><a id="line.101"> }</a>
<span class="sourceLineNo">102</span><a id="line.102"></a>
<span class="sourceLineNo">103</span><a id="line.103"> private boolean isAuthzAnnotationPresent(Class&lt;?&gt; targetClazz) {</a>
<span class="sourceLineNo">104</span><a id="line.104"> for( Class&lt;? extends Annotation&gt; annClass : AUTHZ_ANNOTATION_CLASSES ) {</a>
<span class="sourceLineNo">105</span><a id="line.105"> Annotation a = AnnotationUtils.findAnnotation(targetClazz, annClass);</a>
<span class="sourceLineNo">106</span><a id="line.106"> if ( a != null ) {</a>
<span class="sourceLineNo">107</span><a id="line.107"> return true;</a>
<span class="sourceLineNo">108</span><a id="line.108"> }</a>
<span class="sourceLineNo">109</span><a id="line.109"> }</a>
<span class="sourceLineNo">110</span><a id="line.110"> return false;</a>
<span class="sourceLineNo">111</span><a id="line.111"> }</a>
<span class="sourceLineNo">112</span><a id="line.112"></a>
<span class="sourceLineNo">113</span><a id="line.113"> private boolean isAuthzAnnotationPresent(Method method) {</a>
<span class="sourceLineNo">114</span><a id="line.114"> for( Class&lt;? extends Annotation&gt; annClass : AUTHZ_ANNOTATION_CLASSES ) {</a>
<span class="sourceLineNo">115</span><a id="line.115"> Annotation a = AnnotationUtils.findAnnotation(method, annClass);</a>
<span class="sourceLineNo">116</span><a id="line.116"> if ( a != null ) {</a>
<span class="sourceLineNo">117</span><a id="line.117"> return true;</a>
<span class="sourceLineNo">118</span><a id="line.118"> }</a>
<span class="sourceLineNo">119</span><a id="line.119"> }</a>
<span class="sourceLineNo">120</span><a id="line.120"> return false;</a>
<span class="sourceLineNo">121</span><a id="line.121"> }</a>
<span class="sourceLineNo">122</span><a id="line.122"></a>
<span class="sourceLineNo">123</span><a id="line.123">}</a>
</pre>
</div>
</main>
</body>
</html>