blob: 9007a8052b4175de1dca326fa22fb47ced3a084d [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.AnnotationMethodInterceptor;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.shiro.aop.AnnotationResolver;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.shiro.aop.MethodInvocation;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.shiro.authz.AuthorizationException;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>/**<a name="line.27"></a>
<span class="sourceLineNo">028</span> * An &lt;tt&gt;AnnotationMethodInterceptor&lt;/tt&gt; that asserts the calling code is authorized to execute the method<a name="line.28"></a>
<span class="sourceLineNo">029</span> * before allowing the invocation to continue by inspecting code annotations to perform an access control check.<a name="line.29"></a>
<span class="sourceLineNo">030</span> *<a name="line.30"></a>
<span class="sourceLineNo">031</span> * @since 0.1<a name="line.31"></a>
<span class="sourceLineNo">032</span> */<a name="line.32"></a>
<span class="sourceLineNo">033</span>public abstract class AuthorizingAnnotationMethodInterceptor extends AnnotationMethodInterceptor<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> /**<a name="line.36"></a>
<span class="sourceLineNo">037</span> * Constructor that ensures the internal &lt;code&gt;handler&lt;/code&gt; is set which will be used to perform the<a name="line.37"></a>
<span class="sourceLineNo">038</span> * authorization assertion checks when a supported annotation is encountered.<a name="line.38"></a>
<span class="sourceLineNo">039</span> * @param handler the internal &lt;code&gt;handler&lt;/code&gt; used to perform authorization assertion checks when a <a name="line.39"></a>
<span class="sourceLineNo">040</span> * supported annotation is encountered.<a name="line.40"></a>
<span class="sourceLineNo">041</span> */<a name="line.41"></a>
<span class="sourceLineNo">042</span> public AuthorizingAnnotationMethodInterceptor( AuthorizingAnnotationHandler handler ) {<a name="line.42"></a>
<span class="sourceLineNo">043</span> super(handler);<a name="line.43"></a>
<span class="sourceLineNo">044</span> }<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> /**<a name="line.46"></a>
<span class="sourceLineNo">047</span> *<a name="line.47"></a>
<span class="sourceLineNo">048</span> * @param handler<a name="line.48"></a>
<span class="sourceLineNo">049</span> * @param resolver<a name="line.49"></a>
<span class="sourceLineNo">050</span> * @since 1.1<a name="line.50"></a>
<span class="sourceLineNo">051</span> */<a name="line.51"></a>
<span class="sourceLineNo">052</span> public AuthorizingAnnotationMethodInterceptor( AuthorizingAnnotationHandler handler,<a name="line.52"></a>
<span class="sourceLineNo">053</span> AnnotationResolver resolver) {<a name="line.53"></a>
<span class="sourceLineNo">054</span> super(handler, resolver);<a name="line.54"></a>
<span class="sourceLineNo">055</span> }<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span> /**<a name="line.57"></a>
<span class="sourceLineNo">058</span> * Ensures the &lt;code&gt;methodInvocation&lt;/code&gt; is allowed to execute first before proceeding by calling the<a name="line.58"></a>
<span class="sourceLineNo">059</span> * {@link #assertAuthorized(org.apache.shiro.aop.MethodInvocation) assertAuthorized} method first.<a name="line.59"></a>
<span class="sourceLineNo">060</span> *<a name="line.60"></a>
<span class="sourceLineNo">061</span> * @param methodInvocation the method invocation to check for authorization prior to allowing it to proceed/execute.<a name="line.61"></a>
<span class="sourceLineNo">062</span> * @return the return value from the method invocation (the value of {@link org.apache.shiro.aop.MethodInvocation#proceed() MethodInvocation.proceed()}).<a name="line.62"></a>
<span class="sourceLineNo">063</span> * @throws org.apache.shiro.authz.AuthorizationException if the &lt;code&gt;MethodInvocation&lt;/code&gt; is not allowed to proceed.<a name="line.63"></a>
<span class="sourceLineNo">064</span> * @throws Throwable if any other error occurs.<a name="line.64"></a>
<span class="sourceLineNo">065</span> */<a name="line.65"></a>
<span class="sourceLineNo">066</span> public Object invoke(MethodInvocation methodInvocation) throws Throwable {<a name="line.66"></a>
<span class="sourceLineNo">067</span> assertAuthorized(methodInvocation);<a name="line.67"></a>
<span class="sourceLineNo">068</span> return methodInvocation.proceed();<a name="line.68"></a>
<span class="sourceLineNo">069</span> }<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span> /**<a name="line.71"></a>
<span class="sourceLineNo">072</span> * Ensures the calling Subject is authorized to execute the specified &lt;code&gt;MethodInvocation&lt;/code&gt;.<a name="line.72"></a>
<span class="sourceLineNo">073</span> * &lt;p/&gt;<a name="line.73"></a>
<span class="sourceLineNo">074</span> * As this is an AnnotationMethodInterceptor, this implementation merely delegates to the internal<a name="line.74"></a>
<span class="sourceLineNo">075</span> * {@link AuthorizingAnnotationHandler AuthorizingAnnotationHandler} by first acquiring the annotation by<a name="line.75"></a>
<span class="sourceLineNo">076</span> * calling {@link #getAnnotation(MethodInvocation) getAnnotation(methodInvocation)} and then calls<a name="line.76"></a>
<span class="sourceLineNo">077</span> * {@link AuthorizingAnnotationHandler#assertAuthorized(java.lang.annotation.Annotation) handler.assertAuthorized(annotation)}.<a name="line.77"></a>
<span class="sourceLineNo">078</span> *<a name="line.78"></a>
<span class="sourceLineNo">079</span> * @param mi the &lt;code&gt;MethodInvocation&lt;/code&gt; to check to see if it is allowed to proceed/execute.<a name="line.79"></a>
<span class="sourceLineNo">080</span> * @throws AuthorizationException if the method invocation is not allowed to continue/execute.<a name="line.80"></a>
<span class="sourceLineNo">081</span> */<a name="line.81"></a>
<span class="sourceLineNo">082</span> public void assertAuthorized(MethodInvocation mi) throws AuthorizationException {<a name="line.82"></a>
<span class="sourceLineNo">083</span> try {<a name="line.83"></a>
<span class="sourceLineNo">084</span> ((AuthorizingAnnotationHandler)getHandler()).assertAuthorized(getAnnotation(mi));<a name="line.84"></a>
<span class="sourceLineNo">085</span> }<a name="line.85"></a>
<span class="sourceLineNo">086</span> catch(AuthorizationException ae) {<a name="line.86"></a>
<span class="sourceLineNo">087</span> // Annotation handler doesn't know why it was called, so add the information here if possible. <a name="line.87"></a>
<span class="sourceLineNo">088</span> // Don't wrap the exception here since we don't want to mask the specific exception, such as <a name="line.88"></a>
<span class="sourceLineNo">089</span> // UnauthenticatedException etc. <a name="line.89"></a>
<span class="sourceLineNo">090</span> if (ae.getCause() == null) ae.initCause(new AuthorizationException("Not authorized to invoke method: " + mi.getMethod()));<a name="line.90"></a>
<span class="sourceLineNo">091</span> throw ae;<a name="line.91"></a>
<span class="sourceLineNo">092</span> } <a name="line.92"></a>
<span class="sourceLineNo">093</span> }<a name="line.93"></a>
<span class="sourceLineNo">094</span>}<a name="line.94"></a>
</pre>
</div>
</body>
</html>