blob: bbec69b05c3d62dfe0e141e7ec4043f9ebf0a925 [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.authz.aop;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.aop.AnnotationResolver;</a>
<span class="sourceLineNo">022</span><a id="line.22"></a>
<span class="sourceLineNo">023</span><a id="line.23">/**</a>
<span class="sourceLineNo">024</span><a id="line.24"> * Checks to see if a @{@link org.apache.shiro.authz.annotation.RequiresPermissions RequiresPermissions} annotation is declared, and if so, performs</a>
<span class="sourceLineNo">025</span><a id="line.25"> * a permission check to see if the calling &lt;code&gt;Subject&lt;/code&gt; is allowed to call the method.</a>
<span class="sourceLineNo">026</span><a id="line.26"> * @since 0.9</a>
<span class="sourceLineNo">027</span><a id="line.27"> */</a>
<span class="sourceLineNo">028</span><a id="line.28">public class PermissionAnnotationMethodInterceptor extends AuthorizingAnnotationMethodInterceptor {</a>
<span class="sourceLineNo">029</span><a id="line.29"></a>
<span class="sourceLineNo">030</span><a id="line.30"> /*</a>
<span class="sourceLineNo">031</span><a id="line.31"> * The character to look for that closes a permission definition.</a>
<span class="sourceLineNo">032</span><a id="line.32"> **/</a>
<span class="sourceLineNo">033</span><a id="line.33"> //private static final char ARRAY_CLOSE_CHAR = ']';</a>
<span class="sourceLineNo">034</span><a id="line.34"></a>
<span class="sourceLineNo">035</span><a id="line.35"> /**</a>
<span class="sourceLineNo">036</span><a id="line.36"> * Default no-argument constructor that ensures this interceptor looks for</a>
<span class="sourceLineNo">037</span><a id="line.37"> * {@link org.apache.shiro.authz.annotation.RequiresPermissions RequiresPermissions} annotations in a method declaration.</a>
<span class="sourceLineNo">038</span><a id="line.38"> */</a>
<span class="sourceLineNo">039</span><a id="line.39"> public PermissionAnnotationMethodInterceptor() {</a>
<span class="sourceLineNo">040</span><a id="line.40"> super( new PermissionAnnotationHandler() );</a>
<span class="sourceLineNo">041</span><a id="line.41"> }</a>
<span class="sourceLineNo">042</span><a id="line.42"></a>
<span class="sourceLineNo">043</span><a id="line.43"> /**</a>
<span class="sourceLineNo">044</span><a id="line.44"> * @param resolver</a>
<span class="sourceLineNo">045</span><a id="line.45"> * @since 1.1</a>
<span class="sourceLineNo">046</span><a id="line.46"> */</a>
<span class="sourceLineNo">047</span><a id="line.47"> public PermissionAnnotationMethodInterceptor(AnnotationResolver resolver) {</a>
<span class="sourceLineNo">048</span><a id="line.48"> super( new PermissionAnnotationHandler(), resolver);</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"> /*</a>
<span class="sourceLineNo">052</span><a id="line.52"> * Infers the permission from the specified name path in the annotation.</a>
<span class="sourceLineNo">053</span><a id="line.53"> * @param methodArgs the &lt;code&gt;MethodInvocation&lt;/code&gt; method arguments.</a>
<span class="sourceLineNo">054</span><a id="line.54"> * @param namePath the Annotation 'name' value, which is a string-based permission definition.</a>
<span class="sourceLineNo">055</span><a id="line.55"> * @return the String permission representation.</a>
<span class="sourceLineNo">056</span><a id="line.56"> * @throws Exception if there is an error infering the target.</a>
<span class="sourceLineNo">057</span><a id="line.57"> *</a>
<span class="sourceLineNo">058</span><a id="line.58"> protected String inferTargetFromPath(Object[] methodArgs, String namePath) throws Exception {</a>
<span class="sourceLineNo">059</span><a id="line.59"> int propertyStartIndex = -1;</a>
<span class="sourceLineNo">060</span><a id="line.60"></a>
<span class="sourceLineNo">061</span><a id="line.61"> char[] chars = namePath.toCharArray();</a>
<span class="sourceLineNo">062</span><a id="line.62"> StringBuilder buf = new StringBuilder();</a>
<span class="sourceLineNo">063</span><a id="line.63"> //init iteration at index 1 (instead of 0). This is because the first</a>
<span class="sourceLineNo">064</span><a id="line.64"> //character must be the ARRAY_OPEN_CHAR (eliminates unnecessary iteration)</a>
<span class="sourceLineNo">065</span><a id="line.65"> for (int i = 1; i &lt; chars.length; i++) {</a>
<span class="sourceLineNo">066</span><a id="line.66"> if (chars[i] == ARRAY_CLOSE_CHAR) {</a>
<span class="sourceLineNo">067</span><a id="line.67"> // skip the delimiting period after the ARRAY_CLOSE_CHAR. The resulting</a>
<span class="sourceLineNo">068</span><a id="line.68"> // index is the init of the property path that we'll use with</a>
<span class="sourceLineNo">069</span><a id="line.69"> // BeanUtils.getProperty:</a>
<span class="sourceLineNo">070</span><a id="line.70"> propertyStartIndex = i + 2;</a>
<span class="sourceLineNo">071</span><a id="line.71"> break;</a>
<span class="sourceLineNo">072</span><a id="line.72"> } else {</a>
<span class="sourceLineNo">073</span><a id="line.73"> buf.append(chars[i]);</a>
<span class="sourceLineNo">074</span><a id="line.74"> }</a>
<span class="sourceLineNo">075</span><a id="line.75"> }</a>
<span class="sourceLineNo">076</span><a id="line.76"></a>
<span class="sourceLineNo">077</span><a id="line.77"> Integer methodArgIndex = Integer.parseInt(buf.toString());</a>
<span class="sourceLineNo">078</span><a id="line.78"> String beanUtilsPath = new String(chars, propertyStartIndex,</a>
<span class="sourceLineNo">079</span><a id="line.79"> chars.length - propertyStartIndex);</a>
<span class="sourceLineNo">080</span><a id="line.80"> Object targetValue = PropertyUtils.getProperty(methodArgs[methodArgIndex], beanUtilsPath);</a>
<span class="sourceLineNo">081</span><a id="line.81"> return targetValue.toString();</a>
<span class="sourceLineNo">082</span><a id="line.82"> }</a>
<span class="sourceLineNo">083</span><a id="line.83"></a>
<span class="sourceLineNo">084</span><a id="line.84"> /*</a>
<span class="sourceLineNo">085</span><a id="line.85"> * Returns the &lt;code&gt;MethodInvocation&lt;/code&gt;'s arguments, or &lt;code&gt;null&lt;/code&gt; if there were none.</a>
<span class="sourceLineNo">086</span><a id="line.86"> * @param invocation the methodInvocation to inspect.</a>
<span class="sourceLineNo">087</span><a id="line.87"> * @return the method invocation's method arguments, or &lt;code&gt;null&lt;/code&gt; if there were none.</a>
<span class="sourceLineNo">088</span><a id="line.88"> *</a>
<span class="sourceLineNo">089</span><a id="line.89"> protected Object[] getMethodArguments(MethodInvocation invocation) {</a>
<span class="sourceLineNo">090</span><a id="line.90"> if (invocation != null) {</a>
<span class="sourceLineNo">091</span><a id="line.91"> return invocation.getArguments();</a>
<span class="sourceLineNo">092</span><a id="line.92"> } else {</a>
<span class="sourceLineNo">093</span><a id="line.93"> return null;</a>
<span class="sourceLineNo">094</span><a id="line.94"> }</a>
<span class="sourceLineNo">095</span><a id="line.95"> }</a>
<span class="sourceLineNo">096</span><a id="line.96"></a>
<span class="sourceLineNo">097</span><a id="line.97"> /*</a>
<span class="sourceLineNo">098</span><a id="line.98"> * Returns the annotation {@link RequiresPermissions#value value}, from which the Permission will be constructed.</a>
<span class="sourceLineNo">099</span><a id="line.99"> *</a>
<span class="sourceLineNo">100</span><a id="line.100"> * @param invocation the method being invoked.</a>
<span class="sourceLineNo">101</span><a id="line.101"> * @return the method annotation's &lt;code&gt;value&lt;/code&gt;, from which the Permission will be constructed.</a>
<span class="sourceLineNo">102</span><a id="line.102"> *</a>
<span class="sourceLineNo">103</span><a id="line.103"> protected String getAnnotationValue(MethodInvocation invocation) {</a>
<span class="sourceLineNo">104</span><a id="line.104"> RequiresPermissions prAnnotation = (RequiresPermissions) getAnnotation(invocation);</a>
<span class="sourceLineNo">105</span><a id="line.105"> return prAnnotation.value();</a>
<span class="sourceLineNo">106</span><a id="line.106"> } */</a>
<span class="sourceLineNo">107</span><a id="line.107">}</a>
</pre>
</div>
</main>
</body>
</html>