blob: bc808467e9136e40cff0d0b8bc29e90bda026532 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.shiro.authz.aop;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.shiro.aop.AnnotationResolver;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>/**<a name="line.23"></a>
<span class="sourceLineNo">024</span> * Checks to see if a @{@link org.apache.shiro.authz.annotation.RequiresPermissions RequiresPermissions} annotation is declared, and if so, performs<a name="line.24"></a>
<span class="sourceLineNo">025</span> * a permission check to see if the calling &lt;code&gt;Subject&lt;/code&gt; is allowed to call the method.<a name="line.25"></a>
<span class="sourceLineNo">026</span> * @since 0.9<a name="line.26"></a>
<span class="sourceLineNo">027</span> */<a name="line.27"></a>
<span class="sourceLineNo">028</span>public class PermissionAnnotationMethodInterceptor extends AuthorizingAnnotationMethodInterceptor {<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span> /*<a name="line.30"></a>
<span class="sourceLineNo">031</span> * The character to look for that closes a permission definition.<a name="line.31"></a>
<span class="sourceLineNo">032</span> **/<a name="line.32"></a>
<span class="sourceLineNo">033</span> //private static final char ARRAY_CLOSE_CHAR = ']';<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span> /**<a name="line.35"></a>
<span class="sourceLineNo">036</span> * Default no-argument constructor that ensures this interceptor looks for<a name="line.36"></a>
<span class="sourceLineNo">037</span> * {@link org.apache.shiro.authz.annotation.RequiresPermissions RequiresPermissions} annotations in a method declaration.<a name="line.37"></a>
<span class="sourceLineNo">038</span> */<a name="line.38"></a>
<span class="sourceLineNo">039</span> public PermissionAnnotationMethodInterceptor() {<a name="line.39"></a>
<span class="sourceLineNo">040</span> super( new PermissionAnnotationHandler() );<a name="line.40"></a>
<span class="sourceLineNo">041</span> }<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> /**<a name="line.43"></a>
<span class="sourceLineNo">044</span> * @param resolver<a name="line.44"></a>
<span class="sourceLineNo">045</span> * @since 1.1<a name="line.45"></a>
<span class="sourceLineNo">046</span> */<a name="line.46"></a>
<span class="sourceLineNo">047</span> public PermissionAnnotationMethodInterceptor(AnnotationResolver resolver) {<a name="line.47"></a>
<span class="sourceLineNo">048</span> super( new PermissionAnnotationHandler(), resolver);<a name="line.48"></a>
<span class="sourceLineNo">049</span> }<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> /*<a name="line.51"></a>
<span class="sourceLineNo">052</span> * Infers the permission from the specified name path in the annotation.<a name="line.52"></a>
<span class="sourceLineNo">053</span> * @param methodArgs the &lt;code&gt;MethodInvocation&lt;/code&gt; method arguments.<a name="line.53"></a>
<span class="sourceLineNo">054</span> * @param namePath the Annotation 'name' value, which is a string-based permission definition.<a name="line.54"></a>
<span class="sourceLineNo">055</span> * @return the String permission representation.<a name="line.55"></a>
<span class="sourceLineNo">056</span> * @throws Exception if there is an error infering the target.<a name="line.56"></a>
<span class="sourceLineNo">057</span> *<a name="line.57"></a>
<span class="sourceLineNo">058</span> protected String inferTargetFromPath(Object[] methodArgs, String namePath) throws Exception {<a name="line.58"></a>
<span class="sourceLineNo">059</span> int propertyStartIndex = -1;<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> char[] chars = namePath.toCharArray();<a name="line.61"></a>
<span class="sourceLineNo">062</span> StringBuilder buf = new StringBuilder();<a name="line.62"></a>
<span class="sourceLineNo">063</span> //init iteration at index 1 (instead of 0). This is because the first<a name="line.63"></a>
<span class="sourceLineNo">064</span> //character must be the ARRAY_OPEN_CHAR (eliminates unnecessary iteration)<a name="line.64"></a>
<span class="sourceLineNo">065</span> for (int i = 1; i &lt; chars.length; i++) {<a name="line.65"></a>
<span class="sourceLineNo">066</span> if (chars[i] == ARRAY_CLOSE_CHAR) {<a name="line.66"></a>
<span class="sourceLineNo">067</span> // skip the delimiting period after the ARRAY_CLOSE_CHAR. The resulting<a name="line.67"></a>
<span class="sourceLineNo">068</span> // index is the init of the property path that we'll use with<a name="line.68"></a>
<span class="sourceLineNo">069</span> // BeanUtils.getProperty:<a name="line.69"></a>
<span class="sourceLineNo">070</span> propertyStartIndex = i + 2;<a name="line.70"></a>
<span class="sourceLineNo">071</span> break;<a name="line.71"></a>
<span class="sourceLineNo">072</span> } else {<a name="line.72"></a>
<span class="sourceLineNo">073</span> buf.append(chars[i]);<a name="line.73"></a>
<span class="sourceLineNo">074</span> }<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span> Integer methodArgIndex = Integer.parseInt(buf.toString());<a name="line.77"></a>
<span class="sourceLineNo">078</span> String beanUtilsPath = new String(chars, propertyStartIndex,<a name="line.78"></a>
<span class="sourceLineNo">079</span> chars.length - propertyStartIndex);<a name="line.79"></a>
<span class="sourceLineNo">080</span> Object targetValue = PropertyUtils.getProperty(methodArgs[methodArgIndex], beanUtilsPath);<a name="line.80"></a>
<span class="sourceLineNo">081</span> return targetValue.toString();<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span> /*<a name="line.84"></a>
<span class="sourceLineNo">085</span> * Returns the &lt;code&gt;MethodInvocation&lt;/code&gt;'s arguments, or &lt;code&gt;null&lt;/code&gt; if there were none.<a name="line.85"></a>
<span class="sourceLineNo">086</span> * @param invocation the methodInvocation to inspect.<a name="line.86"></a>
<span class="sourceLineNo">087</span> * @return the method invocation's method arguments, or &lt;code&gt;null&lt;/code&gt; if there were none.<a name="line.87"></a>
<span class="sourceLineNo">088</span> *<a name="line.88"></a>
<span class="sourceLineNo">089</span> protected Object[] getMethodArguments(MethodInvocation invocation) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> if (invocation != null) {<a name="line.90"></a>
<span class="sourceLineNo">091</span> return invocation.getArguments();<a name="line.91"></a>
<span class="sourceLineNo">092</span> } else {<a name="line.92"></a>
<span class="sourceLineNo">093</span> return null;<a name="line.93"></a>
<span class="sourceLineNo">094</span> }<a name="line.94"></a>
<span class="sourceLineNo">095</span> }<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span> /*<a name="line.97"></a>
<span class="sourceLineNo">098</span> * Returns the annotation {@link RequiresPermissions#value value}, from which the Permission will be constructed.<a name="line.98"></a>
<span class="sourceLineNo">099</span> *<a name="line.99"></a>
<span class="sourceLineNo">100</span> * @param invocation the method being invoked.<a name="line.100"></a>
<span class="sourceLineNo">101</span> * @return the method annotation's &lt;code&gt;value&lt;/code&gt;, from which the Permission will be constructed.<a name="line.101"></a>
<span class="sourceLineNo">102</span> *<a name="line.102"></a>
<span class="sourceLineNo">103</span> protected String getAnnotationValue(MethodInvocation invocation) {<a name="line.103"></a>
<span class="sourceLineNo">104</span> RequiresPermissions prAnnotation = (RequiresPermissions) getAnnotation(invocation);<a name="line.104"></a>
<span class="sourceLineNo">105</span> return prAnnotation.value();<a name="line.105"></a>
<span class="sourceLineNo">106</span> } */<a name="line.106"></a>
<span class="sourceLineNo">107</span>}<a name="line.107"></a>
</pre>
</div>
</body>
</html>