blob: cc7785c125e5a0ead18fa983f6566e083646cbf2 [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.authz.AuthorizationException;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.authz.annotation.Logical;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.authz.annotation.RequiresRoles;</a>
<span class="sourceLineNo">024</span><a id="line.24"></a>
<span class="sourceLineNo">025</span><a id="line.25">import java.lang.annotation.Annotation;</a>
<span class="sourceLineNo">026</span><a id="line.26">import java.util.Arrays;</a>
<span class="sourceLineNo">027</span><a id="line.27"></a>
<span class="sourceLineNo">028</span><a id="line.28">/**</a>
<span class="sourceLineNo">029</span><a id="line.29"> * Checks to see if a @{@link org.apache.shiro.authz.annotation.RequiresRoles RequiresRoles} annotation is declared, and if so, performs</a>
<span class="sourceLineNo">030</span><a id="line.30"> * a role check to see if the calling &lt;code&gt;Subject&lt;/code&gt; is allowed to proceed.</a>
<span class="sourceLineNo">031</span><a id="line.31"> *</a>
<span class="sourceLineNo">032</span><a id="line.32"> * @since 0.9.0</a>
<span class="sourceLineNo">033</span><a id="line.33"> */</a>
<span class="sourceLineNo">034</span><a id="line.34">public class RoleAnnotationHandler extends AuthorizingAnnotationHandler {</a>
<span class="sourceLineNo">035</span><a id="line.35"></a>
<span class="sourceLineNo">036</span><a id="line.36"> /**</a>
<span class="sourceLineNo">037</span><a id="line.37"> * Default no-argument constructor that ensures this handler looks for</a>
<span class="sourceLineNo">038</span><a id="line.38"> * {@link org.apache.shiro.authz.annotation.RequiresRoles RequiresRoles} annotations.</a>
<span class="sourceLineNo">039</span><a id="line.39"> */</a>
<span class="sourceLineNo">040</span><a id="line.40"> public RoleAnnotationHandler() {</a>
<span class="sourceLineNo">041</span><a id="line.41"> super(RequiresRoles.class);</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"> /**</a>
<span class="sourceLineNo">045</span><a id="line.45"> * Ensures that the calling &lt;code&gt;Subject&lt;/code&gt; has the Annotation's specified roles, and if not, throws an</a>
<span class="sourceLineNo">046</span><a id="line.46"> * &lt;code&gt;AuthorizingException&lt;/code&gt; indicating that access is denied.</a>
<span class="sourceLineNo">047</span><a id="line.47"> *</a>
<span class="sourceLineNo">048</span><a id="line.48"> * @param a the RequiresRoles annotation to use to check for one or more roles</a>
<span class="sourceLineNo">049</span><a id="line.49"> * @throws org.apache.shiro.authz.AuthorizationException</a>
<span class="sourceLineNo">050</span><a id="line.50"> * if the calling &lt;code&gt;Subject&lt;/code&gt; does not have the role(s) necessary to</a>
<span class="sourceLineNo">051</span><a id="line.51"> * proceed.</a>
<span class="sourceLineNo">052</span><a id="line.52"> */</a>
<span class="sourceLineNo">053</span><a id="line.53"> public void assertAuthorized(Annotation a) throws AuthorizationException {</a>
<span class="sourceLineNo">054</span><a id="line.54"> if (!(a instanceof RequiresRoles)) return;</a>
<span class="sourceLineNo">055</span><a id="line.55"></a>
<span class="sourceLineNo">056</span><a id="line.56"> RequiresRoles rrAnnotation = (RequiresRoles) a;</a>
<span class="sourceLineNo">057</span><a id="line.57"> String[] roles = rrAnnotation.value();</a>
<span class="sourceLineNo">058</span><a id="line.58"></a>
<span class="sourceLineNo">059</span><a id="line.59"> if (roles.length == 1) {</a>
<span class="sourceLineNo">060</span><a id="line.60"> getSubject().checkRole(roles[0]);</a>
<span class="sourceLineNo">061</span><a id="line.61"> return;</a>
<span class="sourceLineNo">062</span><a id="line.62"> }</a>
<span class="sourceLineNo">063</span><a id="line.63"> if (Logical.AND.equals(rrAnnotation.logical())) {</a>
<span class="sourceLineNo">064</span><a id="line.64"> getSubject().checkRoles(Arrays.asList(roles));</a>
<span class="sourceLineNo">065</span><a id="line.65"> return;</a>
<span class="sourceLineNo">066</span><a id="line.66"> }</a>
<span class="sourceLineNo">067</span><a id="line.67"> if (Logical.OR.equals(rrAnnotation.logical())) {</a>
<span class="sourceLineNo">068</span><a id="line.68"> // Avoid processing exceptions unnecessarily - "delay" throwing the exception by calling hasRole first</a>
<span class="sourceLineNo">069</span><a id="line.69"> boolean hasAtLeastOneRole = false;</a>
<span class="sourceLineNo">070</span><a id="line.70"> for (String role : roles) if (getSubject().hasRole(role)) hasAtLeastOneRole = true;</a>
<span class="sourceLineNo">071</span><a id="line.71"> // Cause the exception if none of the role match, note that the exception message will be a bit misleading</a>
<span class="sourceLineNo">072</span><a id="line.72"> if (!hasAtLeastOneRole) getSubject().checkRole(roles[0]);</a>
<span class="sourceLineNo">073</span><a id="line.73"> }</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>
</pre>
</div>
</main>
</body>
</html>