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