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