blob: f0b20e8c047813b8576bc8839a7a65680794f776 [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 java.lang.annotation.Annotation;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.shiro.aop.AnnotationHandler;<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> * An AnnotationHandler that executes authorization (access control) behavior based on directive(s) found in a<a name="line.27"></a>
<span class="sourceLineNo">028</span> * JSR-175 Annotation.<a name="line.28"></a>
<span class="sourceLineNo">029</span> *<a name="line.29"></a>
<span class="sourceLineNo">030</span> * @since 0.9.0<a name="line.30"></a>
<span class="sourceLineNo">031</span> */<a name="line.31"></a>
<span class="sourceLineNo">032</span>public abstract class AuthorizingAnnotationHandler extends AnnotationHandler {<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span> /**<a name="line.34"></a>
<span class="sourceLineNo">035</span> * Constructs an &lt;code&gt;AuthorizingAnnotationHandler&lt;/code&gt; who processes annotations of the<a name="line.35"></a>
<span class="sourceLineNo">036</span> * specified type. Immediately calls &lt;code&gt;super(annotationClass)&lt;/code&gt;.<a name="line.36"></a>
<span class="sourceLineNo">037</span> *<a name="line.37"></a>
<span class="sourceLineNo">038</span> * @param annotationClass the type of annotation this handler will process.<a name="line.38"></a>
<span class="sourceLineNo">039</span> */<a name="line.39"></a>
<span class="sourceLineNo">040</span> public AuthorizingAnnotationHandler(Class&lt;? extends Annotation&gt; annotationClass) {<a name="line.40"></a>
<span class="sourceLineNo">041</span> super(annotationClass);<a name="line.41"></a>
<span class="sourceLineNo">042</span> }<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> /**<a name="line.44"></a>
<span class="sourceLineNo">045</span> * Ensures the calling Subject is authorized to execute based on the directive(s) found in the given<a name="line.45"></a>
<span class="sourceLineNo">046</span> * annotation.<a name="line.46"></a>
<span class="sourceLineNo">047</span> * &lt;p/&gt;<a name="line.47"></a>
<span class="sourceLineNo">048</span> * As this is an AnnotationMethodInterceptor, the implementations of this method typically inspect the annotation<a name="line.48"></a>
<span class="sourceLineNo">049</span> * and perform a corresponding authorization check based.<a name="line.49"></a>
<span class="sourceLineNo">050</span> *<a name="line.50"></a>
<span class="sourceLineNo">051</span> * @param a the &lt;code&gt;Annotation&lt;/code&gt; to check for performing an authorization check.<a name="line.51"></a>
<span class="sourceLineNo">052</span> * @throws org.apache.shiro.authz.AuthorizationException if the class/instance/method is not allowed to proceed/execute.<a name="line.52"></a>
<span class="sourceLineNo">053</span> */<a name="line.53"></a>
<span class="sourceLineNo">054</span> public abstract void assertAuthorized(Annotation a) throws AuthorizationException;<a name="line.54"></a>
<span class="sourceLineNo">055</span>}<a name="line.55"></a>
</pre>
</div>
</body>
</html>