blob: e5fa486162f86bf9a299f4b788c616dc86fed196 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="fr">
<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 java.util.ArrayList;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Collection;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.shiro.aop.MethodInvocation;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.shiro.authz.AuthorizationException;<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;AnnotationsAuthorizingMethodInterceptor&lt;/tt&gt; is a MethodInterceptor that asserts a given method is authorized<a name="line.28"></a>
<span class="sourceLineNo">029</span> * to execute based on one or more configured &lt;tt&gt;AuthorizingAnnotationMethodInterceptor&lt;/tt&gt;s.<a name="line.29"></a>
<span class="sourceLineNo">030</span> *<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;p&gt;This allows multiple annotations on a method to be processed before the method<a name="line.31"></a>
<span class="sourceLineNo">032</span> * executes, and if any of the &lt;tt&gt;AuthorizingAnnotationMethodInterceptor&lt;/tt&gt;s indicate that the method should not be<a name="line.32"></a>
<span class="sourceLineNo">033</span> * executed, an &lt;tt&gt;AuthorizationException&lt;/tt&gt; will be thrown, otherwise the method will be invoked as expected.<a name="line.33"></a>
<span class="sourceLineNo">034</span> *<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &lt;p&gt;It is essentially a convenience mechanism to allow multiple annotations to be processed in a single method<a name="line.35"></a>
<span class="sourceLineNo">036</span> * interceptor.<a name="line.36"></a>
<span class="sourceLineNo">037</span> *<a name="line.37"></a>
<span class="sourceLineNo">038</span> * @since 0.2<a name="line.38"></a>
<span class="sourceLineNo">039</span> */<a name="line.39"></a>
<span class="sourceLineNo">040</span>public abstract class AnnotationsAuthorizingMethodInterceptor extends AuthorizingMethodInterceptor {<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> * The method interceptors to execute for the annotated method.<a name="line.43"></a>
<span class="sourceLineNo">044</span> */<a name="line.44"></a>
<span class="sourceLineNo">045</span> protected Collection&lt;AuthorizingAnnotationMethodInterceptor&gt; methodInterceptors;<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> * Default no-argument constructor that defaults the <a name="line.48"></a>
<span class="sourceLineNo">049</span> * {@link #methodInterceptors methodInterceptors} attribute to contain two interceptors by default - the<a name="line.49"></a>
<span class="sourceLineNo">050</span> * {@link RoleAnnotationMethodInterceptor RoleAnnotationMethodInterceptor} and the<a name="line.50"></a>
<span class="sourceLineNo">051</span> * {@link PermissionAnnotationMethodInterceptor PermissionAnnotationMethodInterceptor} to<a name="line.51"></a>
<span class="sourceLineNo">052</span> * support role and permission annotations.<a name="line.52"></a>
<span class="sourceLineNo">053</span> */<a name="line.53"></a>
<span class="sourceLineNo">054</span> public AnnotationsAuthorizingMethodInterceptor() {<a name="line.54"></a>
<span class="sourceLineNo">055</span> methodInterceptors = new ArrayList&lt;AuthorizingAnnotationMethodInterceptor&gt;(5);<a name="line.55"></a>
<span class="sourceLineNo">056</span> methodInterceptors.add(new RoleAnnotationMethodInterceptor());<a name="line.56"></a>
<span class="sourceLineNo">057</span> methodInterceptors.add(new PermissionAnnotationMethodInterceptor());<a name="line.57"></a>
<span class="sourceLineNo">058</span> methodInterceptors.add(new AuthenticatedAnnotationMethodInterceptor());<a name="line.58"></a>
<span class="sourceLineNo">059</span> methodInterceptors.add(new UserAnnotationMethodInterceptor());<a name="line.59"></a>
<span class="sourceLineNo">060</span> methodInterceptors.add(new GuestAnnotationMethodInterceptor());<a name="line.60"></a>
<span class="sourceLineNo">061</span> }<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> /**<a name="line.63"></a>
<span class="sourceLineNo">064</span> * Returns the method interceptors to execute for the annotated method.<a name="line.64"></a>
<span class="sourceLineNo">065</span> * &lt;p/&gt;<a name="line.65"></a>
<span class="sourceLineNo">066</span> * Unless overridden by the {@link #setMethodInterceptors(java.util.Collection)} method, the default collection<a name="line.66"></a>
<span class="sourceLineNo">067</span> * contains a<a name="line.67"></a>
<span class="sourceLineNo">068</span> * {@link RoleAnnotationMethodInterceptor RoleAnnotationMethodInterceptor} and a<a name="line.68"></a>
<span class="sourceLineNo">069</span> * {@link PermissionAnnotationMethodInterceptor PermissionAnnotationMethodInterceptor} to<a name="line.69"></a>
<span class="sourceLineNo">070</span> * support role and permission annotations automatically.<a name="line.70"></a>
<span class="sourceLineNo">071</span> * @return the method interceptors to execute for the annotated method.<a name="line.71"></a>
<span class="sourceLineNo">072</span> */<a name="line.72"></a>
<span class="sourceLineNo">073</span> public Collection&lt;AuthorizingAnnotationMethodInterceptor&gt; getMethodInterceptors() {<a name="line.73"></a>
<span class="sourceLineNo">074</span> return methodInterceptors;<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> /**<a name="line.77"></a>
<span class="sourceLineNo">078</span> * Sets the method interceptors to execute for the annotated method.<a name="line.78"></a>
<span class="sourceLineNo">079</span> * @param methodInterceptors the method interceptors to execute for the annotated method.<a name="line.79"></a>
<span class="sourceLineNo">080</span> * @see #getMethodInterceptors()<a name="line.80"></a>
<span class="sourceLineNo">081</span> */<a name="line.81"></a>
<span class="sourceLineNo">082</span> public void setMethodInterceptors(Collection&lt;AuthorizingAnnotationMethodInterceptor&gt; methodInterceptors) {<a name="line.82"></a>
<span class="sourceLineNo">083</span> this.methodInterceptors = methodInterceptors;<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span> /**<a name="line.86"></a>
<span class="sourceLineNo">087</span> * Iterates over the internal {@link #getMethodInterceptors() methodInterceptors} collection, and for each one,<a name="line.87"></a>
<span class="sourceLineNo">088</span> * ensures that if the interceptor<a name="line.88"></a>
<span class="sourceLineNo">089</span> * {@link AuthorizingAnnotationMethodInterceptor#supports(org.apache.shiro.aop.MethodInvocation) supports}<a name="line.89"></a>
<span class="sourceLineNo">090</span> * the invocation, that the interceptor<a name="line.90"></a>
<span class="sourceLineNo">091</span> * {@link AuthorizingAnnotationMethodInterceptor#assertAuthorized(org.apache.shiro.aop.MethodInvocation) asserts}<a name="line.91"></a>
<span class="sourceLineNo">092</span> * that the invocation is authorized to proceed.<a name="line.92"></a>
<span class="sourceLineNo">093</span> */<a name="line.93"></a>
<span class="sourceLineNo">094</span> protected void assertAuthorized(MethodInvocation methodInvocation) throws AuthorizationException {<a name="line.94"></a>
<span class="sourceLineNo">095</span> //default implementation just ensures no deny votes are cast:<a name="line.95"></a>
<span class="sourceLineNo">096</span> Collection&lt;AuthorizingAnnotationMethodInterceptor&gt; aamis = getMethodInterceptors();<a name="line.96"></a>
<span class="sourceLineNo">097</span> if (aamis != null &amp;&amp; !aamis.isEmpty()) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> for (AuthorizingAnnotationMethodInterceptor aami : aamis) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> if (aami.supports(methodInvocation)) {<a name="line.99"></a>
<span class="sourceLineNo">100</span> aami.assertAuthorized(methodInvocation);<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<a name="line.102"></a>
<span class="sourceLineNo">103</span> }<a name="line.103"></a>
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
<span class="sourceLineNo">105</span>}<a name="line.105"></a>
</pre>
</div>
</body>
</html>