blob: 9130a87b2bc330b25352bd050cf8f301fad6c768 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en"><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../../jacoco-resources/report.gif" type="image/gif"/><title>RoleAnnotationHandler.java</title><link rel="stylesheet" href="../../jacoco-resources/prettify.css" type="text/css"/><script type="text/javascript" src="../../jacoco-resources/prettify.js"></script></head><body onload="window['PR_TAB_WIDTH']=4;prettyPrint()"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../../index.html" class="el_report">Apache Shiro :: Jar Bundle</a> &gt; <a href="../index.html" class="el_bundle">shiro-core</a> &gt; <a href="index.source.html" class="el_package">org.apache.shiro.authz.aop</a> &gt; <span class="el_source">RoleAnnotationHandler.java</span></div><h1>RoleAnnotationHandler.java</h1><pre class="source lang-java linenums">/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* &quot;License&quot;); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.shiro.authz.aop;
import org.apache.shiro.authz.AuthorizationException;
import org.apache.shiro.authz.annotation.Logical;
import org.apache.shiro.authz.annotation.RequiresRoles;
import java.lang.annotation.Annotation;
import java.util.Arrays;
/**
* Checks to see if a @{@link org.apache.shiro.authz.annotation.RequiresRoles RequiresRoles} annotation is declared, and if so, performs
* a role check to see if the calling &lt;code&gt;Subject&lt;/code&gt; is allowed to proceed.
*
* @since 0.9.0
*/
public class RoleAnnotationHandler extends AuthorizingAnnotationHandler {
/**
* Default no-argument constructor that ensures this handler looks for
* {@link org.apache.shiro.authz.annotation.RequiresRoles RequiresRoles} annotations.
*/
public RoleAnnotationHandler() {
<span class="fc" id="L41"> super(RequiresRoles.class);</span>
<span class="fc" id="L42"> }</span>
/**
* Ensures that the calling &lt;code&gt;Subject&lt;/code&gt; has the Annotation's specified roles, and if not, throws an
* &lt;code&gt;AuthorizingException&lt;/code&gt; indicating that access is denied.
*
* @param a the RequiresRoles annotation to use to check for one or more roles
* @throws org.apache.shiro.authz.AuthorizationException
* if the calling &lt;code&gt;Subject&lt;/code&gt; does not have the role(s) necessary to
* proceed.
*/
public void assertAuthorized(Annotation a) throws AuthorizationException {
<span class="pc bpc" id="L54" title="1 of 2 branches missed."> if (!(a instanceof RequiresRoles)) return;</span>
<span class="fc" id="L56"> RequiresRoles rrAnnotation = (RequiresRoles) a;</span>
<span class="fc" id="L57"> String[] roles = rrAnnotation.value();</span>
<span class="fc bfc" id="L59" title="All 2 branches covered."> if (roles.length == 1) {</span>
<span class="nc" id="L60"> getSubject().checkRole(roles[0]);</span>
<span class="nc" id="L61"> return;</span>
}
<span class="fc bfc" id="L63" title="All 2 branches covered."> if (Logical.AND.equals(rrAnnotation.logical())) {</span>
<span class="nc" id="L64"> getSubject().checkRoles(Arrays.asList(roles));</span>
<span class="nc" id="L65"> return;</span>
}
<span class="pc bpc" id="L67" title="1 of 2 branches missed."> if (Logical.OR.equals(rrAnnotation.logical())) {</span>
// Avoid processing exceptions unnecessarily - &quot;delay&quot; throwing the exception by calling hasRole first
<span class="fc" id="L69"> boolean hasAtLeastOneRole = false;</span>
<span class="fc bfc" id="L70" title="All 4 branches covered."> for (String role : roles) if (getSubject().hasRole(role)) hasAtLeastOneRole = true;</span>
// Cause the exception if none of the role match, note that the exception message will be a bit misleading
<span class="pc bpc" id="L72" title="1 of 2 branches missed."> if (!hasAtLeastOneRole) getSubject().checkRole(roles[0]);</span>
}
<span class="fc" id="L74"> }</span>
}
</pre><div class="footer"><span class="right">Created with <a href="http://www.eclemma.org/jacoco">JaCoCo</a> 0.7.7.201606060606</span></div></body></html>